@parcel/transformer-posthtml 2.0.0-beta.1 → 2.0.0-nightly.1002

package/lib/PostHTMLTransformer.js

@@ -5,63 +5,147 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _plugin = require("@parcel/plugin");
+function _plugin() {
+  const data = require("@parcel/plugin");
 
-var _path = _interopRequireDefault(require("path"));
+  _plugin = function () {
+    return data;
+  };
 
-var _posthtml = _interopRequireDefault(require("posthtml"));
+  return data;
+}
 
-var _posthtmlParser = _interopRequireDefault(require("posthtml-parser"));
+function _path() {
+  const data = _interopRequireDefault(require("path"));
 
-var _posthtmlRender = _interopRequireDefault(require("posthtml-render"));
+  _path = function () {
+    return data;
+  };
 
-var _nullthrows = _interopRequireDefault(require("nullthrows"));
+  return data;
+}
 
-var _semver = _interopRequireDefault(require("semver"));
+function _posthtml() {
+  const data = _interopRequireDefault(require("posthtml"));
+
+  _posthtml = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _posthtmlParser() {
+  const data = require("posthtml-parser");
+
+  _posthtmlParser = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _posthtmlRender() {
+  const data = require("posthtml-render");
+
+  _posthtmlRender = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _nullthrows() {
+  const data = _interopRequireDefault(require("nullthrows"));
+
+  _nullthrows = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _semver() {
+  const data = _interopRequireDefault(require("semver"));
+
+  _semver = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _utils() {
+  const data = require("@parcel/utils");
+
+  _utils = function () {
+    return data;
+  };
+
+  return data;
+}
 
 var _loadPlugins = _interopRequireDefault(require("./loadPlugins"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-var _default = new _plugin.Transformer({
+var _default = new (_plugin().Transformer)({
   async loadConfig({
-    config
+    config,
+    options,
+    logger
   }) {
+    if (!config.isSource) {
+      return;
+    }
+
     let configFile = await config.getConfig(['.posthtmlrc', '.posthtmlrc.js', 'posthtml.config.js'], {
       packageKey: 'posthtml'
     });
 
     if (configFile) {
-      let isJavascript = _path.default.extname(configFile.filePath) === '.js';
+      let isJavascript = _path().default.extname(configFile.filePath) === '.js';
 
       if (isJavascript) {
-        config.shouldInvalidateOnStartup();
-        config.shouldReload();
-      } // tells posthtml that we have already called parse
+        // 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.'
+        });
+        config.invalidateOnStartup(); // Also add the config as a dev dependency so we attempt to reload in watch mode.
 
+        config.addDevDependency({
+          specifier: (0, _utils().relativePath)(_path().default.dirname(config.searchPath), configFile.filePath),
+          resolveFrom: config.searchPath
+        });
+      } // Load plugins. This must be done before adding dev dependencies so we auto install.
 
-      configFile.contents.skipParse = true;
-      config.setResult({
-        contents: configFile.contents,
-        isSerialisable: !isJavascript
-      });
-    }
-  },
 
-  preSerializeConfig({
-    config
-  }) {
-    if (!config.result) return; // Ensure we dont try to serialise functions
+      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; // tells posthtml that we have already called parse
 
-    if (!config.result.isSerialisable) {
-      config.result.contents = {};
+      configFile.contents.skipParse = true;
+      delete configFile.contents.render;
+      return configFile.contents;
     }
   },
 
   canReuseAST({
     ast
   }) {
-    return ast.type === 'posthtml' && _semver.default.satisfies(ast.version, '^0.4.0');
+    return ast.type === 'posthtml' && _semver().default.satisfies(ast.version, '^0.4.0');
   },
 
   async parse({
@@ -76,26 +160,25 @@ var _default = new _plugin.Transformer({
     return {
       type: 'posthtml',
       version: '0.4.1',
-      program: (0, _posthtmlParser.default)((await asset.getCode()), {
-        lowerCaseAttributeNames: true
+      program: (0, _posthtmlParser().parser)(await asset.getCode(), {
+        lowerCaseAttributeNames: true,
+        sourceLocations: true,
+        xmlMode: asset.type === 'xhtml'
       })
     };
   },
 
   async transform({
     asset,
-    config,
-    options
+    config
   }) {
     if (!config) {
       return [asset];
-    } // load plugins
-
+    }
 
-    const plugins = await (0, _loadPlugins.default)(config.contents.plugins, asset.filePath, options);
-    let ast = (0, _nullthrows.default)((await asset.getAST()));
-    let res = await (0, _posthtml.default)(plugins).process(ast.program, { ...config.contents,
-      plugins
+    let ast = (0, _nullthrows().default)(await asset.getAST());
+    let res = await (0, _posthtml().default)(config.plugins).process(ast.program, { ...config,
+      plugins: config.plugins
     });
 
     if (res.messages) {
@@ -104,9 +187,7 @@ var _default = new _plugin.Transformer({
         file: filePath
       }) => {
         if (type === 'dependency') {
-          return asset.addIncludedFile({
-            filePath
-          });
+          return asset.invalidateOnFileChange(filePath);
         }
 
         return Promise.resolve();
@@ -123,10 +204,13 @@ var _default = new _plugin.Transformer({
   },
 
   generate({
-    ast
+    ast,
+    asset
   }) {
     return {
-      content: (0, _posthtmlRender.default)(ast.program)
+      content: (0, _posthtmlRender().render)(ast.program, {
+        closingSingleTag: asset.type === 'xhtml' ? 'slash' : undefined
+      })
     };
   }
 

package/lib/loadPlugins.js

@@ -7,28 +7,23 @@ 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.autoinstall)).filter(Boolean));
+    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.autoinstall)));
+    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, autoinstall) {
+async function loadPlugin(pluginArg, relative, options = {}, packageManager, shouldAutoInstall) {
   if (typeof pluginArg !== 'string') {
     return pluginArg;
   }
 
   let plugin = await packageManager.require(pluginArg, relative, {
-    autoinstall
+    shouldAutoInstall
   });
   plugin = plugin.default || plugin;
-
-  if (options != null && typeof options === 'object' && Object.keys(options).length > 0) {
-    plugin = plugin(options);
-  }
-
-  return plugin.default || plugin;
+  return plugin(options);
 }

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@parcel/transformer-posthtml",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-nightly.1002+5530a6ef",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/parcel"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/parcel-bundler/parcel.git"
@@ -12,15 +16,17 @@
   "main": "lib/PostHTMLTransformer.js",
   "source": "src/PostHTMLTransformer.js",
   "engines": {
-    "parcel": "^2.0.0-alpha.1.1"
+    "node": ">= 12.0.0",
+    "parcel": "2.0.0-nightly.1000+5530a6ef"
   },
   "dependencies": {
-    "@parcel/plugin": "2.0.0-beta.1",
+    "@parcel/plugin": "2.0.0-nightly.1002+5530a6ef",
+    "@parcel/utils": "2.0.0-nightly.1002+5530a6ef",
     "nullthrows": "^1.1.1",
-    "posthtml": "^0.11.3",
-    "posthtml-parser": "^0.4.1",
-    "posthtml-render": "^1.1.5",
-    "semver": "^5.4.1"
+    "posthtml": "^0.16.5",
+    "posthtml-parser": "^0.10.1",
+    "posthtml-render": "^3.0.0",
+    "semver": "^5.7.1"
   },
-  "gitHead": "74335525be92e23bac4ed1bf30595443cfb238e3"
+  "gitHead": "5530a6eff8b619873353baeb0457ae4ec591e9fa"
 }

package/src/PostHTMLTransformer.js

@@ -4,14 +4,19 @@ import {Transformer} from '@parcel/plugin';
 
 import path from 'path';
 import posthtml from 'posthtml';
-import parse from 'posthtml-parser';
-import render from 'posthtml-render';
+import {parser as parse} from 'posthtml-parser';
+import {render} from 'posthtml-render';
 import nullthrows from 'nullthrows';
 import semver from 'semver';
+import {relativePath} from '@parcel/utils';
 import loadPlugins from './loadPlugins';
 
-export default new Transformer({
-  async loadConfig({config}) {
+export default (new Transformer({
+  async loadConfig({config, options, logger}) {
+    if (!config.isSource) {
+      return;
+    }
+
     let configFile = await config.getConfig(
       ['.posthtmlrc', '.posthtmlrc.js', 'posthtml.config.js'],
       {
@@ -22,26 +27,52 @@ export default new Transformer({
     if (configFile) {
       let isJavascript = path.extname(configFile.filePath) === '.js';
       if (isJavascript) {
-        config.shouldInvalidateOnStartup();
-        config.shouldReload();
+        // 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.',
+        });
+
+        config.invalidateOnStartup();
+
+        // Also add the config as a dev dependency so we attempt to reload in watch mode.
+        config.addDevDependency({
+          specifier: relativePath(
+            path.dirname(config.searchPath),
+            configFile.filePath,
+          ),
+          resolveFrom: config.searchPath,
+        });
       }
 
-      // tells posthtml that we have already called parse
-      configFile.contents.skipParse = true;
+      // Load plugins. This must be done before adding dev dependencies so we auto install.
+      let plugins = await loadPlugins(
+        configFile.contents.plugins,
+        config.searchPath,
+        options,
+      );
 
-      config.setResult({
-        contents: configFile.contents,
-        isSerialisable: !isJavascript,
-      });
-    }
-  },
+      // 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;
 
-  preSerializeConfig({config}) {
-    if (!config.result) return;
+      // tells posthtml that we have already called parse
+      configFile.contents.skipParse = true;
+      delete configFile.contents.render;
 
-    // Ensure we dont try to serialise functions
-    if (!config.result.isSerialisable) {
-      config.result.contents = {};
+      return configFile.contents;
     }
   },
 
@@ -60,33 +91,28 @@ export default new Transformer({
       version: '0.4.1',
       program: parse(await asset.getCode(), {
         lowerCaseAttributeNames: true,
+        sourceLocations: true,
+        xmlMode: asset.type === 'xhtml',
       }),
     };
   },
 
-  async transform({asset, config, options}) {
+  async transform({asset, config}) {
     if (!config) {
       return [asset];
     }
 
-    // load plugins
-    const plugins = await loadPlugins(
-      config.contents.plugins,
-      asset.filePath,
-      options,
-    );
-
     let ast = nullthrows(await asset.getAST());
-    let res = await posthtml(plugins).process(ast.program, {
-      ...config.contents,
-      plugins,
+    let res = await posthtml(config.plugins).process(ast.program, {
+      ...config,
+      plugins: config.plugins,
     });
 
     if (res.messages) {
       await Promise.all(
         res.messages.map(({type, file: filePath}) => {
           if (type === 'dependency') {
-            return asset.addIncludedFile({filePath});
+            return asset.invalidateOnFileChange(filePath);
           }
           return Promise.resolve();
         }),
@@ -102,9 +128,11 @@ export default new Transformer({
     return [asset];
   },
 
-  generate({ast}) {
+  generate({ast, asset}) {
     return {
-      content: render(ast.program),
+      content: render(ast.program, {
+        closingSingleTag: asset.type === 'xhtml' ? 'slash' : undefined,
+      }),
     };
   },
-});
+}): Transformer);

package/src/loadPlugins.js

@@ -17,7 +17,7 @@ export default async function loadExternalPlugins(
             relative,
             null,
             options.packageManager,
-            options.autoinstall,
+            options.shouldAutoInstall,
           ),
         )
         .filter(Boolean),
@@ -31,7 +31,7 @@ export default async function loadExternalPlugins(
           relative,
           _plugins[p],
           options.packageManager,
-          options.autoinstall,
+          options.shouldAutoInstall,
         ),
       ),
     );
@@ -46,24 +46,17 @@ async function loadPlugin(
   relative: FilePath,
   options: mixed = {},
   packageManager: PackageManager,
-  autoinstall: boolean,
+  shouldAutoInstall: boolean,
 ): mixed {
   if (typeof pluginArg !== 'string') {
     return pluginArg;
   }
 
   let plugin = await packageManager.require(pluginArg, relative, {
-    autoinstall,
+    shouldAutoInstall,
   });
-  plugin = plugin.default || plugin;
 
-  if (
-    options != null &&
-    typeof options === 'object' &&
-    Object.keys(options).length > 0
-  ) {
-    plugin = plugin(options);
-  }
+  plugin = plugin.default || plugin;
 
-  return plugin.default || plugin;
+  return plugin(options);
 }