Merge branch 'release/1.0.1'

dist/cjs/index.js

@@ -6,37 +6,43 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const critical = require('critical');
 const criticalSuffix = '_critical.min.css';
+/**
+ * Default `criticalConfig` passed in to `critical`
+ */
 const defaultCriticalConfig = {
     inline: false,
     minify: true,
     extract: false,
     width: 1200,
     height: 1200,
-    concurrency: 4,
     penthouse: {
         blockJSRequests: false
     }
 };
+/**
+ * [Vite.js](https://vitejs.dev/) & [Rollup](https://rollupjs.org/) plugin for generating critical CSS
+ * that uses the [critical](https://github.com/addyosmani/critical) generator under the hood.
+ *
+ * @param {CriticalPluginConfig} pluginConfig - the plugin configuration object
+ * @param {Function} callback - callback upon completion of the critical CSS generation
+ * @constructor
+ */
 function PluginCritical(pluginConfig, callback) {
     return {
         name: 'critical',
         async writeBundle(outputOptions, bundle) {
             const css = [];
             // Find all of the generated CSS assets
-            if (bundle) {
-                for (const chunk of Object.values(bundle)) {
-                    if (chunk.type === 'asset' && chunk.fileName.endsWith('.css')) {
-                        if (outputOptions.dir !== undefined) {
-                            const cssFile = path_1.default.join(outputOptions.dir, chunk.fileName);
-                            css.push(cssFile);
-                        }
-                    }
-                }
-                // If we have no CSS, skip bundle
-                if (!css.length) {
-                    return;
+            for (const chunk of Object.values(bundle)) {
+                if (chunk.type === 'asset' && chunk.fileName.endsWith('.css')) {
+                    const cssFile = path_1.default.join(outputOptions.dir || '', chunk.fileName);
+                    css.push(cssFile);
                 }
             }
+            // If we have no CSS, skip bundle
+            if (!css.length) {
+                return;
+            }
             // Iterate through the pages
             for (const page of pluginConfig.criticalPages) {
                 const criticalBase = pluginConfig.criticalBase;
@@ -62,5 +68,4 @@ function PluginCritical(pluginConfig, callback) {
         }
     };
 }
-;
 exports.default = PluginCritical;

dist/esm/index.js

@@ -1,37 +1,43 @@
 import path from 'path';
 const critical = require('critical');
 const criticalSuffix = '_critical.min.css';
+/**
+ * Default `criticalConfig` passed in to `critical`
+ */
 const defaultCriticalConfig = {
     inline: false,
     minify: true,
     extract: false,
     width: 1200,
     height: 1200,
-    concurrency: 4,
     penthouse: {
         blockJSRequests: false
     }
 };
+/**
+ * [Vite.js](https://vitejs.dev/) & [Rollup](https://rollupjs.org/) plugin for generating critical CSS
+ * that uses the [critical](https://github.com/addyosmani/critical) generator under the hood.
+ *
+ * @param {CriticalPluginConfig} pluginConfig - the plugin configuration object
+ * @param {Function} callback - callback upon completion of the critical CSS generation
+ * @constructor
+ */
 function PluginCritical(pluginConfig, callback) {
     return {
         name: 'critical',
         async writeBundle(outputOptions, bundle) {
             const css = [];
             // Find all of the generated CSS assets
-            if (bundle) {
-                for (const chunk of Object.values(bundle)) {
-                    if (chunk.type === 'asset' && chunk.fileName.endsWith('.css')) {
-                        if (outputOptions.dir !== undefined) {
-                            const cssFile = path.join(outputOptions.dir, chunk.fileName);
-                            css.push(cssFile);
-                        }
-                    }
-                }
-                // If we have no CSS, skip bundle
-                if (!css.length) {
-                    return;
+            for (const chunk of Object.values(bundle)) {
+                if (chunk.type === 'asset' && chunk.fileName.endsWith('.css')) {
+                    const cssFile = path.join(outputOptions.dir || '', chunk.fileName);
+                    css.push(cssFile);
                 }
             }
+            // If we have no CSS, skip bundle
+            if (!css.length) {
+                return;
+            }
             // Iterate through the pages
             for (const page of pluginConfig.criticalPages) {
                 const criticalBase = pluginConfig.criticalBase;
@@ -57,5 +63,4 @@ function PluginCritical(pluginConfig, callback) {
         }
     };
 }
-;
 export default PluginCritical;

dist/index.d.ts

@@ -1,13 +1,45 @@
 import { Plugin } from 'rollup';
 interface CriticalPages {
+    /** Combined with `criticalUrl` to determine the URLs to scrape for Critical CSS */
     uri: string;
+    /** Critical CSS files are named with the `template` path, and saved to the `criticalBase` directory */
     template: string;
 }
 interface CriticalPluginConfig {
+    /**
+     * The base URL to use in combination with the `criticalPages` `uri`s to determine the URLs to scrape for Critical CSS.
+     * This can also be a file system path. This is combined with `criticalPages.uri`
+     * to determine pages to scrap for critical CSS.
+     * Determines the `criticalConfig.src` property
+     */
     criticalUrl: string;
+    /**
+     * The base file system path to where the generated Critical CSS file should be saved.
+     * This is combined with `criticalPages.template` with `_critical.min.css` appended
+     * to it to determine the saved critical CSS file name.
+     * Determines the `criticalConfig.target` property
+     */
     criticalBase?: string;
+    /**
+     * An array objects that contain the page `uri`s that are combined with the `criticalUrl` to
+     * determine the URLs to scrape for Critical CSS. The resulting files are named with the
+     * `template` path, and saved to the `criticalBase` directory
+     */
     criticalPages: Partial<CriticalPages>[];
+    /**
+     * This is the full [config for critical](https://github.com/addyosmani/critical#options) that is passed
+     * through to the `critical` package.
+     * You may optionally override any properties you like here
+     */
     criticalConfig?: Partial<CriticalConfig>;
 }
+/**
+ * [Vite.js](https://vitejs.dev/) & [Rollup](https://rollupjs.org/) plugin for generating critical CSS
+ * that uses the [critical](https://github.com/addyosmani/critical) generator under the hood.
+ *
+ * @param {CriticalPluginConfig} pluginConfig - the plugin configuration object
+ * @param {Function} callback - callback upon completion of the critical CSS generation
+ * @constructor
+ */
 declare function PluginCritical(pluginConfig: CriticalPluginConfig, callback?: Function): Plugin;
 export default PluginCritical;

package.json

@@ -43,7 +43,7 @@
     "@types/node": "^14.6.0",
     "jest": "^27.0.3",
     "rollup": "^2.50.5",
-    "ts-jest": "^27.0.1",
+    "ts-jest": "^27.0.2",
     "typescript": "latest"
   },
   "peerDependencies": {