init.js 7.25 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
/**
 * Copyright (c) 2015-present, Facebook, Inc.
 *
Sophie Alpert's avatar
Sophie Alpert committed
5
6
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
Christopher Chedeau's avatar
Christopher Chedeau committed
7
 */
8
9
'use strict';

10
11
12
13
14
15
16
// 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;
});

17
18
19
const fs = require('fs-extra');
const path = require('path');
const chalk = require('chalk');
20
const execSync = require('child_process').execSync;
21
const spawn = require('react-dev-utils/crossSpawn');
22
23
const { defaultBrowsers } = require('react-dev-utils/browsersHelper');
const os = require('os');
24

Dan Abramov's avatar
Dan Abramov committed
25
function isInGitRepository() {
26
27
28
29
30
31
32
33
  try {
    execSync('git rev-parse --is-inside-work-tree', { stdio: 'ignore' });
    return true;
  } catch (e) {
    return false;
  }
}

Dan Abramov's avatar
Dan Abramov committed
34
function isInMercurialRepository() {
35
36
37
38
39
40
41
42
  try {
    execSync('hg --cwd . root', { stdio: 'ignore' });
    return true;
  } catch (e) {
    return false;
  }
}

Dan Abramov's avatar
Dan Abramov committed
43
44
function tryGitInit(appPath) {
  let didInit = false;
45
46
  try {
    execSync('git --version', { stdio: 'ignore' });
Dan Abramov's avatar
Dan Abramov committed
47
    if (isInGitRepository() || isInMercurialRepository()) {
48
49
50
51
      return false;
    }

    execSync('git init', { stdio: 'ignore' });
Dan Abramov's avatar
Dan Abramov committed
52
53
    didInit = true;

54
55
56
57
58
59
    execSync('git add -A', { stdio: 'ignore' });
    execSync('git commit -m "Initial commit from Create React App"', {
      stdio: 'ignore',
    });
    return true;
  } catch (e) {
Dan Abramov's avatar
Dan Abramov committed
60
61
62
63
64
65
66
67
68
69
70
71
72
    if (didInit) {
      // If we successfully initialized but couldn't commit,
      // maybe the commit author config is not set.
      // In the future, we might supply our own committer
      // like Ember CLI does, but for now, let's just
      // remove the Git files to avoid a half-done state.
      try {
        // unlinkSync() doesn't work on directories.
        fs.removeSync(path.join(appPath, '.git'));
      } catch (removeErr) {
        // Ignore.
      }
    }
73
74
75
76
    return false;
  }
}

77
78
79
80
81
82
83
module.exports = function(
  appPath,
  appName,
  verbose,
  originalDirectory,
  template
) {
Maël Nison's avatar
Maël Nison committed
84
85
86
  const ownPath = path.dirname(
    require.resolve(path.join(__dirname, '..', 'package.json'))
  );
87
88
  const appPackage = require(path.join(appPath, 'package.json'));
  const useYarn = fs.existsSync(path.join(appPath, 'yarn.lock'));
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
89

Dan Abramov's avatar
Dan Abramov committed
90
  // Copy over some of the devDependencies
91
  appPackage.dependencies = appPackage.dependencies || {};
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
92
93

  // Setup the script rules
Dan Abramov's avatar
Dan Abramov committed
94
  appPackage.scripts = {
95
96
    start: 'react-scripts start',
    build: 'react-scripts build',
97
    test: 'react-scripts test',
98
    eject: 'react-scripts eject',
Dan Abramov's avatar
Dan Abramov committed
99
  };
Joe Haddad's avatar
Joe Haddad committed
100

101
102
  // Setup the eslint config
  appPackage.eslintConfig = {
Joe Haddad's avatar
Joe Haddad committed
103
    extends: 'react-app',
104
  };
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
105

Joe Haddad's avatar
Joe Haddad committed
106
  // Setup the browsers list
107
  appPackage.browserslist = defaultBrowsers;
108

Dan Abramov's avatar
Dan Abramov committed
109
  fs.writeFileSync(
110
    path.join(appPath, 'package.json'),
111
    JSON.stringify(appPackage, null, 2) + os.EOL
Dan Abramov's avatar
Dan Abramov committed
112
  );
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
113

114
  const readmeExists = fs.existsSync(path.join(appPath, 'README.md'));
115
  if (readmeExists) {
116
117
118
119
    fs.renameSync(
      path.join(appPath, 'README.md'),
      path.join(appPath, 'README.old.md')
    );
120
121
  }

122
  // Copy the files for the user
123
124
125
  const templatePath = template
    ? path.resolve(originalDirectory, template)
    : path.join(ownPath, 'template');
126
127
128
  if (fs.existsSync(templatePath)) {
    fs.copySync(templatePath, appPath);
  } else {
129
130
131
    console.error(
      `Could not locate supplied template: ${chalk.green(templatePath)}`
    );
132
133
    return;
  }
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
134

135
136
  // Rename gitignore after the fact to prevent npm from renaming it to .npmignore
  // See: https://github.com/npm/npm/issues/1862
137
138
139
140
141
142
143
144
145
146
147
148
149
150
  try {
    fs.moveSync(
      path.join(appPath, 'gitignore'),
      path.join(appPath, '.gitignore'),
      []
    );
  } catch (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;
151
    }
152
  }
