@matrixai/lint 0.2.11 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/AGENTS.md +23 -0
  2. package/README.md +151 -83
  3. package/dist/bin/lint.js +119 -136
  4. package/dist/bin/lint.js.map +1 -1
  5. package/dist/config.d.ts +15 -0
  6. package/dist/config.js +120 -0
  7. package/dist/config.js.map +1 -0
  8. package/dist/configs/{js.d.ts → eslint.d.ts} +412 -29
  9. package/dist/configs/{js.js → eslint.js} +5 -4
  10. package/dist/configs/eslint.js.map +1 -0
  11. package/dist/configs/{prettier.config.mjs → prettier.config.js} +1 -1
  12. package/dist/configs/prettier.config.js.map +1 -0
  13. package/dist/domains/engine.d.ts +72 -0
  14. package/dist/domains/engine.js +160 -0
  15. package/dist/domains/engine.js.map +1 -0
  16. package/dist/domains/eslint.d.ts +3 -0
  17. package/dist/domains/eslint.js +72 -0
  18. package/dist/domains/eslint.js.map +1 -0
  19. package/dist/domains/files.d.ts +4 -0
  20. package/dist/domains/files.js +95 -0
  21. package/dist/domains/files.js.map +1 -0
  22. package/dist/domains/index.d.ts +14 -0
  23. package/dist/domains/index.js +83 -0
  24. package/dist/domains/index.js.map +1 -0
  25. package/dist/domains/markdown.d.ts +5 -0
  26. package/dist/domains/markdown.js +103 -0
  27. package/dist/domains/markdown.js.map +1 -0
  28. package/dist/domains/shell.d.ts +5 -0
  29. package/dist/domains/shell.js +58 -0
  30. package/dist/domains/shell.js.map +1 -0
  31. package/dist/index.d.ts +2 -0
  32. package/dist/index.js +2 -0
  33. package/dist/index.js.map +1 -0
  34. package/dist/tsbuildinfo +1 -0
  35. package/dist/types.d.ts +31 -8
  36. package/dist/utils.d.ts +13 -18
  37. package/dist/utils.js +207 -94
  38. package/dist/utils.js.map +1 -1
  39. package/package.json +25 -14
  40. package/dist/configs/js.js.map +0 -1
  41. package/dist/configs/prettier.config.mjs.map +0 -1
  42. package/flake.lock +0 -78
  43. package/jest.config.mjs +0 -84
  44. /package/dist/configs/{prettier.config.d.mts → prettier.config.d.ts} +0 -0
