valid-directory
Check whether or not a directory and its descendants are valid
Validity determined via the valid-filename
package.
Usage
API
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:
- Inside your package directory, run:
npm install --save-dev valid-directory
- Then append
&& npx valid-directory
to yourtest
script inside yourpackage.json
file
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
- Import:
import * as pkg from ('valid-directory')
- Require:
const pkg = require('valid-directory')
Editions
This package is published with the following editions:
-
valid-directory
aliasesvalid-directory/source/index.js
-
valid-directory/source/index.js
is ESNext source code for Node.js with Require for modules
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
}
}
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:
Sponsors
No sponsors yet! Will you be the first?
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: