Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpoehnelt/directory-schema-validator
Validate directory structure and file contents with an extension of JSON schema.
https://github.com/jpoehnelt/directory-schema-validator
ajv ci directories integration jsonschema
Last synced: about 1 month ago
JSON representation
Validate directory structure and file contents with an extension of JSON schema.
- Host: GitHub
- URL: https://github.com/jpoehnelt/directory-schema-validator
- Owner: jpoehnelt
- License: apache-2.0
- Created: 2022-02-03T00:37:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-27T06:10:21.000Z (over 1 year ago)
- Last Synced: 2024-10-05T10:34:46.334Z (about 2 months ago)
- Topics: ajv, ci, directories, integration, jsonschema
- Language: TypeScript
- Homepage: https://github.com/jpoehnelt/directory-schema-validator
- Size: 1.05 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# directory-schema-validator
[](https://www.npmjs.com/package/directory-schema-validator)
[](https://jpoehnelt.github.io/directory-schema-validator/)
## Description
Validate directory structure and file contents with an extension of JSON schema.
## Install
Install using NPM or similar.
```sh
npm i directory-schema-validator
```
## Usage
```js
import {Validator, shorthandToJSONSchema} from 'directory-schema-validator';
// Helper function to generate JSON Schema from shorthand notation
const schema = shorthandToJSONSchema(['README.md']);
// the schema is the following object
{
"type": "object",
"properties": {
"files": {
"properties": {
"README.md": {
"type": "object"
}
},
"type": "object",
"required": [
"README.md"
]
}
}
}
// instantiate validator and validate schema against a path
const validator = new Validator();
const valid = validator.validate(schema, '.');
if (!valid) {
console.log(validator.errors);
}
```
This works by operating on a JSON object parsed from the file structure.
```js
import { parse } from 'directory-schema-validator';
parse('.');
{
"path": "/workspaces/directory-schema-validator",
"name": "directory-schema-validator",
"size": 873,
"type": "directory",
"directories": {},
"files": {
"README.md": {
"path": "/workspaces/directory-schema-validator/README.md",
"name": "README.md",
"size": 873,
"type": "file",
"extension": ".md"
}
}
}
```
See the [reference documentation](https://jpoehnelt.github.io/directory-schema-validator/) for more information about the structure of the JSON and signatures of each method.
> **Note**: Because this is JSONSchema, [composition](https://json-schema.org/understanding-json-schema/reference/combining.html#schema-composition) is allowed through keywords such as `allOf` or `oneOf`.
## Custom keywords
This library makes the keyword `contents` available. This keyword validates the contents of a file against an array of regex patterns.
```js
{
"type": "object",
"properties": {
"files": {
"properties": {
"README.md": {
// START CUSTOM KEYWORD
"contents": [
{
"pattern": "directory-schema-validator",
"flags": "i"
}
],
// END CUSTOM KEYWORD
"type": "object"
}
},
"type": "object",
"required": [
"README.md"
]
}
}
}
```
## Command line
Command line usage is available with the following commands: `validate`, `shorthand`, and `parse`. These commands correspond to the underlying interface.
```sh
npm install -g directory-schema-validator
directory-schema-validator --help
```
> **Note**: The shorthand command uses glob and looks for actual files unlike the programmatic interface which only uses the strings.