# grunt-checkpaths

> A grunt plugin to check for paths longer than MAXPATH

Latest version **0.1.3** (published 2014-11-28) · 0 weekly downloads

## Install

```sh
npm install grunt-checkpaths
pnpm add grunt-checkpaths
yarn add grunt-checkpaths
bun add grunt-checkpaths
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2014-11-28 |
| First published | 2014-11-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Van Kichline |
| Maintainers | vkichline |
| Keywords | gruntplugin, MAXPATH |

## Links

- npm: https://www.npmjs.com/package/grunt-checkpaths
- Repository: https://github.com/vkichline/checkpaths
- Issues: https://github.com/vkichline/checkpaths/issues
- npm.io page: https://npm.io/package/grunt-checkpaths

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.1.3 (latest) — 2014-11-28
- 0.1.2 — 2014-11-28
- 0.1.1 — 2014-11-28
- 0.1.0 — 2014-11-28

## README

# grunt-checkpaths

> A grunt plugin to check for paths longer than MAXPATH

## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install -g grunt-checkpaths
```

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

```js
grunt.loadNpmTasks('grunt-checkpaths');
```

## The "checkpaths" task

### Overview
Configuration is not necessary, but can be used to turn on some options. In your project's Gruntfile, add a section named `checkPaths` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  checkpaths: {
    options: {
      debug: true,
      verbose: true
    }
  },
});
```

### Options

#### options.debug
Type: `boolean`
Default value: `'false'`

If 'true', additional infomation is logged to the console.  Currently, just the options values.

#### options.verbose
Type: `boolean`
Default value: `'false'`

If 'true' all file paths and their lengths are written to the console.

### Usage Examples

#### Default Options
All files at the level of gruntfile.js and below are tested, and any longer than 260 characters are printed out.  If paths longer than MAXPATH are found, the task fails.

```js
grunt.initConfig({
  checkpaths: {
  },
});
```

#### Custom Options
The values of the options are printed, followed by all file paths with their lengths. If paths longer than MAXPATH are found, the task fails.

```js
grunt.initConfig({
  checkpaths: {
    options: {
      debug: true,
      verbose: true
    }
  },
});
```

## Release History
0.1.0 - Nov 27 2014 - Initial release  
0.1.1 - Nov 27 2014 - Readme fixup  
0.1.2 - Nov 27 2014 - Release history  
0.1.3 - Nov 27 2014 - More work on release history

---
_Source: https://npm.io/package/grunt-checkpaths · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._