Check whether or not the current working directory is valid on windows
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
test-fixtures
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
package-lock.json
package.json

README.md

valid-directory

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Check whether or not a directory and its descendants are valid

Validity determined via the valid-filename package.

Install

NPM

  • Install: npm install --global valid-directory
  • Executable: valid-directory

Editions

This package is published with the following editions:

  • valid-directory aliases valid-directory/source/index.js
  • valid-directory/source/index.js is esnext source code with require for modules

Older environments may need Babel's Polyfill or something similar.

Usage

API

Complete API Documentation.

const validate = require('valid-directory')
validate(process.cwd(), function (error, valid, invalidPaths) {
    if (error) throw error
    else if (valid) {
        console.log('ok')
    }
    else {
        console.log('invalid due to these:', invalidPaths)
    }
})

Executable

Run npm install -g valid-directory then run against the current working directory with valid-directory or a specified directory via valid-directory <path>.

Exit code will be 1 if validation failed to execute, 2 if validation failed, and 0 if validation passed.

Packages

To validate your packages before you publish them, you can do the following:

  1. Inside your package directory, run: npm install --save-dev valid-directory
  2. Then append && npx valid-directory to your test script inside your package.json file

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

  • Benjamin Lupton

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

  • Copyright © 2018+ Benjamin Lupton

and licensed under: