# file-structure-checker

> This tool lets you easily check if a certain file and folder structure is present. The structure to be checked can be configured via a yaml file.

Latest version **1.1.7** (published 2020-04-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install file-structure-checker
pnpm add file-structure-checker
yarn add file-structure-checker
bun add file-structure-checker
```

Provides the command `file-structure-checker`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2020-04-01 |
| First published | 2020-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 28.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Oliver Lorenz |
| Maintainers | oliverlorenz |

## Links

- npm: https://www.npmjs.com/package/file-structure-checker
- Repository: https://github.com/oliverlorenz/file-structure-checker
- Homepage: https://github.com/oliverlorenz/file-structure-checker#readme
- Issues: https://github.com/oliverlorenz/file-structure-checker/issues
- npm.io page: https://npm.io/package/file-structure-checker

## Dependencies (8)

- [ajv](https://npm.io/package/ajv.md) ^6.12.0
- [yaml](https://npm.io/package/yaml.md) ^1.8.3
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [commander](https://npm.io/package/commander.md) ^5.0.0
- [@types/node](https://npm.io/package/@types/node.md) ^13.9.5
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.16
- [es6-template-strings](https://npm.io/package/es6-template-strings.md) ^2.0.1
- [typescript-json-schema](https://npm.io/package/typescript-json-schema.md) ^0.42.0

## Recent versions

- 1.1.7 (latest) — 2020-04-01
- 1.1.6 — 2020-04-01
- 1.1.5 — 2020-04-01
- 1.1.4 — 2020-04-01
- 1.1.2 — 2020-03-31
- 1.1.1 — 2020-03-31
- 1.1.0 — 2020-03-31
- 1.0.0 — 2020-03-30

## README

# file-structure-checker

This tool lets you easily check if a certain file and folder structure is present. The structure to be checked can be configured via a yaml file.

# usage

```
npm install -g file-structure-checker
```

create a `.file-structure-checker.yml` file in a directory you want to check. example:

```
vars:
  month: january
structure:
  name: ""
  type: directory
  children:
    - name: correspondence
      type: directory
      children:
        - name: letter.pdf
          type: file
        - name: invoice_${month}.pdf
          type: file
```

run:
```
file-system-checker
```
you will get a result like that:
```
$ file-structure-checker

 /
     ✓ is existing
     ✓ is directory

     /correspondence
         ✓ is existing
         ✓ is directory

         /letter.pdf
             ✕ is existing
             ✕ is file

         /invoice_january.pdf
             ✕ is existing
             ✕ is file

result:
 ✓ 4 ✕ 4
```

# docker

```
docker run -it --rm -v $(pwd):/volume oliverlorenz/file-structure-checker
```

---
_Source: https://npm.io/package/file-structure-checker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._