JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q25749F
  • License MIT

A node library for deleting a path if exists using del

Package Exports

  • clear-path
  • clear-path/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (clear-path) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

clear-path

npm version

A node library for deleting a path if exists using del.

Instalation

npm i clear-path --save-dev

How

# package.json
{
  "scripts": {
    "clean": "clear-path"
  },
  "clearpath": "dist"
}

The clearpath value can a string, or an array of glob patterns strings.

Configuration

You must add a configuration either within package.json, or creating a .clearpathrc

Using package.json

{
  "clearpath": [
    "dist/*.png",
    "dist/*.jpg"
  ],
}

Using .clearpathrc

dist/*.png
dist/*.jpg

How (in JS)

const clearPath = require( "clear-path" );

clearPath("dist");

options

clearPath("dist", {
  silent: true,
  callback: (files) => {
    console.log("Deleted theses files: ", files)
  }
})

options.silent

Default: false
If set to true, will not console log deleted files.

You can activate options.silent from cli commands using clear-path --silent or clear-path --routine:{routine_name} --silent

options.callback

If you declara a function in your options.callback, it will execute after deleting files.

Multiple clear-path routines

Example: package.json

Chose either one of the configurations samples below.

# package.json
{
  "scripts": {
    "clean": "clear-path --routine=all",
    "clean:dist": "clear-path --routine=dist"
  },
  "clearpath": {
    "routine": {
      "all": [
        "dist",
        "public"
      ],
      "dist": "dist",
    }
  }
}

Example: clearpath.rc

routine:
  all:
    dist
    public
  dist: dist