valid-directory

Check whether or not a directory and its descendants are valid

Validity determined via the @bevry/valid-filename package.

Requires Node.js version >= 18 for recursive directory support.

Usage

Complete API Documentation.

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 a path is invalid, 2 if something went wrong, 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

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

Deno

import pkg from 'https://unpkg.com/valid-directory@^4.9.0/edition-deno/index.ts'

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-es2022/index.js
• valid-directory/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Require for modules
• valid-directory/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Import for modules
• valid-directory/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
• valid-directory/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

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

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

• Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

• Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

• Benjamin Lupton — view contributions
• Sumit Rai — view contributions

Finances

Sponsors

• Andrew Nesbitt — Software engineer and researcher
• Balsa — We're Balsa, and we're building tools for builders.
• Codecov — Empower developers with tools to improve code quality and testing.
• Poonacha Medappa
• Rob Morris
• Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
• Syntax — Syntax Podcast

Donors

• Andrew Nesbitt
• Armen Mkrtchian
• Balsa
• Chad
• Codecov
• dr.dimitru
• Elliott Ditman
• entroniq
• GitHub
• Hunter Beast
• Jean-Luc Geering
• Michael Duane Mooring
• Michael Harry Scepaniak
• Mohammed Shah
• Mr. Henry
• Nermal
• Pleo
• Poonacha Medappa
• Rob Morris
• Robert de Forest
• Sentry
• ServieJS
• Skunk Team
• Syntax
• WriterJohnBuck

License

Unless stated otherwise all works are:

• Copyright © Benjamin Lupton

and licensed under:

• Artistic License 2.0