valid-directory
TypeScript icon, indicating that this package has built-in type declarations

2.2.0-next.1590083626.1bef93020f90b100a8af3bfb80e832d8a546369d • Public • Published

valid-directory

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Check whether or not a directory and its descendants are valid

Validity determined via the valid-filename package.

Usage

Complete API Documentation.

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:

  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 * as pkg from ('valid-directory')
  • Require: const pkg = require('valid-directory')

Editions

This package is published with the following editions:

  • valid-directory aliases valid-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?

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

Package Sidebar

Install

npm i valid-directory@2.2.0-next.1590083626.1bef93020f90b100a8af3bfb80e832d8a546369d

Version

2.2.0-next.1590083626.1bef93020f90b100a8af3bfb80e832d8a546369d

License

MIT

Unpacked Size

20.9 kB

Total Files

7

Last publish

Collaborators

  • bevryme