153

154
155
  let command;
  let args;
Ville Immonen's avatar
Ville Immonen committed
156
157

  if (useYarn) {
158
    command = 'yarnpkg';
Ville Immonen's avatar
Ville Immonen committed
159
160
161
    args = ['add'];
  } else {
    command = 'npm';
162
    args = ['install', '--save', verbose && '--verbose'].filter(e => e);
Ville Immonen's avatar
Ville Immonen committed
163
164
165
  }
  args.push('react', 'react-dom');

166
  // Install additional template dependencies, if present
167
168
169
170
  const templateDependenciesPath = path.join(
    appPath,
    '.template.dependencies.json'
  );
171
  if (fs.existsSync(templateDependenciesPath)) {
172
173
174
175
176
177
    const templateDependencies = require(templateDependenciesPath).dependencies;
    args = args.concat(
      Object.keys(templateDependencies).map(key => {
        return `${key}@${templateDependencies[key]}`;
      })
    );
178
179
180
    fs.unlinkSync(templateDependenciesPath);
  }

181
182
183
184
  // 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) {
185
    console.log(`Installing react and react-dom using ${command}...`);
186
    console.log();
Ville Immonen's avatar
Ville Immonen committed
187

188
    const proc = spawn.sync(command, args, { stdio: 'inherit' });
189
    if (proc.status !== 0) {
190
      console.error(`\`${command} ${args.join(' ')}\` failed`);
191
192
      return;
    }
193
  }
194

Dan Abramov's avatar
Dan Abramov committed
195
  if (tryGitInit(appPath)) {
196
197
    console.log();
    console.log('Initialized a git repository.');
198
199
  }

200
201
202
  // Display the most elegant way to cd.
  // This needs to handle an undefined originalDirectory for
  // backward compatibility with old global-cli's.
203
204
  let cdpath;
  if (originalDirectory && path.join(originalDirectory, appName) === appPath) {
205
206
207
208
    cdpath = appName;
  } else {
    cdpath = appPath;
  }
Kevin Lacker's avatar
Kevin Lacker committed
209

210
  // Change displayed command to yarn instead of yarnpkg
211
  const displayedCommand = useYarn ? 'yarn' : 'npm';
212

213
  console.log();
214
  console.log(`Success! Created ${appName} at ${appPath}`);
215
216
  console.log('Inside that directory, you can run several commands:');
  console.log();
217
  console.log(chalk.cyan(`  ${displayedCommand} start`));
218
219
  console.log('    Starts the development server.');
  console.log();
220
221
222
  console.log(
    chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}build`)
  );
223
224
  console.log('    Bundles the app into static files for production.');
  console.log();
225
  console.log(chalk.cyan(`  ${displayedCommand} test`));
226
227
  console.log('    Starts the test runner.');
  console.log();
228
229
230
  console.log(
    chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}eject`)
  );
231
232
233
234
235
236
  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!'
  );
237
238
239
240
  console.log();
  console.log('We suggest that you begin by typing:');
  console.log();
  console.log(chalk.cyan('  cd'), cdpath);
241
  console.log(`  ${chalk.cyan(`${displayedCommand} start`)}`);
242
  if (readmeExists) {
243
    console.log();
244
245
246
247
248
    console.log(
      chalk.yellow(
        'You had a `README.md` file, we renamed it to `README.old.md`'
      )
    );
249
250
251
  }
  console.log();
  console.log('Happy hacking!');
252
};
253
254

function isReactInstalled(appPackage) {
255
  const dependencies = appPackage.dependencies || {};
256

257
258
259
260
  return (
    typeof dependencies.react !== 'undefined' &&
    typeof dependencies['react-dom'] !== 'undefined'
  );
261
}