@atlaspack/transformer-postcss 2.12.1-canary.3354

package/lib/loadConfig.js

@@ -0,0 +1,162 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.load = load;
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+  _path = function () {
+    return data;
+  };
+  return data;
+}
+function _diagnostic() {
+  const data = require("@atlaspack/diagnostic");
+  _diagnostic = function () {
+    return data;
+  };
+  return data;
+}
+function _nullthrows() {
+  const data = _interopRequireDefault(require("nullthrows"));
+  _nullthrows = function () {
+    return data;
+  };
+  return data;
+}
+function _clone() {
+  const data = _interopRequireDefault(require("clone"));
+  _clone = function () {
+    return data;
+  };
+  return data;
+}
+var _constants = require("./constants");
+var _loadPlugins = _interopRequireDefault(require("./loadPlugins"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+async function configHydrator(configFile, config, resolveFrom, options, logger) {
+  if (configFile == null) {
+    return;
+  }
+
+  // Load the custom config...
+  let modulesConfig;
+  let configFilePlugins = (0, _clone().default)(configFile.plugins);
+  if (configFilePlugins != null && typeof configFilePlugins === 'object' && configFilePlugins['postcss-modules'] != null) {
+    modulesConfig = configFilePlugins['postcss-modules'];
+    delete configFilePlugins['postcss-modules'];
+  }
+  if (!modulesConfig && configFile.modules) {
+    modulesConfig = {};
+  }
+  let plugins = await (0, _loadPlugins.default)(configFilePlugins, (0, _nullthrows().default)(resolveFrom), options);
+
+  // contents is either:
+  // from JSON:    { plugins: { 'postcss-foo': { ...opts } } }
+  // from JS (v8): { plugins: [ { postcssPlugin: 'postcss-foo', ...visitor callback functions } ]
+  // from JS (v7): { plugins: [ [Function: ...] ]
+  let pluginArray = Array.isArray(configFilePlugins) ? configFilePlugins : Object.keys(configFilePlugins);
+  for (let p of pluginArray) {
+    if (typeof p === 'string') {
+      config.addDevDependency({
+        specifier: p,
+        resolveFrom: (0, _nullthrows().default)(resolveFrom)
+      });
+    }
+  }
+  let redundantPlugins = pluginArray.filter(p => p === 'autoprefixer' || p === 'postcss-preset-env');
+  if (redundantPlugins.length > 0) {
+    let filename = _path().default.basename(resolveFrom);
+    let isPackageJson = filename === 'package.json';
+    let message;
+    let hints = [];
+    if (!isPackageJson && redundantPlugins.length === pluginArray.length) {
+      message = (0, _diagnostic().md)`Atlaspack includes CSS transpilation and vendor prefixing by default. PostCSS config __${filename}__ contains only redundant plugins. Deleting it may significantly improve build performance.`;
+      hints.push((0, _diagnostic().md)`Delete __${filename}__`);
+    } else {
+      message = (0, _diagnostic().md)`Atlaspack includes CSS transpilation and vendor prefixing by default. PostCSS config __${filename}__ contains the following redundant plugins: ${[...redundantPlugins].map(p => _diagnostic().md.underline(p))}. Removing these may improve build performance.`;
+      hints.push((0, _diagnostic().md)`Remove the above plugins from __${filename}__`);
+    }
+    let codeFrames;
+    if (_path().default.extname(filename) !== '.js') {
+      let contents = await options.inputFS.readFile(resolveFrom, 'utf8');
+      let prefix = isPackageJson ? '/postcss' : '';
+      codeFrames = [{
+        language: 'json',
+        filePath: resolveFrom,
+        code: contents,
+        codeHighlights: (0, _diagnostic().generateJSONCodeHighlights)(contents, redundantPlugins.map(plugin => ({
+          key: `${prefix}/plugins/${plugin}`,
+          type: 'key'
+        })))
+      }];
+    } else {
+      codeFrames = [{
+        filePath: resolveFrom,
+        codeHighlights: [{
+          start: {
+            line: 1,
+            column: 1
+          },
+          end: {
+            line: 1,
+            column: 1
+          }
+        }]
+      }];
+    }
+    logger.warn({
+      message,
+      hints,
+      documentationURL: 'https://parceljs.org/languages/css/#default-plugins',
+      codeFrames
+    });
+  }
+  return {
+    raw: configFile,
+    filePath: resolveFrom,
+    hydrated: {
+      plugins,
+      from: config.searchPath,
+      to: config.searchPath,
+      modules: modulesConfig
+    }
+  };
+}
+async function load({
+  config,
+  options,
+  logger
+}) {
+  if (!config.isSource) {
+    return;
+  }
+  let configFile = await config.getConfig(['.postcssrc', '.postcssrc.json', '.postcssrc.js', '.postcssrc.cjs', '.postcssrc.mjs', 'postcss.config.js', 'postcss.config.cjs', 'postcss.config.mjs'], {
+    packageKey: 'postcss'
+  });
+  let contents = null;
+  if (configFile) {
+    config.addDevDependency({
+      specifier: 'postcss',
+      resolveFrom: config.searchPath,
+      range: _constants.POSTCSS_RANGE
+    });
+    contents = configFile.contents;
+    let isDynamic = configFile && _path().default.extname(configFile.filePath).endsWith('js');
+    if (isDynamic) {
+      // We have to invalidate on startup in case the config is non-deterministic,
+      // e.g. using unknown environment variables, reading from the filesystem, etc.
+      logger.warn({
+        message: 'WARNING: Using a JavaScript PostCSS config file means losing out on caching features of Atlaspack. Use a .postcssrc(.json) file whenever possible.'
+      });
+    }
+    if (typeof contents !== 'object') {
+      throw new Error('PostCSS config should be an object.');
+    }
+    if (contents.plugins == null || typeof contents.plugins !== 'object' || Object.keys(contents.plugins).length === 0) {
+      throw new Error('PostCSS config must have plugins');
+    }
+  }
+  return configHydrator(contents, config, configFile === null || configFile === void 0 ? void 0 : configFile.filePath, options, logger);
+}

package/lib/loadPlugins.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = loadExternalPlugins;
+async function loadExternalPlugins(plugins, relative, options) {
+  if (Array.isArray(plugins)) {
+    return Promise.all(plugins.map(p => loadPlugin(p, relative, null, options.packageManager, options.shouldAutoInstall)).filter(Boolean));
+  } else if (typeof plugins === 'object') {
+    let mapPlugins = await Promise.all(Object.keys(plugins).map(p => loadPlugin(p, relative, plugins[p], options.packageManager, options.shouldAutoInstall)));
+    return mapPlugins.filter(Boolean);
+  } else {
+    return [];
+  }
+}
+async function loadPlugin(pluginArg, relative, options = {}, packageManager, shouldAutoInstall) {
+  if (typeof pluginArg !== 'string') {
+    return pluginArg;
+  }
+  let plugin = await packageManager.require(pluginArg, relative, {
+    shouldAutoInstall
+  });
+  plugin = plugin.default || plugin;
+  if (options != null && typeof options === 'object' && Object.keys(options).length > 0) {
+    plugin = plugin(options);
+  }
+  return plugin.default || plugin;
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@atlaspack/transformer-postcss",
+  "version": "2.12.1-canary.3354+7bb54d46a",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/atlassian-labs/atlaspack.git"
+  },
+  "main": "lib/PostCSSTransformer.js",
+  "source": "src/PostCSSTransformer.js",
+  "engines": {
+    "node": ">= 16.0.0",
+    "atlaspack": "2.12.1-canary.3354+7bb54d46a"
+  },
+  "dependencies": {
+    "@atlaspack/diagnostic": "2.12.1-canary.3354+7bb54d46a",
+    "@atlaspack/plugin": "2.12.1-canary.3354+7bb54d46a",
+    "@atlaspack/rust": "2.12.1-canary.3354+7bb54d46a",
+    "@atlaspack/utils": "2.12.1-canary.3354+7bb54d46a",
+    "clone": "^2.1.1",
+    "nullthrows": "^1.1.1",
+    "postcss-value-parser": "^4.2.0",
+    "semver": "^7.5.2"
+  },
+  "devDependencies": {
+    "postcss": "^8.4.5",
+    "postcss-modules": "^4.3.1"
+  },
+  "gitHead": "7bb54d46a00c5ba9cdbc2ee426dcbe82c8d79a3e"
+}

package/src/PostCSSTransformer.js

@@ -0,0 +1,342 @@
+// @flow
+
+import type {
+  FilePath,
+  Asset,
+  MutableAsset,
+  PluginOptions,
+} from '@atlaspack/types';
+
+import {hashString} from '@atlaspack/rust';
+import {glob} from '@atlaspack/utils';
+import {Transformer} from '@atlaspack/plugin';
+import nullthrows from 'nullthrows';
+import path from 'path';
+import semver from 'semver';
+import valueParser from 'postcss-value-parser';
+import typeof * as Postcss from 'postcss';
+
+import {load} from './loadConfig';
+import {POSTCSS_RANGE} from './constants';
+import {md, generateJSONCodeHighlights} from '@atlaspack/diagnostic';
+
+const COMPOSES_RE = /composes:.+from\s*("|').*("|')\s*;?/;
+const FROM_IMPORT_RE = /.+from\s*(?:"|')(.*)(?:"|')\s*;?/;
+const LEGACY_MODULE_RE = /@value|:export|(:global|:local|:import)(?!\s*\()/i;
+const MODULE_BY_NAME_RE = /\.module\./;
+
+export default (new Transformer({
+  loadConfig({config, options, logger}) {
+    return load({config, options, logger});
+  },
+
+  canReuseAST({ast}) {
+    return (
+      ast.type === 'postcss' && semver.satisfies(ast.version, POSTCSS_RANGE)
+    );
+  },
+
+  async parse({asset, config, options}) {
+    let isLegacy = await isLegacyCssModule(asset);
+    if (!config && !isLegacy) {
+      return;
+    }
+
+    const postcss = await loadPostcss(options, asset.filePath);
+
+    return {
+      type: 'postcss',
+      version: '8.2.1',
+      program: postcss
+        .parse(await asset.getCode(), {
+          from: asset.filePath,
+        })
+        .toJSON(),
+    };
+  },
+
+  async transform({asset, config, options, resolve, logger}) {
+    asset.type = 'css';
+    let isLegacy = await isLegacyCssModule(asset);
+    if (isLegacy && !config) {
+      config = {
+        raw: {},
+        filePath: '',
+        hydrated: {
+          plugins: [],
+          from: asset.filePath,
+          to: asset.filePath,
+          modules: {},
+        },
+      };
+
+      // TODO: warning?
+    }
+
+    if (!config) {
+      return [asset];
+    }
+
+    const postcss: Postcss = await loadPostcss(options, asset.filePath);
+    let ast = nullthrows(await asset.getAST());
+    let program = postcss.fromJSON(ast.program);
+
+    let plugins = [...config.hydrated.plugins];
+    let cssModules: ?{|[string]: string|} = null;
+    if (config.hydrated.modules) {
+      asset.meta.cssModulesCompiled = 'postcss';
+
+      let code = asset.isASTDirty() ? null : await asset.getCode();
+      if (
+        Object.keys(config.hydrated.modules).length === 0 &&
+        code &&
+        !isLegacy &&
+        !LEGACY_MODULE_RE.test(code)
+      ) {
+        let filename = path.basename(config.filePath);
+        let message;
+        let configKey;
+        let hint;
+        if (config.raw.modules) {
+          message = md`The "modules" option in __${filename}__ can be replaced with configuration for @atlaspack/transformer-css to improve build performance.`;
+          configKey = '/modules';
+          hint = md`Remove the "modules" option from __${filename}__`;
+        } else {
+          message = md`The "postcss-modules" plugin in __${filename}__ can be replaced with configuration for @atlaspack/transformer-css to improve build performance.`;
+          configKey = '/plugins/postcss-modules';
+          hint = md`Remove the "postcss-modules" plugin from __${filename}__`;
+        }
+        if (filename === 'package.json') {
+          configKey = `/postcss${configKey}`;
+        }
+
+        let hints = [
+          'Enable the "cssModules" option for "@atlaspack/transformer-css" in your package.json',
+        ];
+        if (plugins.length === 0) {
+          message += md` Since there are no other plugins, __${filename}__ can be deleted safely.`;
+          hints.push(md`Delete __${filename}__`);
+        } else {
+          hints.push(hint);
+        }
+
+        let codeFrames;
+        if (path.extname(filename) !== '.js') {
+          let contents = await asset.fs.readFile(config.filePath, 'utf8');
+          codeFrames = [
+            {
+              language: 'json',
+              filePath: config.filePath,
+              code: contents,
+              codeHighlights: generateJSONCodeHighlights(contents, [
+                {
+                  key: configKey,
+                  type: 'key',
+                },
+              ]),
+            },
+          ];
+        } else {
+          codeFrames = [
+            {
+              filePath: config.filePath,
+              codeHighlights: [
+                {
+                  start: {line: 1, column: 1},
+                  end: {line: 1, column: 1},
+                },
+              ],
+            },
+          ];
+        }
+
+        logger.warn({
+          message,
+          hints,
+          documentationURL:
+            'https://parceljs.org/languages/css/#enabling-css-modules-globally',
+          codeFrames,
+        });
+      }
+
+      // TODO: should this be resolved from the project root?
+      let postcssModules = await options.packageManager.require(
+        'postcss-modules',
+        asset.filePath,
+        {
+          range: '^4.3.0',
+          saveDev: true,
+          shouldAutoInstall: options.shouldAutoInstall,
+        },
+      );
+
+      plugins.push(
+        postcssModules({
+          getJSON: (filename, json) => (cssModules = json),
+          Loader: await createLoader(asset, resolve, options),
+          generateScopedName: (name, filename) =>
+            `${name}_${hashString(
+              path.relative(options.projectRoot, filename),
+            ).substr(0, 6)}`,
+          ...config.hydrated.modules,
+        }),
+      );
+
+      if (code == null || COMPOSES_RE.test(code)) {
+        program.walkDecls(decl => {
+          let [, importPath] = FROM_IMPORT_RE.exec(decl.value) || [];
+          if (decl.prop === 'composes' && importPath != null) {
+            let parsed = valueParser(decl.value);
+
+            parsed.walk(node => {
+              if (node.type === 'string') {
+                asset.addDependency({
+                  specifier: importPath,
+                  specifierType: 'url',
+                  loc: {
+                    filePath: asset.filePath,
+                    start: decl.source.start,
+                    end: {
+                      line: decl.source.start.line,
+                      column: decl.source.start.column + importPath.length,
+                    },
+                  },
+                });
+              }
+            });
+          }
+        });
+      }
+    }
+
+    // $FlowFixMe Added in Flow 0.121.0 upgrade in #4381
+    let {messages, root} = await postcss(plugins).process(
+      program,
+      config.hydrated,
+    );
+    asset.setAST({
+      type: 'postcss',
+      version: '8.2.1',
+      program: root.toJSON(),
+    });
+    for (let msg of messages) {
+      if (msg.type === 'dependency') {
+        asset.invalidateOnFileChange(msg.file);
+      } else if (msg.type === 'dir-dependency') {
+        let pattern = `${msg.dir}/${msg.glob ?? '**/*'}`;
+        let files = await glob(pattern, asset.fs, {onlyFiles: true});
+        for (let file of files) {
+          asset.invalidateOnFileChange(path.normalize(file));
+        }
+        asset.invalidateOnFileCreate({glob: pattern});
+      }
+    }
+
+    let assets = [asset];
+    if (cssModules) {
+      // $FlowFixMe
+      let cssModulesList = (Object.entries(cssModules): Array<
+        [string, string],
+      >);
+      let deps = asset.getDependencies().filter(dep => dep.priority === 'sync');
+      let code: string;
+      if (deps.length > 0) {
+        code = `
+          module.exports = Object.assign({}, ${deps
+            .map(dep => `require(${JSON.stringify(dep.specifier)})`)
+            .join(', ')}, ${JSON.stringify(cssModules, null, 2)});
+        `;
+      } else {
+        code = cssModulesList
+          .map(
+            // This syntax enables shaking the invidual statements, so that unused classes don't even exist in JS.
+            ([className, classNameHashed]) =>
+              `module.exports[${JSON.stringify(className)}] = ${JSON.stringify(
+                classNameHashed,
+              )};`,
+          )
+          .join('\n');
+      }
+
+      asset.symbols.ensure();
+      for (let [k, v] of cssModulesList) {
+        asset.symbols.set(k, v);
+      }
+      asset.symbols.set('default', 'default');
+
+      assets.push({
+        type: 'js',
+        content: code,
+      });
+    }
+    return assets;
+  },
+
+  async generate({asset, ast, options}) {
+    const postcss: Postcss = await loadPostcss(options, asset.filePath);
+
+    let code = '';
+    postcss.stringify(postcss.fromJSON(ast.program), c => {
+      code += c;
+    });
+
+    return {
+      content: code,
+    };
+  },
+}): Transformer);
+
+async function createLoader(
+  asset: MutableAsset,
+  resolve: (from: FilePath, to: string) => Promise<FilePath>,
+  options: PluginOptions,
+) {
+  let {default: FileSystemLoader} = await options.packageManager.require(
+    'postcss-modules/build/css-loader-core/loader',
+    asset.filePath,
+  );
+  return class AtlaspackFileSystemLoader extends FileSystemLoader {
+    async fetch(composesPath, relativeTo) {
+      let importPath = composesPath.replace(/^["']|["']$/g, '');
+      let resolved = await resolve(relativeTo, importPath);
+      let rootRelativePath = path.resolve(path.dirname(relativeTo), resolved);
+      let root = path.resolve('/');
+      // fixes an issue on windows which is part of the css-modules-loader-core
+      // see https://github.com/css-modules/css-modules-loader-core/issues/230
+      if (rootRelativePath.startsWith(root)) {
+        rootRelativePath = rootRelativePath.substr(root.length);
+      }
+
+      let source = await asset.fs.readFile(resolved, 'utf-8');
+      let {exportTokens} = await this.core.load(
+        source,
+        rootRelativePath,
+        undefined,
+        // $FlowFixMe[method-unbinding]
+        this.fetch.bind(this),
+      );
+      return exportTokens;
+    }
+
+    get finalSource() {
+      return '';
+    }
+  };
+}
+
+function loadPostcss(options: PluginOptions, from: FilePath): Promise<Postcss> {
+  return options.packageManager.require('postcss', from, {
+    range: POSTCSS_RANGE,
+    saveDev: true,
+    shouldAutoInstall: options.shouldAutoInstall,
+  });
+}
+
+async function isLegacyCssModule(asset: Asset | MutableAsset) {
+  if (!MODULE_BY_NAME_RE.test(asset.filePath)) {
+    return false;
+  }
+
+  let code = await asset.getCode();
+  return LEGACY_MODULE_RE.test(code);
+}

package/src/constants.js

@@ -0,0 +1,3 @@
+// @flow
+
+export const POSTCSS_RANGE = '^8.2.1';