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

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

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

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

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

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

94
95
  let command;
  let args;
Ville Immonen's avatar
Ville Immonen committed
96
97

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

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

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

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

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

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

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

function isReactInstalled(appPackage) {
190
  const dependencies = appPackage.dependencies || {};
191

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