init.js 5.8 KB
Newer Older
Daniel Grant's avatar
Daniel Grant committed
1
// @remove-file-on-eject
Christopher Chedeau's avatar
Christopher Chedeau committed
2
3
4
5
6
7
8
9
/**
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */
10
11
'use strict';

12
13
14
15
16
17
18
// Makes the script crash on unhandled rejections instead of silently
// ignoring them. In the future, promise rejections that are not handled will
// terminate the Node.js process with a non-zero exit code.
process.on('unhandledRejection', err => {
  throw err;
});

19
20
21
const fs = require('fs-extra');
const path = require('path');
const chalk = require('chalk');
22
const spawn = require('react-dev-utils/crossSpawn');
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

module.exports = function(
  appPath,
  appName,
  verbose,
  originalDirectory,
  template
) {
  const ownPackageName = require(path.join(
    __dirname,
    '..',
    'package.json'
  )).name;
  const ownPath = path.join(appPath, 'node_modules', ownPackageName);
  const appPackage = require(path.join(appPath, 'package.json'));
  const useYarn = fs.existsSync(path.join(appPath, 'yarn.lock'));
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
39

Dan Abramov's avatar
Dan Abramov committed
40
  // Copy over some of the devDependencies
41
  appPackage.dependencies = appPackage.dependencies || {};
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
42
43

  // Setup the script rules
Dan Abramov's avatar
Dan Abramov committed
44
  appPackage.scripts = {
45
46
47
48
    start: 'react-scripts start',
    build: 'react-scripts build',
    test: 'react-scripts test --env=jsdom',
    eject: 'react-scripts eject',
Dan Abramov's avatar
Dan Abramov committed
49
  };
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
50

Dan Abramov's avatar
Dan Abramov committed
51
  fs.writeFileSync(
52
53
    path.join(appPath, 'package.json'),
    JSON.stringify(appPackage, null, 2)
Dan Abramov's avatar
Dan Abramov committed
54
  );
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
55

56
  const readmeExists = fs.existsSync(path.join(appPath, 'README.md'));
57
  if (readmeExists) {
58
59
60
61
    fs.renameSync(
      path.join(appPath, 'README.md'),
      path.join(appPath, 'README.old.md')
    );
62
63
  }

64
  // Copy the files for the user
65
66
67
  const templatePath = template
    ? path.resolve(originalDirectory, template)
    : path.join(ownPath, 'template');
68
69
70
  if (fs.existsSync(templatePath)) {
    fs.copySync(templatePath, appPath);
  } else {
71
72
73
    console.error(
      `Could not locate supplied template: ${chalk.green(templatePath)}`
    );
74
75
    return;
  }
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
76

77
78
  // Rename gitignore after the fact to prevent npm from renaming it to .npmignore
  // See: https://github.com/npm/npm/issues/1862
79
80
81
82
83
84
85
86
87
88
89
90
91
92
  fs.move(
    path.join(appPath, 'gitignore'),
    path.join(appPath, '.gitignore'),
    [],
    err => {
      if (err) {
        // Append if there's already a `.gitignore` file there
        if (err.code === 'EEXIST') {
          const data = fs.readFileSync(path.join(appPath, 'gitignore'));
          fs.appendFileSync(path.join(appPath, '.gitignore'), data);
          fs.unlinkSync(path.join(appPath, 'gitignore'));
        } else {
          throw err;
        }
93
94
      }
    }
95
  );
96

97
98
  let command;
  let args;
Ville Immonen's avatar
Ville Immonen committed
99
100

  if (useYarn) {
101
    command = 'yarnpkg';
Ville Immonen's avatar
Ville Immonen committed
102
103
104
    args = ['add'];
  } else {
    command = 'npm';
105
    args = ['install', '--save', verbose && '--verbose'].filter(e => e);
Ville Immonen's avatar
Ville Immonen committed
106
107
108
  }
  args.push('react', 'react-dom');

109
  // Install additional template dependencies, if present
110
111
112
113
  const templateDependenciesPath = path.join(
    appPath,
    '.template.dependencies.json'
  );
114
  if (fs.existsSync(templateDependenciesPath)) {
115
116
117
118
119
120
    const templateDependencies = require(templateDependenciesPath).dependencies;
    args = args.concat(
      Object.keys(templateDependencies).map(key => {
        return `${key}@${templateDependencies[key]}`;
      })
    );
121
122
123
    fs.unlinkSync(templateDependenciesPath);
  }

124
125
126
127
  // Install react and react-dom for backward compatibility with old CRA cli
  // which doesn't install react and react-dom along with react-scripts
  // or template is presetend (via --internal-testing-template)
  if (!isReactInstalled(appPackage) || template) {
128
    console.log(`Installing react and react-dom using ${command}...`);
129
    console.log();
Ville Immonen's avatar
Ville Immonen committed
130

131
    const proc = spawn.sync(command, args, { stdio: 'inherit' });
132
    if (proc.status !== 0) {
133
      console.error(`\`${command} ${args.join(' ')}\` failed`);
134
135
      return;
    }
136
  }
137

138
139
140
  // Display the most elegant way to cd.
  // This needs to handle an undefined originalDirectory for
  // backward compatibility with old global-cli's.
141
142
  let cdpath;
  if (originalDirectory && path.join(originalDirectory, appName) === appPath) {
143
144
145
146
    cdpath = appName;
  } else {
    cdpath = appPath;
  }
Kevin Lacker's avatar
Kevin Lacker committed
147

148
  // Change displayed command to yarn instead of yarnpkg
149
  const displayedCommand = useYarn ? 'yarn' : 'npm';
150

151
  console.log();
152
  console.log(`Success! Created ${appName} at ${appPath}`);
153
154
  console.log('Inside that directory, you can run several commands:');
  console.log();
155
  console.log(chalk.cyan(`  ${displayedCommand} start`));
156
157
  console.log('    Starts the development server.');
  console.log();
158
159
160
  console.log(
    chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}build`)
  );
161
162
  console.log('    Bundles the app into static files for production.');
  console.log();
163
  console.log(chalk.cyan(`  ${displayedCommand} test`));
164
165
  console.log('    Starts the test runner.');
  console.log();
166
167
168
  console.log(
    chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}eject`)
  );
169
170
171
172
173
174
  console.log(
    '    Removes this tool and copies build dependencies, configuration files'
  );
  console.log(
    '    and scripts into the app directory. If you do this, you can’t go back!'
  );
175
176
177
178
  console.log();
  console.log('We suggest that you begin by typing:');
  console.log();
  console.log(chalk.cyan('  cd'), cdpath);
179
  console.log(`  ${chalk.cyan(`${displayedCommand} start`)}`);
180
  if (readmeExists) {
181
    console.log();
182
183
184
185
186
    console.log(
      chalk.yellow(
        'You had a `README.md` file, we renamed it to `README.old.md`'
      )
    );
187
188
189
  }
  console.log();
  console.log('Happy hacking!');
190
};
191
192

function isReactInstalled(appPackage) {
193
  const dependencies = appPackage.dependencies || {};
194

195
196
  return typeof dependencies.react !== 'undefined' &&
    typeof dependencies['react-dom'] !== 'undefined';
197
}