Shlink - JS coding standard

Coding standard used by Shlink JavaScript projects.

Oxlint

This library includes two Oxlint 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.
• /oxlint extends the above rules.

The default entry point includes both of them:

// oxlint.config.ts
import { oxlint as shlink } from '@shlinkio/eslint-config-js-coding-standard';
import { defineConfig } from 'oxlint';

export default defineConfig({
  extends: [shlink],
  rules: {
    // Other rules...
  },
});

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

// oxlint.config.ts
import baseConfig from '@shlinkio/eslint-config-js-coding-standard/base';
import { defineConfig } from 'oxlint';

export default defineConfig({
  extends: [baseConfig],
  rules: {
    // Other rules...
  },
});

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

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

export default defineConfig({
  extends: [reactConfig],
  rules: {
    // Other rules...
  },
});

Oxfmt

This library exposes a base configuration for Oxfmt

// oxfmt.config.ts
import { oxfmt as formatterConfig } from '@shlinkio/eslint-config-js-coding-standard';

export default formatterConfig;