Skip to content

Commit ed540cf

Browse files
CDeltakaiCDeltakai
committed
wip: replacing config bundle with config from zeta.house, removing parserOptions from config and creating new typeaware specific recommended configs
1 parent d25a039 commit ed540cf

File tree

3 files changed

+168
-195
lines changed

3 files changed

+168
-195
lines changed

‎src/configs/matrixai-config-bundle.js

+141-195
Original file line numberDiff line numberDiff line change
@@ -1,209 +1,155 @@
1-
import { FlatCompat } from '@eslint/eslintrc';
2-
import { fixupConfigRules, fixupPluginRules } from '@eslint/compat';
3-
import tsParser from '@typescript-eslint/parser';
4-
import js from '@eslint/js';
5-
import globals from 'globals';
6-
import _import from 'eslint-plugin-import';
7-
import { fileURLToPath } from 'url';
8-
import path from 'path';
1+
import _import from "eslint-plugin-import";
2+
import { fixupPluginRules } from "@eslint/compat";
3+
import globals from "globals";
4+
import tsParser from "@typescript-eslint/parser";
5+
import path from "node:path";
6+
import { fileURLToPath } from "node:url";
7+
import js from "@eslint/js";
8+
import { FlatCompat } from "@eslint/eslintrc";
99
import _matrixLint from '../index.js';
1010

11-
// eslint-disable-next-line @typescript-eslint/naming-convention
1211
const __filename = fileURLToPath(import.meta.url);
13-
// eslint-disable-next-line @typescript-eslint/naming-convention
1412
const __dirname = path.dirname(__filename);
1513
const compat = new FlatCompat({
1614
baseDirectory: __dirname,
1715
recommendedConfig: js.configs.recommended,
18-
allConfig: js.configs.all,
16+
allConfig: js.configs.all
1917
});
2018

