@rollup-extras/plugin-html 1.3.3 → 1.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Konstantin Shutkin
+Copyright (c) 2023 Konstantin Shutkin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,12 +7,12 @@ Points:
 - Inject file names with hashes
 - Watch on a template file and trigger rebuild if it is changed
 - Provides minimalistic template by default, so you are ready to start without configuration
-- Support mutliple rollup configs (will trigger only when last output generated)
+- Supports multiple rollup configs (will trigger only when last output generated)
 - Extensible through API so you can plug in something for html processing or generate new types of html elements
 
 Uses [`@niceties/logger`](https://github.com/kshutkin/niceties/blob/main/logger/README.md) to log messages, can be configured through `@niceties/logger` API.
 
-[Changlelog](./CHANGELOG.md)
+[Changelog](./CHANGELOG.md)
 
 ## Installation
 
@@ -54,13 +54,13 @@ For additional plugin instances (in case of multiple configs) please use: `first
 
 Optional, string.
 
-For debugging purposes, so many instances of a plugin can be differenciated in debugging output.
+For debugging purposes, so many instances of a plugin can be differentiated in debugging output.
 
 ### outputFile
 
 Optional, string, default: `'index.html'`.
 
-Use to override output file name. If file name with the same name exits in pipeline it will be removed or overwritten in the process but its content by default will be used as an input for this plugin. In the following example file emitted by copy plugin will be used as an input for this plugin:
+Used to override output file name. If a filename with the same name exists in the pipeline it will be removed or overwritten in the process but its content by default will be used as an input for this plugin. In the following example file emitted by copy plugin will be used as an input for this plugin:
 
 ```javascript
 import copy from '@rollup-extras/plugin-copy';
@@ -88,43 +88,43 @@ Default template string or template file name. If it is a template string it sho
 
 Optional, boolean, default: true.
 
-If plugin found a template file name this option defines if plugin need to watch it or not.
+If the plugin found a template file name this option defines if the plugin needs to watch it or not.
 
 ### emitFile
 
 Optional, boolean, default: true.
 
-Defines if plugin should use this.emitFile or should just write it to disk. Option can be ignored in setup with mutliple rollup configs.
+Defines if the plugin should use this.emitFile or should just write it to disk. Option can be ignored in setup with multiple rollup configs.
 
 ### useEmittedTemplate
 
 Optional, boolean, default: true.
 
-Defines what plugin does if it finds a file with expected file name in bundle. By default it will be used as a template. Template provided through template option should be of higher priority to the plugin.
+Defines what the plugin does if it finds a file with the expected file name in the bundle. By default it will be used as a template. Templates provided through the template option should be of higher priority to the plugin.
 
 ### conditionalLoading
 
 Optional, boolean, default: undefined.
 
-Defines if plugin adds `nomodule` attribute for non modular js chunks. By default it is done only if we have `es` outputs in one of the bundles processed by plugin. Also plugin values `iife` outputs higher than `umd` and if we have both filters out `umd` ones. This can be changes only by providing custom `assetFactory`.
+Defines if plugin adds `nomodule` attribute for non modular js chunks. By default it is done only if we have `es` outputs in one of the bundles processed by the plugin. Also plugin values `iife` outputs higher than `umd` and if we have both filters out `umd` ones. This can be changed only by providing custom `assetFactory`.
 
 ### injectIntoHead
 
 Optional, RegExp | function | boolean, default: `(fileName: string) => fileName.endsWith(cssExtention)`.
 
-Option to customize what assets should be injected into head element of a template.
+Option to customize what assets should be injected into the head element of a template.
 
 ### ignore
 
 Optional, RegExp | function | boolean, default: false.
 
-Option to customize what assets should be ignored in process.
+Option to customize what assets should be ignored in the process.
 
 ### verbose
 
 Optional, boolean, default: false.
 
-Option to print more debug information into console (with default appender).
+Option to print more debug information into the console (with default appender).
 
 ### useWriteBundle
 
@@ -136,7 +136,7 @@ Option to use `writeBundle` hook instead of `generateBundle`.
 
 Optional, function (please check type in configuration section).
 
-To process additional types of assets / enchance default behavior. If known asset processed by factory (it returned an object, string or promise) plugin skips default processing for this asset.
+To process additional types of assets / enhance default behavior. If a known asset is processed by a factory (it returns an object, string or promise), the plugin skips default processing for this asset.
 
 Example (adds integrity attribute to a css file):
 ```javascript
@@ -170,7 +170,7 @@ export default {
 
 Optional, function (please check type in configuration section).
 
-Use to customize template with external libraries.
+Used to customize templates with external libraries.
 
 Example (pretty print html):
 
@@ -192,6 +192,32 @@ export default {
 };
 ```
 
+## Asset Factories (/asset-factories export)
+
+### simpleES5Script
+
+`(PredicateSource) => AssetFactory`
+
+Creates a simple script element.
+
+### simpleES5FallbackScript
+
+`(PredicateSource) => AssetFactory`
+
+Creates a simple script element with `nomodule` attribute.
+
+### simpleModuleScript
+
+`(PredicateSource) => AssetFactory`
+
+Creates a simple module script element.
+
+### combineAssetFactories
+
+`(...factories: AssetFactory[]) => AssetFactory`
+
+Combines several factories, calls them in order, the first factory created asset wins.
+
 ## Configuration
 
 [Definition of config typings in typescript](./src/types.ts)
@@ -205,4 +231,4 @@ export default {
 
 # License
 
-[MIT](./LICENSE)
+[MIT](https://github.com/kshutkin/rollup-extras/blob/main/LICENSE)

package/asset-factories/package.json

@@ -0,0 +1,5 @@
+{
+  "type": "module",
+  "types": "../dist/asset-factories.d.ts",
+  "main": "../dist/asset-factories.mjs"
+}

package/dist/asset-factories.cjs

@@ -0,0 +1,61 @@
+'use strict';
+
+var logger$1 = require('@niceties/logger');
+var shared = require('./shared.cjs');
+
+const noopPredicate = () => false;
+let logger;
+function simpleES5Script(predicateSource) {
+    const predicate = getPredicate(predicateSource);
+    return (fileName) => {
+        if (predicate(fileName)) {
+            return shared.getNonModuleScriptElement(fileName, false);
+        }
+    };
+}
+function simpleES5FallbackScript(predicateSource) {
+    const predicate = getPredicate(predicateSource);
+    return (fileName) => {
+        if (predicate(fileName)) {
+            return shared.getNonModuleScriptElement(fileName, true);
+        }
+    };
+}
+function simpleModuleScript(predicateSource) {
+    const predicate = getPredicate(predicateSource);
+    return (fileName) => {
+        if (predicate(fileName)) {
+            return shared.getModuleScriptElement(fileName);
+        }
+    };
+}
+function combineAssetFactories(...factories) {
+    return (fileName, content, type) => {
+        for (const factory of factories) {
+            const result = factory(fileName, content, type);
+            if (result) {
+                return result;
+            }
+        }
+    };
+}
+function getPredicate(predicateSource) {
+    let predicate = shared.toAssetPredicate(predicateSource);
+    if (!predicate) {
+        const logger = getLogger();
+        logger(`${predicateSource} is not valid, using noopPredicate`, 2 /* LogLevel.warn */);
+        predicate = noopPredicate;
+    }
+    return predicate;
+}
+function getLogger() {
+    if (!logger) {
+        logger = logger$1.createLogger('@rollup-extras/plugin-html/asset-factories');
+    }
+    return logger;
+}
+
+exports.combineAssetFactories = combineAssetFactories;
+exports.simpleES5FallbackScript = simpleES5FallbackScript;
+exports.simpleES5Script = simpleES5Script;
+exports.simpleModuleScript = simpleModuleScript;

package/dist/asset-factories.d.ts

@@ -0,0 +1,6 @@
+import type { AssetFactory, PredicateSource } from './types';
+import type { InternalModuleFormat } from 'rollup';
+export declare function simpleES5Script(predicateSource: PredicateSource): (fileName: string) => string | undefined;
+export declare function simpleES5FallbackScript(predicateSource: PredicateSource): (fileName: string) => string | undefined;
+export declare function simpleModuleScript(predicateSource: PredicateSource): (fileName: string) => string | undefined;
+export declare function combineAssetFactories(...factories: AssetFactory[]): (fileName: string, content: string | Uint8Array, type: 'asset' | InternalModuleFormat) => string | import("./types").AssetDescriptor | Promise<string | import("./types").AssetDescriptor | undefined> | undefined;

package/dist/asset-factories.mjs

@@ -0,0 +1,56 @@
+import { createLogger } from '@niceties/logger';
+import { a as getNonModuleScriptElement, b as getModuleScriptElement, t as toAssetPredicate } from './shared.mjs';
+
+const noopPredicate = () => false;
+let logger;
+function simpleES5Script(predicateSource) {
+    const predicate = getPredicate(predicateSource);
+    return (fileName) => {
+        if (predicate(fileName)) {
+            return getNonModuleScriptElement(fileName, false);
+        }
+    };
+}
+function simpleES5FallbackScript(predicateSource) {
+    const predicate = getPredicate(predicateSource);
+    return (fileName) => {
+        if (predicate(fileName)) {
+            return getNonModuleScriptElement(fileName, true);
+        }
+    };
+}
+function simpleModuleScript(predicateSource) {
+    const predicate = getPredicate(predicateSource);
+    return (fileName) => {
+        if (predicate(fileName)) {
+            return getModuleScriptElement(fileName);
+        }
+    };
+}
+function combineAssetFactories(...factories) {
+    return (fileName, content, type) => {
+        for (const factory of factories) {
+            const result = factory(fileName, content, type);
+            if (result) {
+                return result;
+            }
+        }
+    };
+}
+function getPredicate(predicateSource) {
+    let predicate = toAssetPredicate(predicateSource);
+    if (!predicate) {
+        const logger = getLogger();
+        logger(`${predicateSource} is not valid, using noopPredicate`, 2 /* LogLevel.warn */);
+        predicate = noopPredicate;
+    }
+    return predicate;
+}
+function getLogger() {
+    if (!logger) {
+        logger = createLogger('@rollup-extras/plugin-html/asset-factories');
+    }
+    return logger;
+}
+
+export { combineAssetFactories, simpleES5FallbackScript, simpleES5Script, simpleModuleScript };