eslint-plugin-boundaries TypeScript configuration example

This repository contains an example of the eslint plugin eslint-plugin-boundaries usage with TypeScript, including custom TS paths.

The documentation of the plugin itself contains TypeScript configuration instructions.

Installation

git clone [email protected]:javierbrea/epb-ts-example.git
cd epb-ts-example
npm i

Eslint execution

Note that the lint execution will return an error, but it is intentional, as the src/modules/module-b element contains a forbidden import in order to check that the plugin works properly.

npm run lint

# 1:21  error  Usage of 'modules' is not allowed in 'modules'  boundaries/element-types

Tests

Some tests have been added to check that both TypeScript compilation and eslint execution work as expected.

npm run build
npm run test