21-
export default [
22-
...fixupConfigRules(
23-
compat.extends(
24-
'eslint:recommended',
25-
'plugin:@typescript-eslint/recommended',
26-
'plugin:prettier/recommended',
27-
),
28-
),
29-
_matrixLint.configs.recommended,
30-
{
31-
plugins: {
32-
import: fixupPluginRules(_import),
19+
export default [...compat.extends(
20+
"eslint:recommended",
21+
"plugin:@typescript-eslint/recommended",
22+
"plugin:prettier/recommended",
23+
), {
24+
plugins: {
25+
import: fixupPluginRules(_import),
26+
},
27+
languageOptions: {
28+
globals: {
29+
...globals.browser,
30+
...globals.commonjs,
31+
...globals.node,
32+
...globals.jest,
3333
},
34-
35-
languageOptions: {
36-
globals: {
37-
...globals.browser,
38-
...globals.commonjs,
39-
...globals.node,
40-
...globals.jest,
34+
parser: tsParser,
35+
ecmaVersion: 5,
36+
sourceType: "module",
37+
// parserOptions.project intentionally omitted to avoid breaking consumer repos,
38+
// Type-aware linting should be configured explicitly in the consumer config.
39+
// parserOptions: {
40+
// project: ['./tsconfig.json', './src/app/tsconfig.json'],
41+
// },
42+
},
43+
rules: {
44+
"linebreak-style": ["error", "unix"],
45+
"no-empty": 1,
46+
"no-useless-catch": 1,
47+
"no-prototype-builtins": 1,
48+
"no-constant-condition": 0,
49+
"no-useless-escape": 0,
50+
"no-console": "error",
51+
"no-restricted-globals": ["error", {
52+
name: "global",
53+
message: "Use `globalThis` instead",
54+
}, {
55+
name: "window",
56+
message: "Use `globalThis` instead",
57+
}],
58+
"prefer-rest-params": 0,
59+
"require-yield": 0,
60+
eqeqeq: ["error", "smart"],
61+
"spaced-comment": ["warn", "always", {
62+
line: {
63+
exceptions: ["-"],
4164
},
42-
43-
parser: tsParser,
44-
ecmaVersion: 5,
45-
sourceType: 'module',
46-
47-
parserOptions: {
48-
project: ['./tsconfig.json', './src/app/tsconfig.json'],
65+
block: {
66+
exceptions: ["*"],
4967
},
50-
},
51-
52-
rules: {
53-
'linebreak-style': ['error', 'unix'],
54-
'no-empty': 1,
55-
'no-useless-catch': 1,
56-
'no-prototype-builtins': 1,
57-
'no-constant-condition': 0,
58-
'no-useless-escape': 0,
59-
'no-console': 'error',
60-
'no-restricted-globals': [
61-
'error',
62-
{
63-
name: 'global',
64-
message: 'Use `globalThis` instead',
65-
},
66-
{
67-
name: 'window',
68-
message: 'Use `globalThis` instead',
69-
},
70-
],
71-
'require-yield': 0,
72-
eqeqeq: ['error', 'smart'],
73-
'spaced-comment': [
74-
'warn',
75-
'always',
76-
{
77-
line: {
78-
exceptions: ['-'],
79-
},
80-
block: {
81-
exceptions: ['*'],
82-
},
83-
markers: ['/'],
84-
},
68+
markers: ["/"],
69+
}],
70+
"capitalized-comments": ["warn", "always", {
71+
ignoreInlineComments: true,
72+
ignoreConsecutiveComments: true,
73+
}],
74+
curly: ["error", "multi-line", "consistent"],
75+
"import/order": ["error", {
76+
groups: [
77+
"type",
78+
"builtin",
79+
"external",
80+
"internal",
81+
"index",
82+
"sibling",
83+
"parent",
84+
"object",
8585
],
86-
'capitalized-comments': [
87-
'warn',
88-
'always',
89-
{
90-
ignoreInlineComments: true,
91-
ignoreConsecutiveComments: true,
92-
},
93-
],
94-
curly: ['error', 'multi-line', 'consistent'],
95-
'import/order': [
96-
'error',
97-
{
98-
groups: [
99-
'type',
100-
'builtin',
101-
'external',
102-
'internal',
103-
'index',
104-
'sibling',
105-
'parent',
106-
'object',
107-
],
108-
pathGroups: [
109-
{
110-
pattern: '@',
111-
group: 'internal',
112-
},
113-
{
114-
pattern: '@/**',
115-
group: 'internal',
116-
},
117-
],
118-
pathGroupsExcludedImportTypes: ['type'],
119-
'newlines-between': 'never',
120-
},
121-
],
122-
'@typescript-eslint/no-namespace': 0,
123-
'@typescript-eslint/no-explicit-any': 0,
124-
'@typescript-eslint/explicit-module-boundary-types': 0,
125-
'@typescript-eslint/no-unused-vars': [
126-
'warn',
127-
{
128-
varsIgnorePattern: '^_',
129-
argsIgnorePattern: '^_',
130-
},
131-
],
132-
'@typescript-eslint/no-inferrable-types': 0,
133-
'@typescript-eslint/no-non-null-assertion': 0,
134-
'@typescript-eslint/no-this-alias': 0,
135-
'@typescript-eslint/no-var-requires': 0,
136-
'@typescript-eslint/no-empty-function': 0,
137-
'@typescript-eslint/no-empty-interface': 0,
138-
'@typescript-eslint/consistent-type-imports': ['error'],
139-
'@typescript-eslint/consistent-type-exports': ['error'],
140-
'no-throw-literal': 'off',
141-
'@typescript-eslint/no-throw-literal': 'off',
142-
'@typescript-eslint/no-floating-promises': [
143-
'error',
144-
{
145-
ignoreVoid: true,
146-
ignoreIIFE: true,
147-
},
148-
],
149-
'@typescript-eslint/no-misused-promises': [
150-
'error',
151-
{
152-
checksVoidReturn: false,
153-
},
154-
],
155-
'@typescript-eslint/await-thenable': ['error'],
156-
'@typescript-eslint/naming-convention': [
157-
'error',
158-
{
159-
selector: 'default',
160-
format: ['camelCase'],
161-
leadingUnderscore: 'allow',
162-
trailingUnderscore: 'allowSingleOrDouble',
163-
},
164-
{ selector: 'import', format: ['camelCase', 'PascalCase'] },
165-
{
166-
selector: 'function',
167-
format: ['camelCase', 'PascalCase'],
168-
leadingUnderscore: 'allow',
169-
trailingUnderscore: 'allowSingleOrDouble',
170-
},
171-
{
172-
selector: 'variable',
173-
format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
174-
leadingUnderscore: 'allow',
175-
trailingUnderscore: 'allowSingleOrDouble',
176-
},
177-
{
178-
selector: 'parameter',
179-
format: ['camelCase'],
180-
leadingUnderscore: 'allow',
181-
trailingUnderscore: 'allowSingleOrDouble',
182-
},
183-
{
184-
selector: 'typeLike',
185-
format: ['PascalCase'],
186-
trailingUnderscore: 'allowSingleOrDouble',
187-
},
188-
{
189-
selector: 'enumMember',
190-
format: ['PascalCase', 'UPPER_CASE'],
191-
},
192-
{
193-
selector: 'objectLiteralProperty',
194-
format: null,
195-
},
196-
{
197-
selector: 'typeProperty',
198-
format: null,
199-
},
200-
],
201-
'@typescript-eslint/ban-ts-comment': [
202-
'error',
203-
{
204-
'ts-ignore': 'allow-with-description',
205-
},
206-
],
207-
},
86+
pathGroups: [{
87+
pattern: "@",
88+
group: "internal",
89+
}, {
90+
pattern: "@/**",
91+
group: "internal",
92+
}],
93+
pathGroupsExcludedImportTypes: ["type"],
94+
"newlines-between": "never",
95+
}],
96+
"@typescript-eslint/no-require-imports": 0,
97+
"@typescript-eslint/no-namespace": 0,
98+
"@typescript-eslint/no-explicit-any": 0,
99+
"@typescript-eslint/explicit-module-boundary-types": 0,
100+
"@typescript-eslint/no-unused-vars": ["warn", {
101+
varsIgnorePattern: "^_",
102+
argsIgnorePattern: "^_",
103+
}],
104+
"@typescript-eslint/no-inferrable-types": 0,
105+
"@typescript-eslint/no-non-null-assertion": 0,
106+
"@typescript-eslint/no-this-alias": 0,
107+
"@typescript-eslint/no-var-requires": 0,
108+
"@typescript-eslint/no-empty-function": 0,
109+
"@typescript-eslint/no-empty-interface": 0,
110+
"@typescript-eslint/consistent-type-imports": ["error"],
111+
"@typescript-eslint/consistent-type-exports": ["error"],
112+
"no-throw-literal": "off",
113+
"@typescript-eslint/no-throw-literal": "off",
114+
// "@typescript-eslint/no-floating-promises": ["error", {
115+
// ignoreVoid: true,
116+
// ignoreIIFE: true,
117+
// }],
118+
// "@typescript-eslint/no-misused-promises": ["error", {
119+
// checksVoidReturn: false,
120+
// }],
121+
// "@typescript-eslint/await-thenable": ["error"],
122+
"@typescript-eslint/naming-convention": ["error", {
123+
selector: "function",
124+
format: ["camelCase", "PascalCase"],
125+
leadingUnderscore: "allow",
126+
trailingUnderscore: "allowSingleOrDouble",
127+
}, {
128+
selector: "variable",
129+
format: ["camelCase", "UPPER_CASE", "PascalCase"],
130+
leadingUnderscore: "allow",
131+
trailingUnderscore: "allowSingleOrDouble",
132+
}, {
133+
selector: "parameter",
134+
format: ["camelCase"],
135+
leadingUnderscore: "allow",
136+
trailingUnderscore: "allowSingleOrDouble",
137+
}, {
138+
selector: "typeLike",
139+
format: ["PascalCase"],
140+
trailingUnderscore: "allowSingleOrDouble",
141+
}, {
142+
selector: "enumMember",
143+
format: ["PascalCase", "UPPER_CASE"],
144+
}, {
145+
selector: "objectLiteralProperty",
146+
format: null,
147+
}, {
148+
selector: "typeProperty",
149+
format: null,
150+
}],
151+
"@typescript-eslint/ban-ts-comment": ["error", {
152+
"ts-ignore": "allow-with-description",
153+
}],
208154
},
209-
];
155+
}];

‎src/configs/recommendedTypeaware.ts

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
export const recommendedTypeaware = {
2+
plugins: {},
3+
languageOptions: {
4+
parserOptions: {
5+
// Consumers must override this path to match their tsconfig structure
6+
project: ['./tsconfig.json'],
7+
},
8+
},
9+
rules: {
10+
'@typescript-eslint/no-floating-promises': ['error', {
11+
ignoreVoid: true,
12+
ignoreIIFE: true,
13+
}],
14+
'@typescript-eslint/no-misused-promises': ['error', {
15+
checksVoidReturn: false,
16+
}],
17+
'@typescript-eslint/await-thenable': ['error'],
18+
},
19+
};

‎src/index.ts

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
import noAliasedImportsRule from './rules/no-aliased-imports.js';
22
import { recommended } from './configs/recommended.js';
3+
import { recommendedTypeaware } from './configs/recommendedTypeaware.js';
4+
import typescriptEslint from '@typescript-eslint/eslint-plugin'
35

46
const matrixaiPlugin = {
57
meta: {
@@ -11,6 +13,7 @@ const matrixaiPlugin = {
1113
},
1214
configs: {
1315
recommended: recommended,
16+
recommendedTypeaware: recommendedTypeaware,
1417
},
1518
};
1619

@@ -20,4 +23,9 @@ Object.assign(recommended.plugins, {
2023
'@matrixai': matrixaiPlugin,
2124
});
2225

26+
Object.assign(recommendedTypeaware.plugins, {
27+
'@typescript-eslint': typescriptEslint,
28+
});
29+
30+
2331
export default matrixaiPlugin;

0 commit comments

Comments
 (0)