Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

eslint-plugin-monorepo-cop

sterlingwes97.8kMIT1.0.2

Rules to enforce good monorepo behaviours

eslint, eslintplugin, eslint-plugin, monorepo, yarn, workspaces, lerna, relative, package

readme

eslint-plugin-monorepo-cop

Rules to enforce good monorepo behaviours (mainly, no relative imports from other packages).

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-monorepo-cop:

$ npm install eslint-plugin-monorepo-cop --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-monorepo-cop globally.

Usage

Add monorepo-cop to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["monorepo-cop"]
}

Then use our recommended ruleset:

{
    "extends": {
        "plugin:monorepo-cop/recommended"
    }
}

Supported Rules