@parcel/transformer-babel 2.0.0-beta.2 → 2.0.0-nightly.1004

package/src/config.js

@@ -1,21 +1,21 @@
 // @flow
 
-import type {Config, PluginOptions} from '@parcel/types';
+import type {Config, PluginOptions, PluginLogger} from '@parcel/types';
+import typeof * as BabelCore from '@babel/core';
+import type {Diagnostic} from '@parcel/diagnostic';
 import type {BabelConfig} from './types';
-import type {PluginLogger} from '@parcel/logger';
 
+import json5 from 'json5';
 import path from 'path';
-import * as babelCore from '@babel/core';
-import {md5FromObject, relativePath} from '@parcel/utils';
+import {hashObject, relativePath, resolveConfig} from '@parcel/utils';
+import {md, generateJSONCodeHighlights} from '@parcel/diagnostic';
+import {BABEL_CORE_RANGE} from './constants';
 
-import getEnvOptions from './env';
-import getJSXOptions from './jsx';
+import isJSX from './jsx';
 import getFlowOptions from './flow';
-import getTypescriptOptions from './typescript';
 import {enginesToBabelTargets} from './utils';
 
-const TYPESCRIPT_EXTNAME_RE = /^\.tsx?/;
-const BABEL_TRANSFORMER_DIR = path.dirname(__dirname);
+const TYPESCRIPT_EXTNAME_RE = /\.tsx?$/;
 const JS_EXTNAME_RE = /^\.(js|cjs|mjs)$/;
 const BABEL_CONFIG_FILENAMES = [
   '.babelrc',
@@ -30,16 +30,61 @@ const BABEL_CONFIG_FILENAMES = [
   'babel.config.cjs',
 ];
 
+type BabelConfigResult = {|
+  internal: boolean,
+  config: BabelConfig,
+  targets?: mixed,
+  syntaxPlugins?: mixed,
+|};
+
 export async function load(
   config: Config,
   options: PluginOptions,
   logger: PluginLogger,
-): Promise<void> {
+): Promise<?BabelConfigResult> {
   // Don't transpile inside node_modules
   if (!config.isSource) {
     return;
   }
 
+  // Invalidate when any babel config file is added.
+  for (let fileName of BABEL_CONFIG_FILENAMES) {
+    config.invalidateOnFileCreate({
+      fileName,
+      aboveFilePath: config.searchPath,
+    });
+  }
+
+  // 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 resolveConfig(
+      options.inputFS,
+      config.searchPath,
+      BABEL_CONFIG_FILENAMES,
+      options.projectRoot,
+    ))
+  ) {
+    return buildDefaultBabelConfig(options, config);
+  }
+
+  const babelCore: 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,
@@ -57,36 +102,33 @@ export async function load(
     [string]: any,
   |} = await babelCore.loadPartialConfigAsync(babelOptions);
 
-  // Invalidate when any babel config file is added.
-  for (let fileName of BABEL_CONFIG_FILENAMES) {
-    config.invalidateOnFileCreate({
-      fileName,
-      aboveFilePath: config.searchPath,
-    });
-  }
-
   let addIncludedFile = file => {
     if (JS_EXTNAME_RE.test(path.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.basename(
-          file,
-          path.extname(file),
-        ) + '.json'} file instead.`,
+        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.basename(file, path.extname(file)) + '.json'
+        } file instead.`,
       });
-      config.shouldInvalidateOnStartup();
+      config.invalidateOnStartup();
 
       // But also add the config as a dev dependency so we can at least attempt invalidation in watch mode.
       config.addDevDependency({
-        moduleSpecifier: relativePath(options.projectRoot, file),
+        specifier: relativePath(options.projectRoot, file),
         resolveFrom: path.join(options.projectRoot, 'index'),
-        // Also invalidate @parcel/transformer-babel when the config or a dependency updates.
+        // Also invalidate @babel/core when the config or a dependency updates.
         // This ensures that the caches in @babel/core are also invalidated.
-        invalidateParcelPlugin: true,
+        additionalInvalidations: [
+          {
+            specifier: '@babel/core',
+            resolveFrom: config.searchPath,
+            range: BABEL_CORE_RANGE,
+          },
+        ],
       });
     } else {
-      config.addIncludedFile(file);
+      config.invalidateOnFileChange(file);
     }
   };
 
