Ocupop Linter Config @ocupop/eslint-config

Installs a lint package to be used within projects.

Getting Started

Install

npm

npm install @ocupop/eslint-config@latest --save-dev

yarn

yarn add --dev @ocupop/eslint-config@latest

Project Setup

Add .eslintrc file within the root of your project

module.exports = {
  extends: [
    "eslint:recommended",
    "@ocupop/eslint-config",
  ],
  parserOptions: {
    ecmaVersion: 12,
    sourceType: "module",
  },
  env: {
    browser: true,
    node: true,
    es6: true,
  },
  rules: {
    // You can add additional project-specific rules here
  },
};

Developing

To Link:

1. Run yarn link within this project
2. Navigate to the project where you want to test the package.
3. Link the globally symlinked package to your project by running:

yarn link @ocupop/eslint-config

5. Update your ESLint configuration file in the test project
   • See Setup instructions

To Unlink:

1. In your project directory, run:

yarn unlink @ocupop/eslint-config

2. In your package directory, run:

yarn unlink

Publishing

$ npm login <login with ocupop creds>
# [ ] Make sure to push changes to git first
# [ ] Make sure to bump the version number
$ npm publish