JSPM – ng-alain-codelyzer@0.0.1

Package Exports

ng-alain-codelyzer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ng-alain-codelyzer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ng-alain-codelyzer

A set of tslint rules for static code analysis of ng-alain projects.

How to use?

Install ng-alain-codelyzer:

# via npm
npm i ng-alain-codelyzer --save-dev
# via yarn
yarn add -D ng-alain-codelyzer

Using ng-alain-codelyzer from node_modules directory:

{
  "rulesDirectory": [
    "node_modules/ng-alain-codelyzer"
  ],
  "rules": {
    "use-path-mapping": [true, ["@core", "@shared"]]
  }
}

Next you can create a component file in the src/app/routes directory with name component.ts and the following content:

import { I18NService } from '../core/i18n/i18n.service';

As last step you can execute all the rules against your code with tslint:

./node_modules/.bin/tslint -c tslint.json src/app/routes/component.ts

You should see the following output:

ERROR: src/app/routes/component.ts[1, 30]: Should be imported using `@core`

Subdirectories

If you want to support subdirectory import styles:

import { I18NService } from '@core/i18n/i18n.service';

Configured as:

{
  "use-path-mapping": [true, ["@core/*", "@shared"]]
}

License

MIT