init.js 7.29 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
) {
84
85
  const ownPackageName = require(path.join(__dirname, '..', 'package.json'))
    .name;
86
87
88
  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
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
97
98
    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
99
  };
100
101
102
103
104
  
  // Setup the eslint config
  appPackage.eslintConfig = {
    'extends': 'react-app'
  };
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
105

106
  appPackage.browserslist = defaultBrowsers;
107

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

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

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

134
135
  // Rename gitignore after the fact to prevent npm from renaming it to .npmignore
  // See: https://github.com/npm/npm/issues/1862
136
137
138
139
140
141
142
143
144
145
146
147
148
149
  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;
150
    }
151
  }
152

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

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

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

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

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

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

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

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

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

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

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