index.js 6.45 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
#!/usr/bin/env node

/**
 * 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.
 */

Christopher Chedeau's avatar
Christopher Chedeau committed
12
13
14
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//   /!\ DO NOT MODIFY THIS FILE /!\
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15
16
17
18
19
20
21
22
23
//
// create-react-app is installed globally on people's computers. This means
// that it is extremely difficult to have them upgrade the version and
// because there's only one global version installed, it is very prone to
// breaking changes.
//
// The only job of create-react-app is to init the repository and then
// forward all the commands to the local version of create-react-app.
//
Christopher Chedeau's avatar
Christopher Chedeau committed
24
// If you need to add a new command, please add it to the scripts/ folder.
25
26
//
// The only reason to modify this file is to add more warnings and
Christopher Chedeau's avatar
Christopher Chedeau committed
27
// troubleshooting information for the `create-react-app` command.
28
29
30
31
//
// Do not make breaking changes! We absolutely don't want to have to
// tell people to update their global version of create-react-app.
//
Christopher Chedeau's avatar
Christopher Chedeau committed
32
33
34
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//   /!\ DO NOT MODIFY THIS FILE /!\
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
36
37
38
39

'use strict';

var fs = require('fs');
var path = require('path');
40
var spawn = require('cross-spawn');
41
42
var chalk = require('chalk');
var semver = require('semver');
Christopher Chedeau's avatar
Christopher Chedeau committed
43
44
var argv = require('minimist')(process.argv.slice(2));

45
/**
Christopher Chedeau's avatar
Christopher Chedeau committed
46
47
 * Arguments:
 *   --version - to print current version
48
 *   --verbose - to print logs while init
Christopher Chedeau's avatar
Christopher Chedeau committed
49
50
51
 *   --scripts-version <alternative package>
 *     Example of valid values:
 *     - a specific npm version: "0.22.0-rc1"
52
 *     - a .tgz archive from any npm repo: "https://registry.npmjs.org/react-scripts/-/react-scripts-0.20.0.tgz"
53
 *     - a package prepared with `tasks/clean_pack.sh`: "/Users/home/vjeux/create-react-app/react-scripts-0.22.0.tgz"
54
55
56
 */
var commands = argv._;
if (commands.length === 0) {
Max Stoiber's avatar
Max Stoiber committed
57
58
59
60
  if (argv.version) {
    console.log('create-react-app version: ' + require('./package.json').version);
    process.exit();
  }
61
  console.error(
Kevin Lacker's avatar
Kevin Lacker committed
62
    'Usage: create-react-app <project-directory> [--verbose]'
63
64
65
66
67
68
69
  );
  process.exit(1);
}

createApp(commands[0], argv.verbose, argv['scripts-version']);

function createApp(name, verbose, version) {
70
  var root = path.resolve(name);
71
72
73
74
  var appName = path.basename(root);

  checkAppName(appName);

75
  if (!pathExistsSync(name)) {
76
    fs.mkdirSync(root);
Dennis Ushakov's avatar
Dennis Ushakov committed
77
  } else if (!isSafeToCreateProjectIn(root)) {
78
    console.log('The directory `' + name + '` contains file(s) that could conflict. Aborting.');
Christopher Chedeau's avatar
Christopher Chedeau committed
79
    process.exit(1);
80
81
82
  }

  console.log(
83
    'Creating a new React app in ' + root + '.'
84
  );
85
  console.log();
86
87
88

  var packageJson = {
    name: appName,
89
    version: '0.1.0',
90
91
    private: true,
  };
Christoph Pojer's avatar
Christoph Pojer committed
92
93
94
95
  fs.writeFileSync(
    path.join(root, 'package.json'),
    JSON.stringify(packageJson, null, 2)
  );
Kevin Lacker's avatar
Kevin Lacker committed
96
  var originalDirectory = process.cwd();
97
98
  process.chdir(root);

Dan Abramov's avatar
Dan Abramov committed
99
  console.log('Installing packages. This might take a couple minutes.');
Kevin Lacker's avatar
Kevin Lacker committed
100
  console.log('Installing react-scripts from npm...');
101
  console.log();
102

Kevin Lacker's avatar
Kevin Lacker committed
103
  run(root, appName, version, verbose, originalDirectory);
104
105
}