@@ -95,7 +137,7 @@ export async function load(
       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.shouldInvalidateOnStartup();
+    config.invalidateOnStartup();
   };
 
   // Old versions of @babel/core return null from loadPartialConfig when the file should explicitly not be run through babel (ignore/exclude)
@@ -130,11 +172,16 @@ export async function load(
   ) {
     return;
   } else if (partialConfig.hasFilesystemConfig()) {
-    config.setResult({
-      internal: false,
-      config: partialConfig.options,
-      targets: enginesToBabelTargets(config.env),
-    });
+    // Determine what syntax plugins we need to enable
+    let syntaxPlugins = [];
+    if (TYPESCRIPT_EXTNAME_RE.test(config.searchPath)) {
+      syntaxPlugins.push('typescript');
+      if (config.searchPath.endsWith('.tsx')) {
+        syntaxPlugins.push('jsx');
+      }
+    } else if (await isJSX(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.
@@ -144,81 +191,52 @@ export async function load(
           '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.setResultHash(JSON.stringify(Date.now()));
-      config.shouldInvalidateOnStartup();
+      config.setCacheKey(JSON.stringify(Date.now()));
+      config.invalidateOnStartup();
     } else {
-      definePluginDependencies(config, options);
-      config.setResultHash(md5FromObject(partialConfig.options));
+      await warnOnRedundantPlugins(options.inputFS, partialConfig, logger);
+      definePluginDependencies(config, partialConfig.options, options);
+      config.setCacheKey(hashObject(partialConfig.options));
     }
+
+    return {
+      internal: false,
+      config: partialConfig.options,
+      targets: enginesToBabelTargets(config.env),
+      syntaxPlugins,
+    };
   } else {
-    await buildDefaultBabelConfig(options, config);
+    return buildDefaultBabelConfig(options, config);
   }
 }
 
-async function buildDefaultBabelConfig(options: PluginOptions, config: Config) {
-  let jsxOptions = await getJSXOptions(options, config);
-
-  let babelOptions;
-  if (path.extname(config.searchPath).match(TYPESCRIPT_EXTNAME_RE)) {
-    babelOptions = getTypescriptOptions(
-      config,
-      jsxOptions?.pragma,
-      jsxOptions?.pragmaFrag,
-    );
-  } else {
-    babelOptions = await getFlowOptions(config, options);
-  }
-
-  let babelTargets;
-  let envOptions = await getEnvOptions(config);
-  if (envOptions != null) {
-    babelTargets = envOptions.targets;
-    babelOptions = mergeOptions(babelOptions, envOptions.config);
-  }
-  babelOptions = mergeOptions(babelOptions, jsxOptions?.config);
-
-  if (babelOptions != null) {
-    let _babelOptions = babelOptions; // For Flow
-    _babelOptions.presets = (_babelOptions.presets || []).map(preset =>
-      babelCore.createConfigItem(preset, {
-        type: 'preset',
-        dirname: BABEL_TRANSFORMER_DIR,
-      }),
-    );
-    _babelOptions.plugins = (_babelOptions.plugins || []).map(plugin =>
-      babelCore.createConfigItem(plugin, {
-        type: 'plugin',
-        dirname: BABEL_TRANSFORMER_DIR,
-      }),
-    );
-  }
-
-  config.setResult({
-    internal: true,
-    config: babelOptions,
-    targets: babelTargets,
-  });
-  definePluginDependencies(config, options);
-}
+async function buildDefaultBabelConfig(
+  options: PluginOptions,
+  config: Config,
+): Promise<?BabelConfigResult> {
+  // If this is a .ts or .tsx file, we don't need to enable flow.
+  if (TYPESCRIPT_EXTNAME_RE.test(config.searchPath)) {
+    return;
+  }
 
-function mergeOptions(result, config?: null | BabelConfig) {
-  if (
-    !config ||
-    ((!config.presets || config.presets.length === 0) &&
-      (!config.plugins || config.plugins.length === 0))
-  ) {
-    return result;
+  // Detect flow. If not enabled, babel doesn't need to run at all.
+  let babelOptions = await getFlowOptions(config, options);
+  if (babelOptions == null) {
+    return;
   }
 
-  let merged = result;
-  if (merged) {
-    merged.presets = (merged.presets || []).concat(config.presets || []);
-    merged.plugins = (merged.plugins || []).concat(config.plugins || []);
-  } else {
-    result = config;
+  // When flow is enabled, we may also need to enable JSX so it parses properly.
+  let syntaxPlugins = [];
+  if (await isJSX(options, config)) {
+    syntaxPlugins.push('jsx');
   }
 
-  return result;
+  definePluginDependencies(config, babelOptions, options);
+  return {
+    internal: true,
+    config: babelOptions,
+    syntaxPlugins,
+  };
 }
 
 function hasRequire(options) {
@@ -226,26 +244,175 @@ function hasRequire(options) {
   return configItems.some(item => !item.file);
 }
 
-function definePluginDependencies(config, options) {
-  let babelConfig = config.result.config;
+function definePluginDependencies(config, babelConfig: ?BabelConfig, options) {
   if (babelConfig == null) {
     return;
   }
 
-  let configItems = [...babelConfig.presets, ...babelConfig.plugins];
+  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({
-      moduleSpecifier: relativePath(
-        options.projectRoot,
-        configItem.file.resolved,
-      ),
+      specifier: relativePath(options.projectRoot, configItem.file.resolved),
       resolveFrom: path.join(options.projectRoot, 'index'),
-      // Also invalidate @parcel/transformer-babel when the plugin or a dependency updates.
+      // Also invalidate @babel/core when the plugin or a dependency updates.
       // This ensures that the caches in @babel/core are also invalidated.
-      invalidateParcelPlugin: true,
+      additionalInvalidations: [
+        {
+          specifier: '@babel/core',
+          resolveFrom: config.searchPath,
+          range: BABEL_CORE_RANGE,
+        },
+      ],
     });
   }
 }
+
+const redundantPresets = new Set([
+  '@babel/preset-env',
+  '@babel/preset-react',
+  '@babel/preset-typescript',
+  '@parcel/babel-preset-env',
+]);
+
+async function warnOnRedundantPlugins(fs, babelConfig, logger) {
+  if (babelConfig == null) {
+    return;
+  }
+
+  let configPath = babelConfig.config ?? babelConfig.babelrc;
+  if (!configPath) {
+    return;
+  }
+
+  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.relative(process.cwd(), configPath);
+  let diagnostics: Array<Diagnostic> = [];
+
+  if (
+    filteredPresets.length === 0 &&
+    foundRedundantPresets.size > 0 &&
+    plugins.length === 0
+  ) {
+    diagnostics.push({
+      message: 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: [md`Delete __${filePath}__`],
+      documentationURL:
+        'https://parceljs.org/languages/javascript/#default-presets',
+    });
+  } else if (foundRedundantPresets.size > 0) {
+    diagnostics.push({
+      message: md`Parcel includes transpilation by default. Babel config __${filePath}__ includes the following redundant presets: ${[
+        ...foundRedundantPresets,
+      ].map(p =>
+        md.underline(p),
+      )}. Removing these may improve build performance.`,
+      codeFrames: [
+        {
+          filePath: configPath,
+          codeHighlights: await getCodeHighlights(
+            fs,
+            configPath,
+            foundRedundantPresets,
+          ),
+        },
+      ],
+      hints: [md`Remove the above presets from __${filePath}__`],
+      documentationURL:
+        'https://parceljs.org/languages/javascript/#default-presets',
+    });
+  }
+
+  if (foundRedundantPresets.has('@babel/preset-env')) {
+    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.config ?? babelConfig.babelrc,
+          codeHighlights: await getCodeHighlights(
+            fs,
+            babelConfig.config ?? 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);
+  }
+}
+
+async function getCodeHighlights(fs, filePath, redundantPresets) {
+  let ext = path.extname(filePath);
+  if (ext !== '.js' && ext !== '.cjs' && ext !== '.mjs') {
+    let contents = await fs.readFile(filePath, 'utf8');
+    let json = json5.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}`});
+      }
+    }
+
+    if (pointers.length > 0) {
+      try {
+        return 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/src/constants.js

@@ -1,3 +1,3 @@
 // @flow strict-local
 
-export const BABEL_RANGE = '^7.0.0';
+export const BABEL_CORE_RANGE = '^7.12.0';

package/src/flow.js

@@ -1,7 +1,11 @@
 // @flow
 
-import type {Config, PluginOptions} from '@parcel/types';
+import type {Config, PluginOptions, PackageJSON} from '@parcel/types';
 import type {BabelConfig} from './types';
+import typeof * as BabelCore from '@babel/core';
+
+import {BABEL_CORE_RANGE} from './constants';
+import path from 'path';
 
 /**
  * Generates a babel config for stripping away Flow types.
@@ -15,9 +19,10 @@ export default async function getFlowOptions(
   }
 
   // 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 conf = await config.getConfigFrom<PackageJSON>(
+    options.projectRoot + '/index',
+    ['package.json'],
+  );
   let pkg = conf?.contents;
   if (
     !pkg ||
@@ -27,9 +32,35 @@ export default async function getFlowOptions(
     return null;
   }
 
+  const babelCore: BabelCore = await options.packageManager.require(
+    '@babel/core',
+    config.searchPath,
+    {
+      range: BABEL_CORE_RANGE,
+      saveDev: true,
+      shouldAutoInstall: options.shouldAutoInstall,
+    },
+  );
+
+  await options.packageManager.require(
+    '@babel/plugin-transform-flow-strip-types',
+    config.searchPath,
+    {
+      range: '^7.0.0',
+      saveDev: true,
+      shouldAutoInstall: options.shouldAutoInstall,
+    },
+  );
+
   return {
     plugins: [
-      ['@babel/plugin-transform-flow-strip-types', {requireDirective: true}],
+      babelCore.createConfigItem(
+        ['@babel/plugin-transform-flow-strip-types', {requireDirective: true}],
+        {
+          type: 'plugin',
+          dirname: path.dirname(config.searchPath),
+        },
+      ),
     ],
   };
 }

package/src/jsx.js

@@ -1,76 +1,40 @@
 // @flow strict-local
 
 import type {Config, PluginOptions} from '@parcel/types';
-import type {BabelConfig} from './types';
 
 import path from 'path';
 
-const JSX_EXTENSIONS = {
-  '.jsx': true,
-  '.tsx': true,
-};
-
-const JSX_PRAGMA = {
-  react: {
-    pragma: 'React.createElement',
-    pragmaFrag: 'React.Fragment',
-  },
-  preact: {
-    pragma: 'h',
-    pragmaFrag: 'Fragment',
-  },
-  nervjs: {
-    pragma: 'Nerv.createElement',
-    pragmaFrag: undefined,
-  },
-  hyperapp: {
-    pragma: 'h',
-    pragmaFrag: undefined,
-  },
-};
+const JSX_EXTENSIONS = new Set(['.jsx', '.tsx']);
+const JSX_LIBRARIES = ['react', 'preact', 'nervejs', 'hyperapp'];
 
 /**
- * Generates a babel config for JSX. Attempts to detect react or react-like libraries
- * and changes the pragma accordingly.
+ * Returns whether an asset is likely JSX. Attempts to detect react or react-like libraries
+ * along with
  */
-export default async function getJSXOptions(
+export default async function isJSX(
   options: PluginOptions,
   config: Config,
-): Promise<?{|config: BabelConfig, pragma: ?string, pragmaFrag: ?string|}> {
+): Promise<boolean> {
   if (!config.isSource) {
-    return null;
+    return false;
+  }
+
+  if (JSX_EXTENSIONS.has(path.extname(config.searchPath))) {
+    return true;
   }
 
   let pkg = await config.getPackage();
-  let reactLib;
   if (pkg?.alias && pkg.alias['react']) {
     // e.g.: `{ alias: { "react": "preact/compat" } }`
-    reactLib = 'react';
+    return true;
   } else {
-    // Find a dependency that we can map to a JSX pragma
-    reactLib = Object.keys(JSX_PRAGMA).find(
+    // Find a dependency that implies JSX syntax.
+    return JSX_LIBRARIES.some(
       libName =>
         pkg &&
         ((pkg.dependencies && pkg.dependencies[libName]) ||
-          (pkg.devDependencies && pkg.devDependencies[libName])),
+          (pkg.devDependencies && pkg.devDependencies[libName]) ||
+          (pkg.peerDependencies && pkg.peerDependencies[libName])),
     );
   }
-
-  let pragma = reactLib ? JSX_PRAGMA[reactLib].pragma : undefined;
-  let pragmaFrag = reactLib ? JSX_PRAGMA[reactLib].pragmaFrag : undefined;
-
-  if (pragma || JSX_EXTENSIONS[path.extname(config.searchPath)]) {
-    return {
-      config: {
-        presets: [
-          [
-            '@babel/preset-react',
-            {pragma, pragmaFrag, development: options.mode === 'development'},
-          ],
-        ],
-      },
-      pragma,
-      pragmaFrag,
-    };
-  }
 }