Alexandro.Net

Version 1.0.2

@stackline/grunt-contrib-clean

Clean files and folders

Independent maintenance of grunt-contrib-clean 2.0.1. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install grunt-contrib-clean@npm:@stackline/grunt-contrib-clean@1.0.2
# Or use the scoped package name in your imports
npm install @stackline/grunt-contrib-clean@1.0.2

Node.js: >=12. Read the compatibility and maintenance notes before migrating.

Usage and API

@stackline/grunt-contrib-clean

Clean files and folders.

npm version license GitHub repository Docs Reddit community

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/grunt-contrib-clean is the Stackline-maintained distribution of grunt-contrib-clean@2.0.1. It is an independent continuation of grunt-contrib-clean; original authors and licenses remain credited below.

Compatibility

Item Value
Package @stackline/grunt-contrib-clean@1.0.2
API target grunt-contrib-clean@2.0.1
Supported Node.js >=12
License MIT
Main entry tasks/clean.js
Runtime dependencies async, rimraf
Peer dependencies grunt >=0.4.5

Installation

npm install @stackline/grunt-contrib-clean

Preserve existing imports and plugin resolution with an npm alias:

npm install grunt-contrib-clean@npm:@stackline/grunt-contrib-clean

Usage and API reference

grunt-contrib-clean v2.0.0 Build Status

Clean files and folders

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install @stackline/grunt-contrib-clean --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('@stackline/grunt-contrib-clean');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Clean task

Run this task with the grunt clean command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Due to the destructive nature of this task, always be cautious of the paths you clean.

Options

force

Type: Boolean
Default: false

This overrides this task from blocking deletion of folders outside current working dir (CWD). Use with caution.

no-write

Type: Boolean
Default: false

Will not actually delete any files or directories. If the task is run with the --verbose flag, the task will log messages of what files would have be deleted.

Note: As this task property contains a hyphen, you will need to surround it with quotes.

Usage Examples

There are three formats you can use to run this task.

Short

clean: ['path/to/dir/one', 'path/to/dir/two']

Medium (specific targets with global options)

clean: {
  build: ['path/to/dir/one', 'path/to/dir/two'],
  release: ['path/to/another/dir/one', 'path/to/another/dir/two']
},

Long (specific targets with per target options)

clean: {
  build: {
    src: ['path/to/dir/one', 'path/to/dir/two']
  }
}

"Compact" and "Files Array" formats support a few additional properties which help you deal with hidden files, process dynamic mappings and so on.

Globbing Patterns

Although documented in the Grunt Docs, here are some globbing pattern examples to achieve some common tasks:

clean: {
  folder: ['path/to/dir/'],
  folder_v2: ['path/to/dir/**'],
  contents: ['path/to/dir/*'],
  subfolders: ['path/to/dir/*/'],
  css: ['path/to/dir/*.css'],
  all_css: ['path/to/dir/**/*.css']
}
Skipping Files
// Deletes all .js files, but skips min.js files
clean: {
  js: ['path/to/dir/*.js', '!path/to/dir/*.min.js']
}
Options

Options can be specified for all clean tasks and for each clean:target.

####### All tasks

// Prevents all targets from deleting any files
clean: {
  options: {
    'no-write': true
  },
  build: ['dev/build'],
  release: ['dist']
}

####### Per-target

// Will delete files for `build` target
// Will NOT delete files for `release` target
clean: {
  build: ['dev/build'],
  release: {
    options: {
      'no-write': true
    },
    src: ['dist']
  }
}

Release History

Task submitted by Tim Branyen

This file was generated on Fri Apr 15 2022 21:07:19.

Credits and original authors

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

License

MIT. See the license and notice files in the repository.

Community and Links

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.

Upstream issues and maintenance review

Upstream review

Exact source: grunt-contrib-clean@2.0.1, 9bd20a6effd37c37d892d227812e16c83c679651. Runtime task files match the integrity-checked upstream npm tarball byte-for-byte. Original authors and license are retained.

Issue review (2026-09-29)

No issue response or upstream contact was made. These are scoped compatibility decisions, not claims that every reported issue is fixed.

Development maintenance

The original Grunt task fixtures and Nodeunit assertion bodies run unchanged. A small Node assert adapter preserves expected assertion counts and asynchronous done timeouts; it replaces obsolete Nodeunit/TAP dependencies. Obsolete JSHint and release-only grunt-contrib-internal tooling were removed. The current Grunt runner is development-only; package engines and runtime dependencies retain the upstream declarations. The same full fixture suite runs against an installed package archive.

Run npm ci --ignore-scripts, npm test, npm run test:package, and npm audit --audit-level=low. GitHub CI and CodeQL gate exact artifact publication with provenance and immutable release evidence.

Release changes

Stackline changes

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.