Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 1.67 KB

README.md

File metadata and controls

55 lines (42 loc) · 1.67 KB

Shlink - JS coding standard

npm npm downloads GitHub license Paypal Donate

Coding standard used by Shlink JavaScript projects.

This library includes two ESLint configurations on their own entry points:

  • /base: includes recommended eslint, typescript and imports rules
  • /react includes recommended JSX accessibility, react, react hooks and react compiler rules.

The default entry point includes both of them:

// eslint.config.js
import shlink from '@shlinkio/eslint-config-js-coding-standard';

export default [
  ...shlink,
  {
    // Other rules...
  }
];

If the project does not use React, you can just use the base config:

// eslint.config.js
import baseConfig from '@shlinkio/eslint-config-js-coding-standard/base';

export default [
  ...baseConfig,
  {
    // Other rules...
  }
];

If you need to access react rules independently, use the /react entry point:

// eslint.config.js
import reactConfig from '@shlinkio/eslint-config-js-coding-standard/react';

export default [
  ...reactConfig,
  {
    // Other rules...
  }
];