@parcel/transformer-posthtml 2.16.4 → 3.0.0-alpha.2

package/lib/PostHTMLTransformer.js

@@ -1,94 +1,110 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
+import { Transformer } from '@parcel/plugin';
+import posthtml from 'posthtml';
+import path from 'path';
+import fs from 'fs';
+import { createRequire } from 'module';
+const CONFIG_FILES = [
+    '.posthtmlrc',
+    '.posthtmlrc.json',
+    '.posthtmlrc.js',
+    '.posthtmlrc.cjs',
+    '.posthtmlrc.mjs',
+    'posthtml.config.js',
+    'posthtml.config.cjs',
+    'posthtml.config.mjs'
+];
+export default new Transformer({
+    async transform ({ asset, config, options }) {
+        // Config from .parcelrc takes precedence. Plugin names are resolved
+        // relative to the asset since the .parcelrc location isn't known here.
+        let resolveFrom = asset.filePath;
+        if (config == null) {
+            if (!asset.isSource) {
+                return;
+            }
+            let configFile = await findConfig(path.dirname(asset.filePath), options.projectRoot);
+            if (!configFile) {
+                return;
+            }
+            config = configFile.contents;
+            resolveFrom = configFile.filePath;
+        }
+        let plugins = await loadPlugins(config.plugins, resolveFrom);
+        let { render, ...rest } = config;
+        // posthtml's Options type is missing the parser options passed through to htmlparser2.
+        let processOptions = {
+            ...rest,
+            plugins,
+            xmlMode: asset.type === 'xhtml',
+            closingSingleTag: asset.type === 'xhtml' ? 'slash' : undefined
+        };
+        let res = await posthtml(plugins).process(asset.getCode(), processOptions);
+        asset.setCode(res.html);
+    }
 });
