README

valid-directory

Check whether or not a directory and its descendants are valid

Validity determined via the valid-filename package.

Usage

API

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)

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 your test script inside your package.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 pkg from ('valid-directory')
Require: const pkg = require('valid-directory').default

Editions

This package is published with the following editions:

valid-directory/source/index.ts is TypeScript source code with Import for modules
valid-directory aliases valid-directory/edition-es2019/index.js
valid-directory/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 16 with Require for modules
valid-directory/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js 12 || 14 || 16 with Import for modules