@rollup-extras/plugin-clean 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 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
+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/README.md

@@ -0,0 +1,37 @@
+# Plugin Clean
+
+Rollup plugin to clean a directory during build.
+
+Points:
+
+- Uses fs.rm to remove directories that shipped with nodejs and has built-in retries
+- Can be used with no configuration
+- Runs once per directory by default (good for watch mode)
+- Minimal amount of logs by default
+
+No globs support, please use [rollup-plugin-delete](https://github.com/vladshcherbin/rollup-plugin-delete) for globs.
+
+Plugin runs on `renderStart` per each output and uses output.dir as a default target.
+
+Uses [`@niceties/logger`](https://github.com/kshutkin/niceties/blob/main/logger/README.md) to log messages, can be configured through `@niceties/logger` API.
+
+## Configuration
+
+```typescript
+export 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
+    verbose?: boolean // default false
+};
+```
+
+## Prior Art
+
+- https://github.com/vladshcherbin/rollup-plugin-delete
+- https://github.com/saf33r/rollup-plugin-cleaner
+- https://github.com/DongShelton/rollup-plugin-clear
+
+# License
+
+[MIT](./LICENSE)

package/dist/index.cjs

@@ -0,0 +1,59 @@
+'use strict';
+
+var fs = require('fs/promises');
+var path = require('path');
+var logger = require('@niceties/logger');
+
+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);
+                }
+            }
+        }
+    };
+    async function removeDir(dir) {
+        const normalizedDir = normalizeSlash(path__default["default"].normalize(dir));
+        if (runOnce && deleted.has(normalizedDir)) {
+            return;
+        }
+        deleted.add(normalizedDir);
+        const logger$1 = logger.createLogger(pluginName);
+        try {
+            logger$1.start(`cleaning '${normalizedDir}'`, verbose ? 1 /* info */ : 0 /* verbose */);
+            await fs__default["default"].rm(normalizedDir, { recursive: true });
+            logger$1.finish(`cleaned '${normalizedDir}'`);
+        }
+        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);
+        }
+    }
+}
+function normalizeSlash(dir) {
+    if (dir.endsWith('/')) {
+        return `${dir.substring(0, dir.length - 1)}`;
+    }
+    return dir;
+}
+
+module.exports = index;

package/dist/index.d.ts

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

package/dist/index.mjs

@@ -0,0 +1,52 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { createLogger } from '@niceties/logger';
+
+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);
+                }
+            }
+        }
+    };
+    async function removeDir(dir) {
+        const normalizedDir = normalizeSlash(path.normalize(dir));
+        if (runOnce && deleted.has(normalizedDir)) {
+            return;
+        }
+        deleted.add(normalizedDir);
+        const logger = createLogger(pluginName);
+        try {
+            logger.start(`cleaning '${normalizedDir}'`, verbose ? 1 /* info */ : 0 /* verbose */);
+            await fs.rm(normalizedDir, { recursive: true });
+            logger.finish(`cleaned '${normalizedDir}'`);
+        }
+        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);
+        }
+    }
+}
+function normalizeSlash(dir) {
+    if (dir.endsWith('/')) {
+        return `${dir.substring(0, dir.length - 1)}`;
+    }
+    return dir;
+}
+
+export { index as default };

package/dist/types.d.ts

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

package/package.json

@@ -0,0 +1,77 @@
+{
+  "version": "1.0.0",
+  "license": "MIT",
+  "name": "@rollup-extras/plugin-clean",
+  "author": {
+    "name": "Konstantin Shutkin"
+  },
+  "funding": "https://www.donationalerts.com/r/excitingcode",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=15"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kshutkin/rollup-extras.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kshutkin/rollup-extras/issues"
+  },
+  "homepage": "https://github.com/kshutkin/rollup-extras/plugin-clean/README.md",
+  "keywords": [
+    "rollup-plugin"
+  ],
+  "scripts": {
+    "build": "rimraf ./dist && rollup -c",
+    "dev": "rimraf ./dist && rollup -c -w",
+    "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",
+    "@semantic-release/npm": "8.0.2",
+    "@semantic-release/release-notes-generator": "10.0.2",
+    "@types/jest": "27.0.2",
+    "@typescript-eslint/eslint-plugin": "5.3.0",
+    "@typescript-eslint/parser": "5.3.0",
+    "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"
+  },
+  "peerDependencies": {
+    "rollup": "^2.60.2"
+  },
+  "dependencies": {
+    "@niceties/logger": "1.0.4"
+  },
+  "readme": "ERROR: No README data found!"
+}