nata-cli v0.0.7

Nata-cli

Architecture test automation

Table of Contents

• Getting Started
• Configuration
  • Rules
• License

Getting Started

Install Nata-cli using npm:

npm install --save-dev nata-cli

Add the following section to your package.json:

{
  "scripts": {
    "test:arch": "nata-cli ."
  }
}

Before running you must create the configuration file nata.config.json:

{
  "rules": []
}

Finally, run npm run test:arch and Nata-cli will print this message:

Results:   0 failed, 0 skipped, 0 passed, 0 total.
Exec time: 00:00:00.001

Configuration

Rules

1. Verify that files in a directory follow specified patterns:

{
  "name": "filename-pattern-in-folder",
  "patterns": ["*.ts"],
  "folder": "source/services"
}

To skip a rule use the skip field:

{
    "name": "filename-pattern-in-folder",
    "patterns": ["*.ts"],
    "folder": "source/services"
    "skip": true,
}

License

Nata-cli is MIT licensed.