tslint-no-circular-imports/README.md

TSLint plugin to detect and warn about circular imports

# tslint-no-circular-imports [![Build Status][build]](https://circleci.com/gh/bcherny/tslint-no-circular-imports) [![npm]](https://www.npmjs.com/package/tslint-no-circular-imports) [![mit]](https://opensource.org/licenses/MIT)

[build]: https://img.shields.io/circleci/project/bcherny/tslint-no-circular-imports.svg?branch=master&style=flat-square
[npm]: https://img.shields.io/npm/v/tslint-no-circular-imports.svg?style=flat-square
[mit]: https://img.shields.io/npm/l/tslint-no-circular-imports.svg?style=flat-square

> [TSLint](https://palantir.github.io/tslint/) plugin to detect and warn about circular imports

## Installation

```sh
# Using Yarn:
yarn add --dev tslint-no-circular-imports

# Or, using NPM:
npm install --save-dev tslint-no-circular-imports
```

## Usage

Add the following to your tslint.json:

```json
{
  "extends": ["tslint-no-circular-imports"]
}
```

Run TSLint:

```sh
$ tslint .
Circular import detected: foo.ts -> bar.ts -> foo.ts
Circular import detected: baz.ts -> bar.ts -> baz.ts
```

## Running the tests

```sh
npm test
```

## License

MIT