tagging dev-only code (@remove-on-publish-begin/end) and pre-eject-on…

…ly code (@remove-on-eject-begin/end) #257
facebook · Aug 20, 2016 · ab49abe · ab49abe
1 parent b93e6c0
commit ab49abe
Show file tree

Hide file tree

Showing 23 changed files with 203 additions and 68 deletions.
diff --git a/config/babel.dev.js b/config/babel.dev.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 module.exports = {
   // Don't try to find .babelrc because we want to force this configuration.

diff --git a/config/babel.prod.js b/config/babel.prod.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 module.exports = {
   // Don't try to find .babelrc because we want to force this configuration.

diff --git a/config/env.js b/config/env.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 // Grab NODE_ENV and REACT_APP_* environment variables and prepare them to be
 // injected into the application via DefinePlugin in Webpack configuration.

diff --git a/config/eslint.js b/config/eslint.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 // Inspired by https://github.com/airbnb/javascript but less opinionated.
 

diff --git a/config/jest/CSSStub.js b/config/jest/CSSStub.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
  *
@@ -7,5 +8,6 @@
  *
  * @flow
  */
+// @remove-on-eject-end
 
 module.exports = {};
diff --git a/config/jest/FileStub.js b/config/jest/FileStub.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
  *
@@ -7,5 +8,6 @@
  *
  * @flow
  */
+// @remove-on-eject-end
 
 module.exports = "test-file-stub";
diff --git a/config/jest/transform.js b/config/jest/transform.js
@@ -1,10 +1,12 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2014-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.
  */
+// @remove-on-eject-end
 
 const babelDev = require('../babel.dev');
 const babelJest = require('babel-jest');

diff --git a/config/paths.js b/config/paths.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,60 +7,47 @@
  * 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.
  */
-
-// TODO: we can split this file into several files (pre-eject, post-eject, test)
-// and use those instead. This way we don't need to branch here.
+// @remove-on-eject-end
 
 var path = require('path');
 
-// True after ejecting, false when used as a dependency
-var isEjected = (
-  path.resolve(path.join(__dirname, '..')) ===
-  path.resolve(process.cwd())
-);
+function resolveApp(relativePath) {
+  return path.resolve(relativePath);
+}
 
-// Are we developing create-react-app locally?
-var isInCreateReactAppSource = (
-  process.argv.some(arg => arg.indexOf('--debug-template') > -1)
-);
+// config after eject: we're in ./config/
+module.exports = {
+  appBuild: resolveApp('build'),
+  appHtml: resolveApp('index.html'),
+  appPackageJson: resolveApp('package.json'),
+  appSrc: resolveApp('src'),
+  appNodeModules: resolveApp('node_modules'),
+  ownNodeModules: resolveApp('node_modules')
+};
 
+// @remove-on-eject-begin
 function resolveOwn(relativePath) {
   return path.resolve(__dirname, relativePath);
 }
+// config before eject: we're in ./node_modules/react-scripts/config/
+module.exports = {
+  appBuild: resolveApp('build'),
+  appHtml: resolveApp('index.html'),
+  appPackageJson: resolveApp('package.json'),
+  appSrc: resolveApp('src'),
+  appNodeModules: resolveApp('node_modules'),
+  // this is empty with npm3 but node resolution searches higher anyway:
+  ownNodeModules: resolveOwn('../node_modules')
+};
+// @remove-on-eject-end
 
-function resolveApp(relativePath) {
-  return path.resolve(relativePath);
-}
-
-if (isInCreateReactAppSource) {
-  // create-react-app development: we're in ./config/
-  module.exports = {
-    appBuild: resolveOwn('../build'),
-    appHtml: resolveOwn('../template/index.html'),
-    appPackageJson: resolveOwn('../package.json'),
-    appSrc: resolveOwn('../template/src'),
-    appNodeModules: resolveOwn('../node_modules'),
-    ownNodeModules: resolveOwn('../node_modules')
-  };
-} else if (!isEjected) {
-  // before eject: we're in ./node_modules/react-scripts/config/
-  module.exports = {
-    appBuild: resolveApp('build'),
-    appHtml: resolveApp('index.html'),
-    appPackageJson: resolveApp('package.json'),
-    appSrc: resolveApp('src'),
-    appNodeModules: resolveApp('node_modules'),
-    // this is empty with npm3 but node resolution searches higher anyway:
-    ownNodeModules: resolveOwn('../node_modules')
-  };
-} else {
-  // after eject: we're in ./config/
-  module.exports = {
-    appBuild: resolveApp('build'),
-    appHtml: resolveApp('index.html'),
-    appPackageJson: resolveApp('package.json'),
-    appSrc: resolveApp('src'),
-    appNodeModules: resolveApp('node_modules'),
-    ownNodeModules: resolveApp('node_modules')
-  };
-}
+// @remove-on-publish-begin
+module.exports = {
+  appBuild: resolveOwn('../build'),
+  appHtml: resolveOwn('../template/index.html'),
+  appPackageJson: resolveOwn('../package.json'),
+  appSrc: resolveOwn('../template/src'),
+  appNodeModules: resolveOwn('../node_modules'),
+  ownNodeModules: resolveOwn('../node_modules')
+};
+// @remove-on-publish-end
diff --git a/config/polyfills.js b/config/polyfills.js
@@ -1,3 +1,14 @@
+// @remove-on-eject-begin
+/**
+ * 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.
+ */
+// @remove-on-eject-end
+
 if (typeof Promise === 'undefined') {
   // Rejection tracking prevents a common issue where React gets into an
   // inconsistent state due to an error, but it gets swallowed by a Promise,

diff --git a/config/webpack.config.dev.js b/config/webpack.config.dev.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 var path = require('path');
 var autoprefixer = require('autoprefixer');

diff --git a/config/webpack.config.prod.js b/config/webpack.config.prod.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 var path = require('path');
 var autoprefixer = require('autoprefixer');

diff --git a/global-cli/index.js b/global-cli/index.js
@@ -51,7 +51,7 @@ var pathExists = require('path-exists');
  *     Example of valid values:
  *     - a specific npm version: "0.22.0-rc1"
  *     - a .tgz archive from any npm repo: "https://registry.npmjs.org/react-scripts/-/react-scripts-0.20.0.tgz"
- *     - a package prepared with `npm pack`: "/Users/home/vjeux/create-react-app/react-scripts-0.22.0.tgz"
+ *     - a package prepared with `tasks/clean_pack.sh`: "/Users/home/vjeux/create-react-app/react-scripts-0.22.0.tgz"
  */
 var commands = argv._;
 if (commands.length === 0) {

diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "build": "node scripts/build.js --debug-template",
-    "create-react-app": "node global-cli/index.js --scripts-version \"$PWD/`npm pack`\"",
+    "create-react-app": "node global-cli/index.js --scripts-version \"$PWD/`tasks/clean_pack.sh`\"",
     "e2e": "tasks/e2e.sh",
     "start": "node scripts/start.js --debug-template",
     "test": "node scripts/test.js --debug-template"

diff --git a/scripts/build.js b/scripts/build.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 // Do this as the first thing so that any code reading it knows the right env.
 process.env.NODE_ENV = 'production';

diff --git a/scripts/eject.js b/scripts/eject.js
@@ -74,10 +74,10 @@ prompt(
     console.log('Copying ' + file + ' to ' + appPath);
     var content = fs
       .readFileSync(path.join(ownPath, file), 'utf8')
-      // Remove license header from JS
-      .replace(/^\/\*\*(\*(?!\/)|[^*])*\*\//, '')
-      // Remove license header from AppleScript
-      .replace(/^--.*\n/gm, '')
+      // Remove dead code from .js files on eject
+      .replace(/\/\/ @remove-on-eject-begin([\s\S]*?)\/\/ @remove-on-eject-end/mg, '')
+      // Remove dead code from .applescript files on eject
+      .replace(/-- @remove-on-eject-begin([\s\S]*?)-- @remove-on-eject-end/mg, '')
       .trim() + '\n';
     fs.writeFileSync(path.join(appPath, file), content);
   });

diff --git a/scripts/start.js b/scripts/start.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 process.env.NODE_ENV = 'development';
 

diff --git a/scripts/utils/WatchMissingNodeModulesPlugin.js b/scripts/utils/WatchMissingNodeModulesPlugin.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 // This Webpack plugin ensures `npm install <library>` forces a project rebuild.
 // We’re not sure why this isn't Webpack's default behavior.

diff --git a/scripts/utils/chrome.applescript b/scripts/utils/chrome.applescript
@@ -1,9 +1,14 @@
--- Copyright (c) 2015-present, Facebook, Inc.
--- All rights reserved.
---
--- This source code is licensed under the BSD-style license found in the
+-- @remove-on-eject-begin
+(*
+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.
+of patent rights can be found in the PATENTS file in the same directory.
+*)
+-- @remove-on-eject-end
+
 on run argv
   set theURL to item 1 of argv
 

diff --git a/scripts/utils/createJestConfig.js b/scripts/utils/createJestConfig.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 module.exports = (resolve, rootDir) => {
   const config = {

diff --git a/scripts/utils/prompt.js b/scripts/utils/prompt.js
@@ -1,3 +1,4 @@
+// @remove-on-eject-begin
 /**
  * Copyright (c) 2015-present, Facebook, Inc.
  * All rights reserved.
@@ -6,6 +7,7 @@
  * 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.
  */
+// @remove-on-eject-end
 
 var rl = require('readline');