Skip to main content

Installation & Setup

Examples are available at https://github.com/softarc-consulting/sheriff/tree/main/test-projects

In order to get the best developer experience, we recommend to use Sheriff with the ESLint plugin.

npm install -D @softarc/sheriff-core @softarc/eslint-plugin-sheriff

Flat Config (eslint.config.js)​

// ...
const sheriff = require('@softarc/eslint-plugin-sheriff');

module.exports = tseslint.config(
  // ...
  {
    files: ['**/*.ts'],
    extends: [sheriff.configs.all],
  },
);

Legacy Config (.eslintrc.json)​

{
  "files": ["*.ts"],
  "extends": ["plugin:@softarc/sheriff/legacy"]
}
note

Please note, that the legacy mode's name was changed from default to legacy in version 0.16.

Angular (CLI, Flat & @angular-eslint) Example
// @ts-check
const eslint = require('@eslint/js');
const tseslint = require('typescript-eslint');
const angular = require('angular-eslint');
const sheriff = require('@softarc/eslint-plugin-sheriff');

module.exports = tseslint.config(
  {
    files: ['**/*.ts'],
    extends: [
      eslint.configs.recommended,
      ...tseslint.configs.recommended,
      ...tseslint.configs.stylistic,
      ...angular.configs.tsRecommended,
    ],
    processor: angular.processInlineTemplates,
    rules: {
      '@angular-eslint/directive-selector': [
        'error',
        {
          type: 'attribute',
          prefix: 'eternal',
          style: 'camelCase',
        },
      ],
      '@angular-eslint/component-selector': [
        'error',
        {
          type: 'element',
          prefix: 'eternal',
          style: 'kebab-case',
        },
      ],
    },
  },
  {
    files: ['**/*.html'],
    extends: [
      ...angular.configs.templateRecommended,
      ...angular.configs.templateAccessibility,
    ],
    rules: {},
  },
  {
    files: ['**/*.ts'],
    extends: [sheriff.configs.all],
  },
);

Angular (CLI, Legacy & @angular-eslint) Example
{
  "root": true,
  "ignorePatterns": ["projects/**/*"],
  "overrides": [
    {
      "files": ["*.ts"],
      "extends": [
        "eslint:recommended",
        "plugin:@typescript-eslint/recommended",
        "plugin:@angular-eslint/recommended",
        "plugin:@angular-eslint/template/process-inline-templates"
      ],
      "rules": {
        "@angular-eslint/directive-selector": [
          "error",
          {
            "type": "attribute",
            "prefix": "eternal",
            "style": "camelCase"
          }
        ],
        "@angular-eslint/component-selector": [
          "error",
          {
            "type": "element",
            "prefix": "eternal",
            "style": "kebab-case"
          }
        ]
      }
    },
    {
      "files": ["*.html"],
      "extends": ["plugin:@angular-eslint/template/recommended"],
      "rules": {}
    },
    {
      "files": ["*.ts"],
      "extends": ["plugin:@softarc/sheriff/legacy"]
    }
  ]
}

Angular (NX) Example
{
  "root": true,
  "ignorePatterns": ["**/*"],
  "plugins": ["@nrwl/nx"],
  "overrides": [
    // existing rules...
    {
      "files": ["*.ts"],
      "extends": ["plugin:@softarc/sheriff/legacy"],
    },
  ],
}

Sheriff without ESLint​

You can also use Sheriff without ESLint. In this case, you have to run the Sheriff CLI manually.

npm install -D @softarc/sheriff-core

The CLI provides you with commands to list modules, check the rules and export the dependency graph in JSON format.

For more details, see the CLI.