@parcel/transformer-babel 2.0.0-nightly.92 → 2.0.1

package/lib/config.js

@@ -4,25 +4,61 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.load = load;
-exports.preSerialize = preSerialize;
-exports.postDeserialize = postDeserialize;
 
-var _nullthrows = _interopRequireDefault(require("nullthrows"));
+function _json() {
+  const data = _interopRequireDefault(require("json5"));
 
-var _path = _interopRequireDefault(require("path"));
+  _json = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+
+  _path = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function internalBabelCore() {
+  const data = _interopRequireWildcard(require("@babel/core"));
+
+  internalBabelCore = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _utils() {
+  const data = require("@parcel/utils");
+
+  _utils = function () {
+    return data;
+  };
+
+  return data;
+}
 
-var bundledBabelCore = _interopRequireWildcard(require("@babel/core"));
+function _diagnostic() {
+  const data = require("@parcel/diagnostic");
 
-var _utils = require("@parcel/utils");
+  _diagnostic = function () {
+    return data;
+  };
 
-var _env = _interopRequireDefault(require("./env"));
+  return data;
+}
 
 var _jsx = _interopRequireDefault(require("./jsx"));
 
 var _flow = _interopRequireDefault(require("./flow"));
 
-var _typescript = _interopRequireDefault(require("./typescript"));
-
 var _utils2 = require("./utils");
 
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
@@ -31,263 +67,333 @@ function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj;
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const TYPESCRIPT_EXTNAME_RE = /^\.tsx?/;
+const TYPESCRIPT_EXTNAME_RE = /\.tsx?$/;
 
-const BABEL_TRANSFORMER_DIR = _path.default.dirname(__dirname);
+const BABEL_TRANSFORMER_DIR = _path().default.dirname(__dirname);
 
-async function load(config, options, logger) {
-  if (config.result != null) {
-    return reload(config, options);
-  } // Don't look for a custom babel config if inside node_modules
+const JS_EXTNAME_RE = /^\.(js|cjs|mjs)$/;
+const BABEL_CONFIG_FILENAMES = ['.babelrc', '.babelrc.js', '.babelrc.json', '.babelrc.cjs', '.babelrc.mjs', '.babelignore', 'babel.config.js', 'babel.config.json', 'babel.config.mjs', 'babel.config.cjs'];
+const BABEL_CORE_RANGE = '^7.12.0';
 
+async function load(config, options, logger) {
+  var _ref, _ref2, _options$env$BABEL_EN;
 
+  // Don't transpile inside node_modules
   if (!config.isSource) {
-    return buildDefaultBabelConfig(config);
-  }
+    return;
+  } // Invalidate when any babel config file is added.
 
-  let babelCore = await loadBabelCore(config, options);
-  let partialConfig = babelCore.loadPartialConfig({
-    filename: config.searchPath,
-    cwd: _path.default.dirname(config.searchPath),
-    root: options.projectRoot
-  }); // loadPartialConfig returns null when the file should explicitly not be run through babel (ignore/exclude)
 
-  if (partialConfig == null) {} else if (partialConfig.hasFilesystemConfig()) {
-    config.setResult({
-      internal: false,
-      config: partialConfig.options,
-      targets: (0, _utils2.enginesToBabelTargets)(config.env)
+  for (let fileName of BABEL_CONFIG_FILENAMES) {
+    config.invalidateOnFileCreate({
+      fileName,
+      aboveFilePath: config.searchPath
     });
-    let {
-      babelrc: babelrcPath,
-      config: configPath
-    } = partialConfig;
-    let {
-      canBeRehydrated,
-      dependsOnRelative,
-      dependsOnLocal
-    } = getStats(partialConfig.options);
-    let configIsJS = typeof babelrcPath === 'string' && _path.default.extname(babelrcPath) === '.js' || typeof configPath === 'string' && _path.default.extname(configPath) === '.js';
-
-    if (configIsJS) {
-      logger.verbose({
-        message: 'WARNING: Using a JavaScript Babel config file means losing out on some caching features of Parcel. Try using a .babelrc file instead.'
+  } // Do nothing if we cannot resolve any babel config filenames. Checking using our own
+  // config resolution (which is cached) is much faster than relying on babel.
+
+
+  if (!(await (0, _utils().resolveConfig)(options.inputFS, config.searchPath, BABEL_CONFIG_FILENAMES, options.projectRoot))) {
+    return buildDefaultBabelConfig(options, config);
+  }
+
+  const babelCore = await options.packageManager.require('@babel/core', config.searchPath, {
+    range: BABEL_CORE_RANGE,
+    saveDev: true,
+    shouldAutoInstall: options.shouldAutoInstall
+  });
+  config.addDevDependency({
+    specifier: '@babel/core',
+    resolveFrom: config.searchPath,
+    range: BABEL_CORE_RANGE
+  });
+  config.invalidateOnEnvChange('BABEL_ENV');
+  config.invalidateOnEnvChange('NODE_ENV');
+  let babelOptions = {
+    filename: config.searchPath,
+    cwd: options.projectRoot,
+    envName: (_ref = (_ref2 = (_options$env$BABEL_EN = options.env.BABEL_ENV) !== null && _options$env$BABEL_EN !== void 0 ? _options$env$BABEL_EN : options.env.NODE_ENV) !== null && _ref2 !== void 0 ? _ref2 : options.mode === 'production' || options.mode === 'development' ? options.mode : null) !== null && _ref !== void 0 ? _ref : 'development',
+    showIgnoredFiles: true
+  };
+  let partialConfig = await babelCore.loadPartialConfigAsync(babelOptions);
+
+  let addIncludedFile = file => {
+    if (JS_EXTNAME_RE.test(_path().default.extname(file))) {
+      // We need to invalidate on startup in case the config is non-static,
+      // e.g. uses unknown environment variables, reads from the filesystem, etc.
+      logger.warn({
+        message: `It looks like you're using a JavaScript Babel config file. This means the config cannot be watched for changes, and Babel transformations cannot be cached. You'll need to restart Parcel for changes to this config to take effect. Try using a ${_path().default.basename(file, _path().default.extname(file)) + '.json'} file instead.`
+      });
+      config.invalidateOnStartup(); // But also add the config as a dev dependency so we can at least attempt invalidation in watch mode.
+
+      config.addDevDependency({
+        specifier: (0, _utils().relativePath)(options.projectRoot, file),
+        resolveFrom: _path().default.join(options.projectRoot, 'index'),
+        // Also invalidate @babel/core when the config or a dependency updates.
+        // This ensures that the caches in @babel/core are also invalidated.
+        additionalInvalidations: [{
+          specifier: '@babel/core',
+          resolveFrom: config.searchPath,
+          range: BABEL_CORE_RANGE
+        }]
       });
-      config.shouldInvalidateOnStartup(); // babel.config.js files get required by @babel/core so there's no use in setting resolved path for watch mode invalidation
     } else {
-      config.setResolvedPath(typeof babelrcPath === 'string' ? babelrcPath : configPath);
+      config.invalidateOnFileChange(file);
     }
+  };
 
-    if (babelrcPath && (await isExtended())) {
-      logger.verbose({
-        message: 'WARNING: You are using `extends` in your Babel config, which means you are losing out on some of the caching features of Parcel. Maybe try using a reusable preset instead.'
-      });
-      config.shouldInvalidateOnStartup();
-    }
+  let warnOldVersion = () => {
+    logger.warn({
+      message: 'You are using an old version of @babel/core which does not support the necessary features for Parcel to cache and watch babel config files safely. You may need to restart Parcel for config changes to take effect. Please upgrade to @babel/core 7.12.0 or later to resolve this issue.'
+    });
+    config.invalidateOnStartup();
+  }; // Old versions of @babel/core return null from loadPartialConfig when the file should explicitly not be run through babel (ignore/exclude)
 
-    if (dependsOnRelative || dependsOnLocal) {
-      logger.verbose({
-        message: 'WARNING: It looks like you are using local Babel plugins or presets. You will need to run with the `--no-cache` option in order to pick up changes to these until their containing package versions are bumped.'
-      });
-    }
 
-    if (canBeRehydrated) {
-      await definePluginDependencies(config);
-      config.setResultHash((0, _utils.md5FromObject)(partialConfig.options));
-    } else {
-      logger.verbose({
-        message: 'WARNING: You are using `require` to configure Babel plugins or presets. This means Babel transformations cannot be cached and will run on each build. Please use strings to configure Babel instead.'
-      });
-      config.setResultHash(JSON.stringify(Date.now()));
-      config.shouldInvalidateOnStartup();
-    }
-  } else {
-    await buildDefaultBabelConfig(config);
+  if (partialConfig == null) {
+    warnOldVersion();
+    return;
   }
-}
 
-async function buildDefaultBabelConfig(config) {
-  let babelOptions;
+  if (partialConfig.files == null) {
+    // If the files property is missing, we're on an old version of @babel/core.
+    // We need to invalidate on startup because we can't properly track dependencies.
+    if (partialConfig.hasFilesystemConfig()) {
+      warnOldVersion();
 
-  if (_path.default.extname(config.searchPath).match(TYPESCRIPT_EXTNAME_RE)) {
-    babelOptions = (0, _typescript.default)(config);
+      if (typeof partialConfig.babelrcPath === 'string') {
+        addIncludedFile(partialConfig.babelrcPath);
+      }
+
+      if (typeof partialConfig.configPath === 'string') {
+        addIncludedFile(partialConfig.configPath);
+      }
+    }
   } else {
-    babelOptions = (0, _flow.default)(config);
+    for (let file of partialConfig.files) {
+      addIncludedFile(file);
+    }
   }
 
-  let babelTargets;
-  let envOptions = await (0, _env.default)(config);
+  if (partialConfig.fileHandling != null && partialConfig.fileHandling !== 'transpile') {} else if (partialConfig.hasFilesystemConfig()) {
+    // Determine what syntax plugins we need to enable
+    let syntaxPlugins = [];
 
-  if (envOptions != null) {
-    babelTargets = envOptions.targets;
-    babelOptions = mergeOptions(babelOptions, {
-      presets: envOptions.presets
-    });
-  }
+    if (TYPESCRIPT_EXTNAME_RE.test(config.searchPath)) {
+      syntaxPlugins.push('typescript');
 
-  babelOptions = mergeOptions(babelOptions, (await (0, _jsx.default)(config)));
-
-  if (babelOptions != null) {
-    babelOptions.presets = (babelOptions.presets || []).map(preset => bundledBabelCore.createConfigItem(preset, {
-      type: 'preset',
-      dirname: BABEL_TRANSFORMER_DIR
-    }));
-    babelOptions.plugins = (babelOptions.plugins || []).map(plugin => bundledBabelCore.createConfigItem(plugin, {
-      type: 'plugin',
-      dirname: BABEL_TRANSFORMER_DIR
-    }));
-  }
+      if (config.searchPath.endsWith('.tsx')) {
+        syntaxPlugins.push('jsx');
+      }
+    } else if (await (0, _jsx.default)(options, config)) {
+      syntaxPlugins.push('jsx');
+    } // If the config has plugins loaded with require(), or inline plugins in the config,
+    // we can't cache the result of the compilation because we don't know where they came from.
 
-  config.setResult({
-    internal: true,
-    config: babelOptions,
-    targets: babelTargets
-  });
-  await definePluginDependencies(config);
-}
 
-function mergeOptions(result, config) {
-  if (!config || (!config.presets || config.presets.length === 0) && (!config.plugins || config.plugins.length === 0)) {
-    return result;
-  }
-
-  let merged = result;
+    if (hasRequire(partialConfig.options)) {
+      logger.warn({
+        message: 'It looks like you are using `require` to configure Babel plugins or presets. This means Babel transformations cannot be cached and will run on each build. Please use strings to configure Babel instead.'
+      });
+      config.setCacheKey(JSON.stringify(Date.now()));
+      config.invalidateOnStartup();
+    } else {
+      await warnOnRedundantPlugins(options.inputFS, partialConfig, logger);
+      definePluginDependencies(config, partialConfig.options, options);
+      config.setCacheKey((0, _utils().hashObject)(partialConfig.options));
+    }
 
-  if (merged) {
-    merged.presets = (merged.presets || []).concat(config.presets || []);
-    merged.plugins = (merged.plugins || []).concat(config.plugins || []);
+    return {
+      internal: false,
+      config: partialConfig.options,
+      targets: (0, _utils2.enginesToBabelTargets)(config.env),
+      syntaxPlugins
+    };
   } else {
-    result = config;
+    return buildDefaultBabelConfig(options, config);
   }
-
-  return result;
 }
 
-function getStats(options) {
-  let canBeRehydrated = true;
-  let dependsOnRelative = false;
-  let dependsOnLocal = false;
-  let configItems = [...options.presets, ...options.plugins];
+async function buildDefaultBabelConfig(options, config) {
+  // If this is a .ts or .tsx file, we don't need to enable flow.
+  if (TYPESCRIPT_EXTNAME_RE.test(config.searchPath)) {
+    return;
+  } // Detect flow. If not enabled, babel doesn't need to run at all.
 
-  for (let configItem of configItems) {
-    if (!configItem.file) {
-      canBeRehydrated = false;
-    } else if (configItem.file.request.startsWith('.')) {
-      dependsOnRelative = true;
-    } else if (isLocal()) {
-      dependsOnLocal = true;
-    }
+
+  let babelOptions = await (0, _flow.default)(config, options);
+
+  if (babelOptions == null) {
+    return;
+  } // When flow is enabled, we may also need to enable JSX so it parses properly.
+
+
+  let syntaxPlugins = [];
+
+  if (await (0, _jsx.default)(options, config)) {
+    syntaxPlugins.push('jsx');
   }
 
+  babelOptions.presets = (babelOptions.presets || []).map(preset => internalBabelCore().createConfigItem(preset, {
+    type: 'preset',
+    dirname: BABEL_TRANSFORMER_DIR
+  }));
+  babelOptions.plugins = (babelOptions.plugins || []).map(plugin => internalBabelCore().createConfigItem(plugin, {
+    type: 'plugin',
+    dirname: BABEL_TRANSFORMER_DIR
+  }));
+  definePluginDependencies(config, babelOptions, options);
   return {
-    canBeRehydrated,
-    dependsOnRelative,
-    dependsOnLocal
+    internal: true,
+    config: babelOptions,
+    syntaxPlugins
   };
 }
 
-function isExtended()
-/* babelrcPath */
-{
-  // TODO: read and parse babelrc and check to see if extends property exists
-  // need access to fs in case of memory filesystem
-  return false;
+function hasRequire(options) {
+  let configItems = [...options.presets, ...options.plugins];
+  return configItems.some(item => !item.file);
 }
 
-function isLocal()
-/* configItemPath */
-{
-  // TODO: check if realpath is different, need access to fs in case of memory filesystem
-  return false;
+function definePluginDependencies(config, babelConfig, options) {
+  if (babelConfig == null) {
+    return;
+  }
+
+  let configItems = [...(babelConfig.presets || []), ...(babelConfig.plugins || [])];
+
+  for (let configItem of configItems) {
+    // FIXME: this uses a relative path from the project root rather than resolving
+    // from the config location because configItem.file.request can be a shorthand
+    // rather than a full package name.
+    config.addDevDependency({
+      specifier: (0, _utils().relativePath)(options.projectRoot, configItem.file.resolved),
+      resolveFrom: _path().default.join(options.projectRoot, 'index'),
+      // Also invalidate @babel/core when the plugin or a dependency updates.
+      // This ensures that the caches in @babel/core are also invalidated.
+      additionalInvalidations: [{
+        specifier: '@babel/core',
+        resolveFrom: config.searchPath,
+        range: BABEL_CORE_RANGE
+      }]
+    });
+  }
 }
 
-function preSerialize(config) {
-  let babelConfig = config.result.config;
+const redundantPresets = new Set(['@babel/preset-env', '@babel/preset-react', '@babel/preset-typescript', '@parcel/babel-preset-env']);
+
+async function warnOnRedundantPlugins(fs, babelConfig, logger) {
+  var _babelConfig$config;
 
   if (babelConfig == null) {
     return;
-  } // ConfigItem.value is a function which the v8 serializer chokes on
-  // It is being ommited here and will be rehydrated later using the path provided by ConfigItem.file
-
-
-  babelConfig.presets = (babelConfig.presets || []).map(({
-    options,
-    dirname,
-    name,
-    file
-  }) => ({
-    options,
-    dirname,
-    name,
-    file
-  }));
-  babelConfig.plugins = (babelConfig.plugins || []).map(({
-    options,
-    dirname,
-    name,
-    file
-  }) => ({
-    options,
-    dirname,
-    name,
-    file
-  }));
-}
+  }
 
-async function definePluginDependencies(config) {
-  let babelConfig = config.result.config;
+  let configPath = (_babelConfig$config = babelConfig.config) !== null && _babelConfig$config !== void 0 ? _babelConfig$config : babelConfig.babelrc;
 
-  if (babelConfig == null) {
+  if (!configPath) {
     return;
   }
 
-  let configItems = [...babelConfig.presets, ...babelConfig.plugins];
-  await Promise.all(configItems.map(async configItem => {
-    let pkg = (0, _nullthrows.default)((await config.getConfigFrom(configItem.file.resolved, ['package.json'], {
-      parse: true
-    })));
-    config.addDevDependency(pkg.name, pkg.version);
-  }));
-}
+  let presets = babelConfig.options.presets || [];
+  let plugins = babelConfig.options.plugins || [];
+  let foundRedundantPresets = new Set();
+  let filteredPresets = presets.filter(preset => {
+    if (redundantPresets.has(preset.file.request)) {
+      foundRedundantPresets.add(preset.file.request);
+      return false;
+    }
+
+    return true;
+  });
+
+  let filePath = _path().default.relative(process.cwd(), configPath);
 
-async function postDeserialize(config, options) {
-  let babelCore = config.result.internal ? bundledBabelCore : await options.packageManager.require('@babel/core', config.searchPath);
-  config.result.config.presets = await Promise.all(config.result.config.presets.map(async configItem => {
-    let value = await options.packageManager.require(configItem.file.resolved, config.searchPath);
-    value = value.default ? value.default : value;
-    return babelCore.createConfigItem([value, configItem.options], {
-      type: 'preset',
-      dirname: configItem.dirname
+  let diagnostics = [];
+
+  if (filteredPresets.length === 0 && foundRedundantPresets.size > 0 && plugins.length === 0) {
+    diagnostics.push({
+      message: (0, _diagnostic().md)`Parcel includes transpilation by default. Babel config __${filePath}__ contains only redundant presets. Deleting it may significantly improve build performance.`,
+      codeFrames: [{
+        filePath: configPath,
+        codeHighlights: await getCodeHighlights(fs, configPath, foundRedundantPresets)
+      }],
+      hints: [(0, _diagnostic().md)`Delete __${filePath}__`],
+      documentationURL: 'https://parceljs.org/languages/javascript/#default-presets'
     });
-  }));
-  config.result.config.plugins = await Promise.all(config.result.config.plugins.map(async configItem => {
-    let value = await options.packageManager.require(configItem.file.resolved, config.searchPath);
-    value = value.default ? value.default : value;
-    return babelCore.createConfigItem([value, configItem.options], {
-      type: 'plugin',
-      dirname: configItem.dirname
+  } else if (foundRedundantPresets.size > 0) {
+    diagnostics.push({
+      message: (0, _diagnostic().md)`Parcel includes transpilation by default. Babel config __${filePath}__ includes the following redundant presets: ${[...foundRedundantPresets].map(p => _diagnostic().md.underline(p))}. Removing these may improve build performance.`,
+      codeFrames: [{
+        filePath: configPath,
+        codeHighlights: await getCodeHighlights(fs, configPath, foundRedundantPresets)
+      }],
+      hints: [(0, _diagnostic().md)`Remove the above presets from __${filePath}__`],
+      documentationURL: 'https://parceljs.org/languages/javascript/#default-presets'
     });
-  }));
-}
+  }
 
-async function reload(config, options) {
-  let {
-    loadPartialConfig
-  } = await loadBabelCore(config, options);
-  let partialConfig = loadPartialConfig({
-    filename: config.searchPath,
-    cwd: _path.default.dirname(config.searchPath),
-    root: options.projectRoot
-  });
-  config.setResult({
-    internal: false,
-    config: partialConfig.options,
-    targets: (0, _utils2.enginesToBabelTargets)(config.env)
-  });
+  if (foundRedundantPresets.has('@babel/preset-env')) {
+    var _babelConfig$config2, _babelConfig$config3;
+
+    diagnostics.push({
+      message: "@babel/preset-env does not support Parcel's targets, which will likely result in unnecessary transpilation and larger bundle sizes.",
+      codeFrames: [{
+        filePath: (_babelConfig$config2 = babelConfig.config) !== null && _babelConfig$config2 !== void 0 ? _babelConfig$config2 : babelConfig.babelrc,
+        codeHighlights: await getCodeHighlights(fs, (_babelConfig$config3 = babelConfig.config) !== null && _babelConfig$config3 !== void 0 ? _babelConfig$config3 : babelConfig.babelrc, new Set(['@babel/preset-env']))
+      }],
+      hints: [`Either remove __@babel/preset-env__ to use Parcel's builtin transpilation, or replace with __@parcel/babel-preset-env__`],
+      documentationURL: 'https://parceljs.org/languages/javascript/#custom-plugins'
+    });
+  }
+
+  if (diagnostics.length > 0) {
+    logger.warn(diagnostics);
+  }
 }
 
-function loadBabelCore(config, options) {
-  var _config$result;
+async function getCodeHighlights(fs, filePath, redundantPresets) {
+  let ext = _path().default.extname(filePath);
+
+  if (ext !== '.js' && ext !== '.cjs' && ext !== '.mjs') {
+    let contents = await fs.readFile(filePath, 'utf8');
+
+    let json = _json().default.parse(contents);
+
+    let presets = json.presets || [];
+    let pointers = [];
+
+    for (let i = 0; i < presets.length; i++) {
+      if (Array.isArray(presets[i]) && redundantPresets.has(presets[i][0])) {
+        pointers.push({
+          type: 'value',
+          key: `/presets/${i}/0`
+        });
+      } else if (redundantPresets.has(presets[i])) {
+        pointers.push({
+          type: 'value',
+          key: `/presets/${i}`
+        });
+      }
+    }
 
-  return !config.isSource || ((_config$result = config.result) === null || _config$result === void 0 ? void 0 : _config$result.internal) ? bundledBabelCore : options.packageManager.require('@babel/core', config.searchPath);
+    if (pointers.length > 0) {
+      try {
+        return (0, _diagnostic().generateJSONCodeHighlights)(contents, pointers);
+      } catch {// TODO: support code highlights for json5 sources.
+        // Babel supports json5 syntax, but json-source-map does not.
+      }
+    }
+  }
+
+  return [{
+    start: {
+      line: 1,
+      column: 1
+    },
+    end: {
+      line: 1,
+      column: 1
+    }
+  }];
 }

package/lib/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BABEL_RANGE = void 0;
+const BABEL_RANGE = '^7.0.0';
+exports.BABEL_RANGE = BABEL_RANGE;

package/lib/flow.js

@@ -8,9 +8,17 @@ exports.default = getFlowOptions;
 /**
  * Generates a babel config for stripping away Flow types.
  */
-function getFlowOptions(config) {
+async function getFlowOptions(config, options) {
   if (!config.isSource) {
     return null;
+  } // Only add flow plugin if `flow-bin` is listed as a dependency in the root package.json
+
+
+  let conf = await config.getConfigFrom(options.projectRoot + '/index', ['package.json']);
+  let pkg = conf === null || conf === void 0 ? void 0 : conf.contents;
+
+  if (!pkg || !(pkg.dependencies && pkg.dependencies['flow-bin']) && !(pkg.devDependencies && pkg.devDependencies['flow-bin'])) {
+    return null;
   }
 
   return {