-exports.default = void 0;
-function _plugin() {
-  const data = require("@parcel/plugin");
-  _plugin = function () {
-    return data;
-  };
-  return data;
+async function findConfig(dir, projectRoot) {
+    for(;;){
+        for (let name of CONFIG_FILES){
+            let filePath = path.join(dir, name);
+            if (!exists(filePath)) {
+                continue;
+            }
+            return {
+                filePath,
+                contents: await loadConfigFile(filePath)
+            };
+        }
+        let pkgPath = path.join(dir, 'package.json');
+        if (exists(pkgPath)) {
+            let pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+            if (pkg.posthtml != null) {
+                return {
+                    filePath: pkgPath,
+                    contents: pkg.posthtml
+                };
+            }
+        }
+        let parent = path.dirname(dir);
+        if (dir === projectRoot || parent === dir) {
+            return null;
+        }
+        dir = parent;
+    }
 }
-function _path() {
-  const data = _interopRequireDefault(require("path"));
-  _path = function () {
-    return data;
-  };
-  return data;
+function exists(filePath) {
+    try {
+        return fs.statSync(filePath).isFile();
+    } catch  {
+        return false;
+    }
 }
-var _loadPlugins = _interopRequireDefault(require("./loadPlugins"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var _default = exports.default = new (_plugin().Transformer)({
-  async loadConfig({
-    config,
-    options,
-    logger
-  }) {
-    if (!config.isSource) {
-      return;
+async function loadConfigFile(filePath) {
+    let ext = path.extname(filePath);
+    if (ext === '.mjs') {
+        let mod = await import(filePath);
+        return mod.default;
     }
-    let configFile = await config.getConfig(['.posthtmlrc', '.posthtmlrc.js', '.posthtmlrc.cjs', '.posthtmlrc.mjs', 'posthtml.config.js', 'posthtml.config.cjs', 'posthtml.config.mjs'], {
-      packageKey: 'posthtml'
-    });
-    if (configFile) {
-      let isJavascript = _path().default.extname(configFile.filePath).endsWith('js');
-      if (isJavascript) {
-        // 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 PostHTML config file means losing out on caching features of Parcel. Use a .posthtmlrc (JSON) file whenever possible.'
-        });
-      }
-
-      // Load plugins. This must be done before adding dev dependencies so we auto install.
-      let plugins = await (0, _loadPlugins.default)(configFile.contents.plugins, config.searchPath, options);
-
-      // Now add dev dependencies so we invalidate when they change.
-      let pluginArray = Array.isArray(configFile.contents.plugins) ? configFile.contents.plugins : Object.keys(configFile.contents.plugins);
-      for (let p of pluginArray) {
-        if (typeof p === 'string') {
-          config.addDevDependency({
-            specifier: p,
-            resolveFrom: configFile.filePath
-          });
-        }
-      }
-      configFile.contents.plugins = plugins;
-      delete configFile.contents.render;
-      return configFile.contents;
+    if (ext === '.js' || ext === '.cjs') {
+        let mod = require(filePath);
+        return mod?.__esModule ? mod.default : mod;
     }
-  },
-  async transform({
-    asset,
-    config,
-    options
-  }) {
-    if (!config) {
-      return [asset];
+    return JSON.parse(fs.readFileSync(filePath, 'utf8'));
+}
+async function loadPlugins(plugins, resolveFrom) {
+    if (Array.isArray(plugins)) {
+        return Promise.all(plugins.map((p)=>loadPlugin(p, null, resolveFrom)));
     }
-    let posthtml = await options.packageManager.require('posthtml', asset.filePath, {
-      range: '^0.16.5'
-    });
-    let code = await asset.getCode();
-    let res = await posthtml(config.plugins).process(code, {
-      ...config,
-      plugins: config.plugins,
-      xmlMode: asset.type === 'xhtml',
-      closingSingleTag: asset.type === 'xhtml' ? 'slash' : undefined
-    });
-    if (res.messages) {
-      for (let {
-        type,
-        file: filePath
-      } of res.messages) {
-        if (type === 'dependency') {
-          asset.invalidateOnFileChange(filePath);
-        }
-      }
+    if (plugins != null && typeof plugins === 'object') {
+        return Promise.all(Object.keys(plugins).map((p)=>loadPlugin(p, plugins[p], resolveFrom)));
     }
-    asset.setCode(res.html);
-    return [asset];
-  }
-});
+    return [];
+}
+async function loadPlugin(plugin, pluginOptions, resolveFrom) {
+    if (typeof plugin !== 'string') {
+        return plugin;
+    }
+    // Plugins are Node packages, so resolve them with Node semantics from the config.
+    let mod = createRequire(resolveFrom)(plugin);
+    mod = mod.default || mod;
+    return mod(pluginOptions);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parcel/transformer-posthtml",
-  "version": "2.16.4",
+  "version": "3.0.0-alpha.2",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -13,15 +13,18 @@
     "type": "git",
     "url": "https://github.com/parcel-bundler/parcel.git"
   },
+  "type": "module",
   "main": "lib/PostHTMLTransformer.js",
-  "source": "src/PostHTMLTransformer.js",
+  "files": [
+    "lib"
+  ],
+  "source": "src/PostHTMLTransformer.ts",
   "engines": {
     "node": ">= 16.0.0",
-    "parcel": "^2.16.4"
+    "parcel": "^3.0.0-0"
   },
   "dependencies": {
-    "@parcel/plugin": "2.16.4",
-    "@parcel/utils": "2.16.4"
-  },
-  "gitHead": "59484858a1a0bcbb71f74088956bb437a2db6505"
-}
+    "@parcel/plugin": "^3.0.0-alpha.2",
+    "posthtml": "^0.16.5"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017-present Devon Govett
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/lib/loadPlugins.js

@@ -1,26 +0,0 @@
-"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;
-  return plugin(options);
-}

package/src/PostHTMLTransformer.js

@@ -1,100 +0,0 @@
-// @flow
-
-import {Transformer} from '@parcel/plugin';
-
-import path from 'path';
-import loadPlugins from './loadPlugins';
-
-export default (new Transformer({
-  async loadConfig({config, options, logger}) {
-    if (!config.isSource) {
-      return;
-    }
-
-    let configFile = await config.getConfig(
-      [
-        '.posthtmlrc',
-        '.posthtmlrc.js',
-        '.posthtmlrc.cjs',
-        '.posthtmlrc.mjs',
-        'posthtml.config.js',
-        'posthtml.config.cjs',
-        'posthtml.config.mjs',
-      ],
-      {
-        packageKey: 'posthtml',
-      },
-    );
-
-    if (configFile) {
-      let isJavascript = path.extname(configFile.filePath).endsWith('js');
-      if (isJavascript) {
-        // 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 PostHTML config file means losing out on caching features of Parcel. Use a .posthtmlrc (JSON) file whenever possible.',
-        });
-      }
-
-      // Load plugins. This must be done before adding dev dependencies so we auto install.
-      let plugins = await loadPlugins(
-        configFile.contents.plugins,
-        config.searchPath,
-        options,
-      );
-
-      // Now add dev dependencies so we invalidate when they change.
-      let pluginArray = Array.isArray(configFile.contents.plugins)
-        ? configFile.contents.plugins
-        : Object.keys(configFile.contents.plugins);
-      for (let p of pluginArray) {
-        if (typeof p === 'string') {
-          config.addDevDependency({
-            specifier: p,
-            resolveFrom: configFile.filePath,
-          });
-        }
-      }
-
-      configFile.contents.plugins = plugins;
-
-      delete configFile.contents.render;
-
-      return configFile.contents;
-    }
-  },
-
-  async transform({asset, config, options}) {
-    if (!config) {
-      return [asset];
-    }
-
-    let posthtml = await options.packageManager.require(
-      'posthtml',
-      asset.filePath,
-      {
-        range: '^0.16.5',
-      },
-    );
-
-    let code = await asset.getCode();
-    let res = await posthtml(config.plugins).process(code, {
-      ...config,
-      plugins: config.plugins,
-      xmlMode: asset.type === 'xhtml',
-      closingSingleTag: asset.type === 'xhtml' ? 'slash' : undefined,
-    });
-
-    if (res.messages) {
-      for (let {type, file: filePath} of res.messages) {
-        if (type === 'dependency') {
-          asset.invalidateOnFileChange(filePath);
-        }
-      }
-    }
-
-    asset.setCode(res.html);
-    return [asset];
-  },
-}): Transformer);

package/src/loadPlugins.js

@@ -1,62 +0,0 @@
-// @flow
-
-import type {FilePath, PluginOptions} from '@parcel/types';
-import type {PackageManager} from '@parcel/package-manager';
-
-export default async function loadExternalPlugins(
-  plugins: Array<string> | {+[pluginName: string]: mixed, ...},
-  relative: FilePath,
-  options: PluginOptions,
-): Promise<Array<mixed>> {
-  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 _plugins = plugins;
-    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: string | Function,
-  relative: FilePath,
-  options: mixed = {},
-  packageManager: PackageManager,
-  shouldAutoInstall: boolean,
-): mixed {
-  if (typeof pluginArg !== 'string') {
-    return pluginArg;
-  }
-
-  let plugin = await packageManager.require(pluginArg, relative, {
-    shouldAutoInstall,
-  });
-
-  plugin = plugin.default || plugin;
-
-  return plugin(options);
-}