Nascent Prototype Metaverse

    clear-path

    1.3.2 • Public • Published

    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

    Install

    npm i clear-path

    DownloadsWeekly Downloads

    14

    Version

    1.3.2

    License

    MIT

    Unpacked Size

    8.11 kB

    Total Files

    6

    Last publish

    Collaborators

    • vinik