init.js 5.83 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 spawn = require('react-dev-utils/crossSpawn');
21
22
const { defaultBrowsers } = require('react-dev-utils/browsersHelper');
const os = require('os');
23
24
25
26
27
28
29
30

module.exports = function(
  appPath,
  appName,
  verbose,
  originalDirectory,
  template
) {
31
32
  const ownPackageName = require(path.join(__dirname, '..', 'package.json'))
    .name;
33
34
35
  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
36

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

  // Setup the script rules
Dan Abramov's avatar
Dan Abramov committed
41
  appPackage.scripts = {
42
43
44
45
    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
46
  };
Christopher Chedeau's avatar
.    
Christopher Chedeau committed
47

48
  appPackage.browserslist = defaultBrowsers;
49

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

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

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

76
77
  // Rename gitignore after the fact to prevent npm from renaming it to .npmignore
  // See: https://github.com/npm/npm/issues/1862
78
79
80
81
82
83
84
85
86
87
88
89
90
91
  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;
        }
92
93
      }
    }
94
  );
95

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

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

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

123
124
125
126
  // 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) {
127
    console.log(`Installing react and react-dom using ${command}...`);
128
    console.log();
Ville Immonen's avatar
Ville Immonen committed
129

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

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

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

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

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

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