@rollup-extras/plugin-clean 1.0.0 → 1.0.4

package/README.md

@@ -15,15 +15,74 @@ Plugin runs on `renderStart` per each output and uses output.dir as a default ta
 
 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)
+
+## Installation
+
+```
+npm install --save-dev @rollup-extras/plugin-clean
+```
+
+### Examples
+
+Normal usage:
+
+```javascript
+import clean from '@rollup-extras/plugin-clean';
+
+export default {
+	input: 'src/index.js',
+
+    output: {
+        format: 'es',
+        dir: 'dest'
+    },
+
+	plugins: [clean()],
+}
+```
+
+To override / provide target directory to clean use:
+```javascript
+clean('dir')
+```
+or
+
+```javascript
+clean(['dir1', 'dir2'])
+```
+or
+
+```javascript
+clean({targets: 'dir1'})
+```
+
+or
+
+```javascript
+clean({targets: ['dir1', 'dir2']})
+```
+
+Other supporded fields in options object: `pluginName`, `deleteOnce`, `outputPlugin` and `verbose`.
+
+`pluginName` is just for debugging purpose so you can understand which instance of plugin responsible for an error.
+
+`deleteOnce` can be set to `false` if you want to clean directory every rebuild.
+
+`outputPlugin` can be set to `false` if you want plugin to trigger earlier (use with caution, you may want to define `targets` youself in this mode)
+
+`verbose` is to get more messages in console.
+
 ## Configuration
 
 ```typescript
-export type CleanPluginOptions = {
+type CleanPluginOptions = {
     targets?: string | string[], // defaulted to output.dir per output
     pluginName?: string, // for debugging purposes, default is `@rollup-extras/plugin-clean`
-    runOnce?: boolean, // default true
+    deleteOnce?: boolean, // default true
+    outputPlugin?: boolean, // default true
     verbose?: boolean // default false
-};
+} | string | string[];
 ```
 
 ## Prior Art

package/dist/index.cjs

@@ -3,40 +3,67 @@
 var fs = require('fs/promises');
 var path = require('path');
 var logger = require('@niceties/logger');