Kevin Lacker's avatar
Kevin Lacker committed
106
function run(root, appName, version, verbose, originalDirectory) {
107
108
109
  var args = [
    'install',
    verbose && '--verbose',
110
    '--save-dev',
111
112
113
114
115
116
117
118
119
120
    '--save-exact',
    getInstallPackage(version),
  ].filter(function(e) { return e; });
  var proc = spawn('npm', args, {stdio: 'inherit'});
  proc.on('close', function (code) {
    if (code !== 0) {
      console.error('`npm ' + args.join(' ') + '` failed');
      return;
    }

121
122
    checkNodeVersion();

123
124
125
    var scriptsPath = path.resolve(
      process.cwd(),
      'node_modules',
126
      'react-scripts',
127
      'scripts',
128
129
130
      'init.js'
    );
    var init = require(scriptsPath);
Kevin Lacker's avatar
Kevin Lacker committed
131
    init(root, appName, verbose, originalDirectory);
132
133
134
135
  });
}

function getInstallPackage(version) {
136
  var packageToInstall = 'react-scripts';
137
138
139
140
141
142
143
144
145
146
147
148
149
150
  var validSemver = semver.valid(version);
  if (validSemver) {
    packageToInstall += '@' + validSemver;
  } else if (version) {
    // for tar.gz or alternative paths
    packageToInstall = version;
  }
  return packageToInstall;
}

function checkNodeVersion() {
  var packageJsonPath = path.resolve(
    process.cwd(),
    'node_modules',
151
    'react-scripts',
152
153
154
155
156
157
    'package.json'
  );
  var packageJson = require(packageJsonPath);
  if (!packageJson.engines || !packageJson.engines.node) {
    return;
  }
Christopher Chedeau's avatar
Christopher Chedeau committed
158

159
160
161
  if (!semver.satisfies(process.version, packageJson.engines.node)) {
    console.error(
      chalk.red(
Christopher Chedeau's avatar
Christopher Chedeau committed
162
163
        'You are currently running Node %s but create-react-app requires %s.' +
        ' Please use a supported version of Node.\n'
164
165
166
167
      ),
      process.version,
      packageJson.engines.node
    );
168
    process.exit(1);
169
170
  }
}
171

172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
function checkAppName(appName) {
  // TODO: there should be a single place that holds the dependencies
  var dependencies = ['react', 'react-dom'];
  var devDependencies = ['react-scripts'];
  var allDependencies = dependencies.concat(devDependencies).sort();

  if (allDependencies.indexOf(appName) >= 0) {
    console.error(
      chalk.red(
        `Can't use "${appName}" as the app name because a dependency with the same name exists.\n\n` +
        `Following names ${chalk.red.bold('must not')} be used:\n\n`
      )

      +

      chalk.cyan(
        allDependencies.map(depName => `  ${depName}`).join('\n')
      )
    );
    process.exit(1);
  }
}

Dennis Ushakov's avatar
Dennis Ushakov committed
195
196
197
198
// If project only contains files generated by GH, it’s safe.
// We also special case IJ-based products .idea because it integrates with CRA:
// https://github.com/facebookincubator/create-react-app/pull/368#issuecomment-243446094
function isSafeToCreateProjectIn(root) {
199
  var validFiles = [
Dennis Ushakov's avatar
Dennis Ushakov committed
200
    '.DS_Store', 'Thumbs.db', '.git', '.gitignore', '.idea', 'README.md', 'LICENSE'
201
202
203
204
205
206
  ];
  return fs.readdirSync(root)
    .every(function(file) {
      return validFiles.indexOf(file) >= 0;
    });
}
207
208
209
210
211
212
213
214
215
216
217
218
219

// This is an ES5 version of https://github.com/sindresorhus/path-exists.
// The reason it exists is so that the CLI doesn't break before being able to
// warn the user they're using an unsupported version of Node.
// See https://github.com/facebookincubator/create-react-app/issues/570
function pathExistsSync(fp) {
  try {
    fs.accessSync(fp);
    return true;
  } catch (err) {
    return false;
  }
}