# nz-tslint-rules

> TSLint rules targeting NG-ZORRO

Latest version **0.901.2** (published 2020-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install nz-tslint-rules
pnpm add nz-tslint-rules
yarn add nz-tslint-rules
bun add nz-tslint-rules
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.901.2 |
| Published | 2020-05-15 |
| First published | 2019-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 48.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Hsuan Lee |
| Maintainers | hsuanlee |
| Keywords | lint, rules, tslint, NG-ZORRO |

## Links

- npm: https://www.npmjs.com/package/nz-tslint-rules
- Repository: https://github.com/hsuanxyz/nz-tslint-rules
- Homepage: https://github.com/hsuanxyz/nz-tslint-rules#readme
- Issues: https://github.com/hsuanxyz/nz-tslint-rules/issues
- npm.io page: https://npm.io/package/nz-tslint-rules

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.901.2 (latest) — 2020-05-15
- 0.901.1 — 2020-04-28
- 0.901.0 — 2020-04-28
- 0.900.1 — 2020-04-17
- 0.800.2 — 2019-12-05
- 0.800.1 — 2019-12-05
- 0.800.0 — 2019-12-05

## README

[![npm version](https://badge.fury.io/js/nz-tslint-rules.svg)](https://badge.fury.io/js/nz-tslint-rules)
[![Downloads](https://img.shields.io/npm/dt/nz-tslint-rules.svg)](https://img.shields.io/npm/dt/nz-tslint-rules.svg)

# NG-ZORRO TSLint

TSLint rules for NG-ZORRO.

# Install

```shell
$ npm i nz-tslint-rules -D
# or
$ yarn add nz-tslint-rules -D
```

## Versions

| NG-ZORRO | TSLint Rules |
| -------- | ------------ |
| 8.x | 0.800.x |
| 9.x | 0.900.x |

# Rules

This repository provides the following rules:

| Rule name | Configuration | Description |
| --------- | ------------- | ----------- |
| nz-secondary-entry-imports | none | Updates the import paths to secondary entry point |

## Migration to Secondary Entry

Using the current set of rules allows you to automatically migrate your project which uses primary entry to secondary entry.

```ts
// Before
import {
  NzAutocompleteModule,
  NzButtonModule,
  NzCardModule,
  NzTableModule,
  NzToolTipModule
} from 'ng-zorro-antd';

import { NzNoAnimationModule  } from 'ng-zorro-antd';

// After
import { NzAutocompleteModule } from 'ng-zorro-antd/auto-complete';
import { NzButtonModule } from 'ng-zorro-antd/button';
import { NzCardModule } from 'ng-zorro-antd/card';
import { NzTableModule } from 'ng-zorro-antd/table';
import { NzToolTipModule } from 'ng-zorro-antd/tooltip';
import { NzNoAnimationModule } from 'ng-zorro-antd/core/no-animation';
```

*Note:* This rule does not applicable if you use `import { NgZorroAntdModule } from 'ng-zorro-antd'`.

# Use

Add this rule set in your `tslint.json` file.

```json
{
  "rulesDirectory": [
    "node_modules/nz-tslint-rules"
  ],
  "rules": {
    "nz-secondary-entry-imports": true
  }
}
```

# License

MIT

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