+var options = require('@rollup-extras/utils/options');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 
-function index ({ targets, pluginName, runOnce, verbose } = {}) {
-    const deleted = new Set();
-    pluginName !== null && pluginName !== void 0 ? pluginName : (pluginName = '@rollup-extras/plugin-clean');
-    runOnce !== null && runOnce !== void 0 ? runOnce : (runOnce = true);
-    return {
-        name: pluginName,
-        async renderStart(options) {
-            if (!targets) {
-                if (options.dir) {
-                    await removeDir(options.dir);
-                }
-            }
-            else {
-                if (Array.isArray(targets)) {
-                    await Promise.all(targets.map(removeDir));
-                }
-                else {
-                    await removeDir(targets);
-                }
+function index (options$1 = {}) {
+    const deleted = new Map();
+    const normalizedOptions = options.getOptions(options$1, {
+        pluginName: '@rollup-extras/plugin-clean',
+        deleteOnce: true,
+        verbose: false,
+        outputPlugin: true
+    }, 'targets');
+    const { pluginName, deleteOnce, verbose, outputPlugin } = normalizedOptions;
+    let { targets } = normalizedOptions;
+    const pluginInstance = {
+        name: pluginName
+    };
+    if (outputPlugin) {
+        pluginInstance.renderStart = renderStart;
+    }
+    else {
+        pluginInstance.buildStart = buildStart;
+        pluginInstance.options = optionsHook;
+    }
+    return pluginInstance;
+    async function optionsHook(config) {
+        var _a;
+        if (!targets && config) {
+            targets = (Array.isArray(config.output) ? config.output.map(item => item.dir) : [(_a = config.output) === null || _a === void 0 ? void 0 : _a.dir])
+                .filter(Boolean);
+        }
+        return null;
+    }
+    async function buildStart() {
+        if (targets) {
+            await Promise.all(targets.map(removeDir));
+        }
+    }
+    async function renderStart(options) {
+        if (!targets) {
+            if (options.dir) {
+                await removeDir(options.dir);
             }
         }
-    };
+        else {
+            await Promise.all(targets.map(removeDir));
+        }
+    }
     async function removeDir(dir) {
         const normalizedDir = normalizeSlash(path__default["default"].normalize(dir));
-        if (runOnce && deleted.has(normalizedDir)) {
-            return;
+        if (deleteOnce && deleted.has(normalizedDir)) {
+            return outputPlugin && deleted.get(normalizedDir);
         }
-        deleted.add(normalizedDir);
+        const removePromise = doRemove(normalizedDir);
+        deleted.set(normalizedDir, removePromise);
+        return removePromise;
+    }
+    async function doRemove(normalizedDir) {
         const logger$1 = logger.createLogger(pluginName);
         try {
             logger$1.start(`cleaning '${normalizedDir}'`, verbose ? 1 /* info */ : 0 /* verbose */);
@@ -45,7 +72,7 @@ function index ({ targets, pluginName, runOnce, verbose } = {}) {
         }
         catch (e) { // eslint-disable-line @typescript-eslint/no-explicit-any
             const loglevel = e['code'] === 'ENOENT' ? undefined : 2 /* warn */;
-            logger$1.finish(`failed cleaning '${normalizedDir}'\n${e.stack}`, loglevel);
+            logger$1.finish(`failed cleaning '${normalizedDir}'`, loglevel, e);
         }
     }
 }

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 import { PluginHooks } from 'rollup';
 import { CleanPluginOptions } from './types';
-export default function ({ targets, pluginName, runOnce, verbose }?: CleanPluginOptions): Partial<PluginHooks>;
+export default function (options?: CleanPluginOptions): Partial<PluginHooks>;

package/dist/index.mjs

@@ -1,35 +1,62 @@
 import fs from 'fs/promises';
 import path from 'path';
 import { createLogger } from '@niceties/logger';
+import { getOptions } from '@rollup-extras/utils/options';
 
-function index ({ targets, pluginName, runOnce, verbose } = {}) {
-    const deleted = new Set();
-    pluginName !== null && pluginName !== void 0 ? pluginName : (pluginName = '@rollup-extras/plugin-clean');
-    runOnce !== null && runOnce !== void 0 ? runOnce : (runOnce = true);
-    return {
-        name: pluginName,
-        async renderStart(options) {
-            if (!targets) {
-                if (options.dir) {
-                    await removeDir(options.dir);
-                }
-            }
-            else {
-                if (Array.isArray(targets)) {
-                    await Promise.all(targets.map(removeDir));
-                }
-                else {
-                    await removeDir(targets);
-                }
+function index (options = {}) {
+    const deleted = new Map();
+    const normalizedOptions = getOptions(options, {
+        pluginName: '@rollup-extras/plugin-clean',
+        deleteOnce: true,
+        verbose: false,
+        outputPlugin: true
+    }, 'targets');
+    const { pluginName, deleteOnce, verbose, outputPlugin } = normalizedOptions;
+    let { targets } = normalizedOptions;
+    const pluginInstance = {
+        name: pluginName
+    };
+    if (outputPlugin) {
+        pluginInstance.renderStart = renderStart;
+    }
+    else {
+        pluginInstance.buildStart = buildStart;
+        pluginInstance.options = optionsHook;
+    }
+    return pluginInstance;
+    async function optionsHook(config) {
+        var _a;
+        if (!targets && config) {
+            targets = (Array.isArray(config.output) ? config.output.map(item => item.dir) : [(_a = config.output) === null || _a === void 0 ? void 0 : _a.dir])
+                .filter(Boolean);
+        }
+        return null;
+    }
+    async function buildStart() {
+        if (targets) {
+            await Promise.all(targets.map(removeDir));
+        }
+    }
+    async function renderStart(options) {
+        if (!targets) {
+            if (options.dir) {
+                await removeDir(options.dir);
             }
         }
-    };
+        else {
+            await Promise.all(targets.map(removeDir));
+        }
+    }
     async function removeDir(dir) {
         const normalizedDir = normalizeSlash(path.normalize(dir));
-        if (runOnce && deleted.has(normalizedDir)) {
-            return;
+        if (deleteOnce && deleted.has(normalizedDir)) {
+            return outputPlugin && deleted.get(normalizedDir);
         }
-        deleted.add(normalizedDir);
+        const removePromise = doRemove(normalizedDir);
+        deleted.set(normalizedDir, removePromise);
+        return removePromise;
+    }
+    async function doRemove(normalizedDir) {
         const logger = createLogger(pluginName);
         try {
             logger.start(`cleaning '${normalizedDir}'`, verbose ? 1 /* info */ : 0 /* verbose */);
@@ -38,7 +65,7 @@ function index ({ targets, pluginName, runOnce, verbose } = {}) {
         }
         catch (e) { // eslint-disable-line @typescript-eslint/no-explicit-any
             const loglevel = e['code'] === 'ENOENT' ? undefined : 2 /* warn */;
-            logger.finish(`failed cleaning '${normalizedDir}'\n${e.stack}`, loglevel);
+            logger.finish(`failed cleaning '${normalizedDir}'`, loglevel, e);
         }
     }
 }

package/dist/types.d.ts

@@ -1,6 +1,7 @@
 export declare type CleanPluginOptions = {
     targets?: string | string[];
     pluginName?: string;
-    runOnce?: boolean;
+    deleteOnce?: boolean;
+    outputPlugin?: boolean;
     verbose?: boolean;
-};
+} | string | string[];

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.0.4",
   "license": "MIT",
   "name": "@rollup-extras/plugin-clean",
   "author": {
@@ -30,19 +30,19 @@
     "url": "https://github.com/kshutkin/rollup-extras/issues"
   },
   "homepage": "https://github.com/kshutkin/rollup-extras/plugin-clean/README.md",
+  "readme": "README.md",
+  "description": "Rollup plugin to clean a directory during build.",
   "keywords": [
-    "rollup-plugin"
+    "rollup-plugin",
+    "clean"
   ],
   "scripts": {
-    "build": "rimraf ./dist && rollup -c",
-    "dev": "rimraf ./dist && rollup -c -w",
+    "build": "pkgbld",
     "test": "jest --collectCoverage",
     "lint": "eslint ./src",
     "semantic-release": "npx semantic-release"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "21.0.1",
-    "@rollup/plugin-node-resolve": "13.0.6",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/commit-analyzer": "9.0.1",
     "@semantic-release/git": "10.0.1",
@@ -54,24 +54,18 @@
     "conventional-changelog-angular": "5.0.13",
     "eslint": "8.1.0",
     "jest": "27.3.1",
-    "lodash": "4.17.21",
-    "rimraf": "3.0.2",
-    "is-builtin-module": "3.1.0",
-    "rollup": "2.60.1",
-    "rollup-plugin-terser": "7.0.2",
-    "rollup-plugin-typescript2": "0.31.1",
-    "rollup-plugin-preprocess": "0.0.4",
     "semantic-release": "18.0.0",
     "semantic-release-monorepo": "7.0.5",
     "ts-jest": "27.0.7",
-    "typescript": "4.4.x",
-    "update-monorepo-package-json": "0.1.6"
+    "typescript": "4.5.x",
+    "update-monorepo-package-json": "0.2.0",
+    "pkgbld": "1.1.1"
   },
   "peerDependencies": {
     "rollup": "^2.60.2"
   },
   "dependencies": {
-    "@niceties/logger": "1.0.4"
-  },
-  "readme": "ERROR: No README data found!"
+    "@niceties/logger": "^1.1.0",
+    "@rollup-extras/utils": "^1.0.1"
+  }
 }