Skip to content

Commit

Permalink
refactor: mark naming convention config as experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthias Hecht committed Jan 17, 2025
1 parent 1e79f8a commit 99bb957
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,15 +176,15 @@ This shared ESLint configuration is designed to enforce best practices and recom
- [`playwright/prefer-to-have-length`](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-have-length.md): enforces the use of `.toHaveLength()` instead of `.toEqual(n)` when testing the length of an object.
- [`playwright/require-top-level-describe`](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/require-top-level-describe.md): requires tests to be organized into top-level `describe()` blocks.

### Naming Convention
### (experimental) Naming Convention

```js
import boehringer from '@boehringer-ingelheim/eslint-config';

export default boehringer.config(
boehringer.configs.strict,
// possibly other configs,
boehringer.configs.namingConvention
boehringer.configs.experimentalNamingConvention
);
```

Expand Down
File renamed without changes.
10 changes: 9 additions & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
import { Config } from 'typescript-eslint';

type Configs = 'base' | 'local' | 'nextjs' | 'playwright' | 'prettierDisable' | 'react' | 'strict';
type Configs =
| 'base'
| 'experimentalNamingConvention'
| 'local'
| 'nextjs'
| 'playwright'
| 'prettierDisable'
| 'react'
| 'strict';

declare module './index' {
const config: typeof import('typescript-eslint').config;
Expand Down
4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
const tseslint = require('typescript-eslint');

const base = require('./configs/base.js');
const experimentalNamingConvention = require('./configs/experimental-naming-convention.js');
const local = require('./configs/local.js');
const namingConvention = require('./configs/naming-convention.js');
const nextjs = require('./configs/nextjs.js');
const playwright = require('./configs/playwright.js');
const prettierDisable = require('./configs/prettier-disable.js');
Expand All @@ -13,8 +13,8 @@ module.exports = {
config: tseslint.config,
configs: {
base,
experimentalNamingConvention,
local,
namingConvention,
nextjs,
playwright,
prettierDisable,
Expand Down

0 comments on commit 99bb957

Please sign in to comment.