@@ -0,0 +1,15 @@
1
+ import type { MatrixAILintCfgSource, MatrixAILintCfgResolved, RawMatrixCfg } from './types.js';
2
+ declare const MATRIXAI_LINT_CONFIG_FILENAME = "matrixai-lint-config.json";
3
+ declare function normalizeLintConfig({ rawConfig, source, repoRoot, configFilePath, }: {
4
+ rawConfig: RawMatrixCfg;
5
+ source: MatrixAILintCfgSource;
6
+ repoRoot: string;
7
+ configFilePath: string;
8
+ }): MatrixAILintCfgResolved;
9
+ declare function parseLintConfig({ rawConfig, repoRoot, configFilePath, }: {
10
+ rawConfig: unknown;
11
+ repoRoot: string;
12
+ configFilePath: string;
13
+ }): MatrixAILintCfgResolved;
14
+ declare function resolveLintConfig(repoRoot?: string): MatrixAILintCfgResolved;
15
+ export { MATRIXAI_LINT_CONFIG_FILENAME, normalizeLintConfig, parseLintConfig, resolveLintConfig, };
package/dist/config.js ADDED
@@ -0,0 +1,120 @@
1
+ import fs from 'node:fs';
2
+ import path from 'node:path';
3
+ import process from 'node:process';
4
+ import ts from 'typescript';
5
+ const MATRIXAI_LINT_CONFIG_FILENAME = 'matrixai-lint-config.json';
6
+ function isRecord(value) {
7
+ return typeof value === 'object' && value !== null;
8
+ }
9
+ function toStringArray(value) {
10
+ if (typeof value === 'string') {
11
+ return [value];
12
+ }
13
+ if (Array.isArray(value)) {
14
+ return value.filter((item) => typeof item === 'string');
15
+ }
16
+ return [];
17
+ }
18
+ function stripLeadingDotSlash(value) {
19
+ return value.replace(/^\.\//, '');
20
+ }
21
+ function dedupeAndSort(values) {
22
+ return [...new Set(values)].sort();
23
+ }
24
+ function isReadableTsconfigPath(tsconfigPath) {
25
+ let stats;
26
+ try {
27
+ stats = fs.statSync(tsconfigPath);
28
+ }
29
+ catch {
30
+ return false;
31
+ }
32
+ if (!stats.isFile()) {
33
+ return false;
34
+ }
35
+ const readResult = ts.readConfigFile(tsconfigPath, ts.sys.readFile);
36
+ return readResult.error == null;
37
+ }
38
+ function sanitizeTsconfigPaths(rawValue, root) {
39
+ return dedupeAndSort(toStringArray(rawValue)
40
+ .map((tsconfigPath) => path.resolve(root, tsconfigPath))
41
+ .filter((tsconfigPath) => isReadableTsconfigPath(tsconfigPath)));
42
+ }
43
+ function sanitizeForceInclude(rawValue) {
44
+ return dedupeAndSort(toStringArray(rawValue)
45
+ .map((glob) => stripLeadingDotSlash(glob))
46
+ .filter((glob) => glob.length > 0));
47
+ }
48
+ function normalizeLintConfig({ rawConfig, source, repoRoot, configFilePath, }) {
49
+ const rawRoot = typeof rawConfig.root === 'string' && rawConfig.root.length > 0
50
+ ? rawConfig.root
51
+ : '.';
52
+ const resolvedRoot = path.resolve(repoRoot, rawRoot);
53
+ const rawDomains = isRecord(rawConfig.domains)
54
+ ? rawConfig.domains
55
+ : {};
56
+ const rawEslintDomain = isRecord(rawDomains.eslint)
57
+ ? rawDomains.eslint
58
+ : {};
59
+ let tsconfigPaths = sanitizeTsconfigPaths(rawEslintDomain.tsconfigPaths, resolvedRoot);
60
+ const forceInclude = sanitizeForceInclude(rawEslintDomain.forceInclude);
61
+ if (tsconfigPaths.length === 0) {
62
+ const rootTsconfigPath = path.join(resolvedRoot, 'tsconfig.json');
63
+ if (isReadableTsconfigPath(rootTsconfigPath)) {
64
+ tsconfigPaths.push(rootTsconfigPath);
65
+ }
66
+ }
67
+ tsconfigPaths = dedupeAndSort(tsconfigPaths);
68
+ return {
69
+ version: 2,
70
+ root: resolvedRoot,
71
+ source,
72
+ configFilePath,
73
+ domains: {
74
+ eslint: {
75
+ tsconfigPaths,
76
+ forceInclude,
77
+ },
78
+ },
79
+ };
80
+ }
81
+ function parseLintConfig({ rawConfig, repoRoot, configFilePath, }) {
82
+ if (!isRecord(rawConfig)) {
83
+ throw new Error('[matrixai-lint] ✖ matrixai-lint-config.json must contain a JSON object.');
84
+ }
85
+ if (rawConfig.version !== 2) {
86
+ throw new Error('[matrixai-lint] ✖ matrixai-lint-config.json must declare "version": 2.');
87
+ }
88
+ return normalizeLintConfig({
89
+ rawConfig: rawConfig,
90
+ source: 'config',
91
+ repoRoot,
92
+ configFilePath,
93
+ });
94
+ }
95
+ function resolveLintConfig(repoRoot = process.cwd()) {
96
+ const configFilePath = path.join(repoRoot, MATRIXAI_LINT_CONFIG_FILENAME);
97
+ if (!fs.existsSync(configFilePath)) {
98
+ return normalizeLintConfig({
99
+ rawConfig: { version: 2 },
100
+ source: 'default',
101
+ repoRoot,
102
+ configFilePath,
103
+ });
104
+ }
105
+ let rawConfig = {};
106
+ try {
107
+ const text = fs.readFileSync(configFilePath, 'utf8').trim();
108
+ rawConfig = text.length > 0 ? JSON.parse(text) : {};
109
+ }
110
+ catch (error) {
111
+ throw new Error(`[matrixai-lint] ✖ matrixai-lint-config.json has been provided but it is not valid JSON.\n ${String(error)}`);
112
+ }
113
+ return parseLintConfig({
114
+ rawConfig,
115
+ repoRoot,
116
+ configFilePath,
117
+ });
118
+ }
119
+ export { MATRIXAI_LINT_CONFIG_FILENAME, normalizeLintConfig, parseLintConfig, resolveLintConfig, };
120
+ //# sourceMappingURL=config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,MAAM,6BAA6B,GAAG,2BAA2B,CAAC;AAElE,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAO,CAAC,KAAK,CAAC,CAAC;KAChB;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;KACzE;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,aAAa,CAAC,MAAyB;IAC9C,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACrC,CAAC;AAED,SAAS,sBAAsB,CAAC,YAAoB;IAClD,IAAI,KAAe,CAAC;IACpB,IAAI;QACF,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;KACnC;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE;QACnB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,UAAU,GAAG,EAAE,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpE,OAAO,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC;AAClC,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAiB,EAAE,IAAY;IAC5D,OAAO,aAAa,CAClB,aAAa,CAAC,QAAQ,CAAC;SACpB,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SACvD,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,QAAiB;IAC7C,OAAO,aAAa,CAClB,aAAa,CAAC,QAAQ,CAAC;SACpB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;SACzC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CACrC,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,EAC3B,SAAS,EACT,MAAM,EACN,QAAQ,EACR,cAAc,GAMf;IACC,MAAM,OAAO,GACX,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAC7D,CAAC,CAAC,SAAS,CAAC,IAAI;QAChB,CAAC,CAAC,GAAG,CAAC;IACV,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAErD,MAAM,UAAU,GAA4B,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC;QACrE,CAAC,CAAC,SAAS,CAAC,OAAO;QACnB,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACjD,CAAC,CAAC,UAAU,CAAC,MAAM;QACnB,CAAC,CAAE,EAA8B,CAAC;IAEpC,IAAI,aAAa,GAAG,qBAAqB,CACvC,eAAe,CAAC,aAAa,EAC7B,YAAY,CACb,CAAC;IACF,MAAM,YAAY,GAAG,oBAAoB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAExE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAClE,IAAI,sBAAsB,CAAC,gBAAgB,CAAC,EAAE;YAC5C,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACtC;KACF;IAED,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;IAE7C,OAAO;QACL,OAAO,EAAE,CAAC;QACV,IAAI,EAAE,YAAY;QAClB,MAAM;QACN,cAAc;QACd,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,aAAa;gBACb,YAAY;aACb;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,EACvB,SAAS,EACT,QAAQ,EACR,cAAc,GAKf;IACC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;KACH;IAED,IAAI,SAAS,CAAC,OAAO,KAAK,CAAC,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;KACH;IAED,OAAO,mBAAmB,CAAC;QACzB,SAAS,EAAE,SAAyB;QACpC,MAAM,EAAE,QAAQ;QAChB,QAAQ;QACR,cAAc;KACf,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE;IACjD,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IAE1E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;QAClC,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE;YACzB,MAAM,EAAE,SAAS;YACjB,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;KACJ;IAED,IAAI,SAAS,GAAY,EAAE,CAAC;IAE5B,IAAI;QACF,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5D,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACrD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CACb,+FAA+F,MAAM,CAAC,KAAK,CAAC,EAAE,CAC/G,CAAC;KACH;IAED,OAAO,eAAe,CAAC;QACrB,SAAS;QACT,QAAQ;QACR,cAAc;KACf,CAAC,CAAC;AACL,CAAC;AAED,OAAO,EACL,6BAA6B,EAC7B,mBAAmB,EACnB,eAAe,EACf,iBAAiB,GAClB,CAAC"}