0.5.0 ā¢ Published 4 years ago
@open-tech-world/node-rm v0.5.0
@open-tech-world/node-rm
Remove files & directories using glob patterns.
Internally it uses open-tech-world/node-glob for matching files & directories. Refer it for supported glob patterns and more info.
Features
āļø Sync API
š§ Async API
āļø Supports Multiple Patterns
Installation
Using npm
npm install @open-tech-world/node-rmUsing Yarn
yarn add @open-tech-world/node-rmUsage
import { rmSync } from '@open-tech-world/node-rm';
rmSync(patterns: string | string[],
options?: Partial<IOptions>): void;Options
| Name | Type | Default | Description |
|---|---|---|---|
| cwd | string | process.cwd() | The current working directory in which to remove files & folders. |
| dot | boolean | false | If true, it removes files & directories that begin with a "."(dot) character. |
| verbose | boolean | false | If true, the current status will be output to the console. |
| colors | boolean | false | If true, it turns on color output. |
| dry | boolean | false | If true, it does not remove anything instead, it console logs what would be removed. |
Examples
my-app/
āā node_modules/
āā public/
ā āā favicon.ico
ā āā index.html
ā āā robots.txt
āā src/
ā āā index.css
ā āā index.js
āā .gitignore
āā package.json
āā README.mdimport { rmSync } from '@open-tech-world/node-rm';
rmSync('public/*', { cwd: 'my-app', verbose: true });
// my-app/public/favicon.ico
// my-app/public/index.html
// my-app/public/robots.txtimport { rmSync } from '@open-tech-world/node-rm';
rmSync(['public/*', '!**/robots.txt'], { cwd: 'my-app', verbose: true });
// my-app/public/favicon.ico
// my-app/public/index.htmlLicense
Copyright (c) 2021, Thanga Ganapathy (MIT License).