eslint-bitrix24

ESLint and oxlint shareable configs and plugins for the Bitrix24 JavaScript style guide.

Requires ESLint 9 (flat config). For ESLint 8, use v1.x of the config packages.

Packages

Package	Description
@bitrix24/eslint-config-bitrix24	Shareable ESLint config for Bitrix24 web projects
@bitrix24/eslint-config-bitrix24-mobile	Shareable ESLint config for Bitrix24 mobile (JN) projects
@bitrix24/eslint-plugin-bitrix24-rules	Custom ESLint rules for Bitrix24
@bitrix24/eslint-plugin-bitrix24-janative	Custom ESLint rules for Bitrix24 JaNative
@bitrix24/oxlint-config-bitrix24	Shareable oxlint config for Bitrix24 web projects
@bitrix24/oxlint-config-bitrix24-mobile	Shareable oxlint config for Bitrix24 mobile (JN) projects

The plugins work under both ESLint and oxlint (as JS plugins).

Quick Start

npm install --save-dev eslint @bitrix24/eslint-config-bitrix24

eslint.config.js:

import bitrix24 from '@bitrix24/eslint-config-bitrix24';

export default [
    { ignores: ['**/dist/', '**/*.bundle.js'] },
    ...bitrix24,
];

With mobile support:

npm install --save-dev @bitrix24/eslint-config-bitrix24-mobile

import bitrix24 from '@bitrix24/eslint-config-bitrix24';
import bitrix24Mobile from '@bitrix24/eslint-config-bitrix24-mobile';

export default [
    { ignores: ['**/dist/', '**/*.bundle.js'] },
    ...bitrix24,
    ...bitrix24Mobile,
];

oxlint

npm install --save-dev oxlint@1.87.0 @bitrix24/oxlint-config-bitrix24 @bitrix24/oxlint-config-bitrix24-mobile

oxlint.config.ts:

import bitrix24 from '@bitrix24/oxlint-config-bitrix24';
import bitrix24Mobile from '@bitrix24/oxlint-config-bitrix24-mobile';

export default {
    extends: [bitrix24, bitrix24Mobile],
    ignorePatterns: ['**/dist/', '**/*.bundle.js'],
};

See individual package READMEs for granular exports and customization options.

Publishing

Packages are published by the Publish Package to npm workflow, one at a time: the plugins first, then the configs. A new package (oxlint-config-*) has to be published once by hand before trusted publishing can be configured for it on npmjs.com.

License

MIT