Check whether or not a directory and its descendants are valid
Validity determined via the valid-filename
package.
import validate from 'valid-directory'
const path = process.cwd()
validate(path)
.then(([valid, invalidPaths]) => {
if (valid) {
console.log(path, 'is a valid directory')
} else {
console.log(
path,
'is an INVALID directory due to these:',
invalidPaths
)
process.exit(1)
}
})
.catch((err) => throw err)
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.
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 --global valid-directory
- Executable:
valid-directory
- Install:
npm install --save valid-directory
- Executable:
npx valid-directory
- Import:
import pkg from ('valid-directory')
- Require:
const pkg = require('valid-directory').default
This package is published with the following editions:
-
valid-directory
aliasesvalid-directory/index.cjs
which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment -
valid-directory/source/index.ts
is TypeScript source code with Import for modules -
valid-directory/edition-esnext/index.js
is TypeScript compiled against ESNext for Node.js 14 with Require for modules -
valid-directory/edition-es2019/index.js
is TypeScript compiled against ES2019 for Node.js 10 || 12 || 13 || 14 with Require for modules -
valid-directory/edition-node-esm/index.js
is TypeScript compiled against ESNext for Node.js with Import for modules
Discover the release history by heading on over to the HISTORY.md
file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Unless stated otherwise all works are:
- Copyright © 2018+ Benjamin Lupton
and licensed under: