valid-directory
Check whether or not a directory and its descendants are valid
Last updated 5 years ago by bevryme .
MIT · Repository · Bugs · Original npm · Tarball · package.json 
$ npm install valid-directory
SYNC missed versions from official npm registry.

valid-directory

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal 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 Globally

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

Install Locally

  • Install: npm install --save valid-directory
  • Executable: npx valid-directory
  • Require: require('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

Environments older than Node.js v8 may need Babel's Polyfill or something similar.

TypeScript

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

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 Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal 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:

Current Tags

101 Versions

Maintainers (1)
bevryme
Downloads
Total 1
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (2)
Dev Dependencies (11)
Dependents (26)

© 2010 - cnpmjs.org x YWFE | Home | YWFE