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

valid-directory

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

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.7.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.

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?

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

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 (16)
Dependents (26)

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