• Installation
• Usage
• Publishing

This library has a required peerDependencies for eslint

Follow the Github Packages setup instructions.

$ npm install --save-dev @arcadiapower/eslint-config

Follow the Gemfury setup instructions.

$ npm intsall --save-dev eslint-config-arcadia

Extend your .eslintrc.js:

module.exports = {
  extends: '@arcadiapower', // For Gemfury installations, use "arcadia"
  rules: {
    // your overrides
  },
};

This config also exposes a React-specific config, which is intended for apps that use React.

module.exports = {
  extends: '@arcadiapower/eslint-config/react', // For Gemfury installations, use "arcadia/react"
};

Note: Due to this bug you need to have associated plugins installed to make things work. Add them as dependencies to your project:

• react: React JS library eslint-plugin-react for rules regarding React (needed in the react config)
• jsx-a11y: eslint-plugin-jsx-a11y for rules regarding accessibility with JSX (needed in the react config)
• @typescript-eslint: @typescript-eslint/parser and @typescript-eslint/eslint-plugin (needed for projects written in TypeScript)

Author your changes, update the CHANGELOG.md with a brief description of the release, and merge your changes into main. Our GitHub Packages Workflow will automatically publish your build and trigger a release notification.

Occasionally you may need to bugfix an old version - for example, the latest version is v3.0.0, but you need to publish a fix for v2.1.0. In that case:

1. Checkout the tag version you'd like to change:

$ git checkout v2.1.0
$ git switch -c bugfix/fix-something-broken

2. Author your changes. Push up your branch.
3. Run the publish workflow manually on the branch with your fix.

1. In your pull request, bump the version.
2. After merging, pull master and run npm pack
3. Upload the resulting package on the Gemfury dashboard.