@pragmatiks/lint 0.2.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.
package/CHANGELOG.md ADDED
@@ -0,0 +1,15 @@
1
+ # Changelog
2
+
3
+ ## js-v0.2.0 (2026-05-10)
4
+
5
+ ### Misc
6
+
7
+ - chore(js): align npm baseline to 0.2.0 to match PyPI v0.2.0
8
+
9
+ ## 0.1.0 - 2026-05-10
10
+
11
+ - Scaffolded the unified `pragma-lint` mono-repo.
12
+ - Added shared semgrep rules in `rules/`.
13
+ - Added library-only Python package `pragmatiks-lint`.
14
+ - Added library-only npm package `@pragmatiks/lint`.
15
+ - Added build-time rule vendoring for both package artifacts.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Pragmatiks
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,9 @@
1
+ # @pragmatiks/lint
2
+
3
+ Library-only eslint flat config and bundled semgrep rules for Pragmatiks engineering principles.
4
+
5
+ ```ts
6
+ import { PRAGMATIKS_LINT_FILES, pragmatiksConfig } from "@pragmatiks/lint";
7
+ ```
8
+
9
+ This package has no `bin` entry. Command-line integration belongs in `pragma-cli`.
@@ -0,0 +1,8 @@
1
+ import { Config } from 'eslint/config';
2
+
3
+ declare const PRAGMATIKS_LINT_FILES: string[];
4
+ declare function findPackageRoot(start: string): string;
5
+ declare function semgrepRulesDirectory(): string;
6
+ declare function pragmatiksConfig(): Config[];
7
+
8
+ export { PRAGMATIKS_LINT_FILES, pragmatiksConfig as default, findPackageRoot, pragmatiksConfig, semgrepRulesDirectory };
@@ -0,0 +1,116 @@
1
+ import { existsSync } from 'fs';
2
+ import path from 'path';
3
+ import { fileURLToPath } from 'url';
4
+ import { defineConfig, globalIgnores } from 'eslint/config';
5
+ import sonarjs from 'eslint-plugin-sonarjs';
6
+ import unicorn from 'eslint-plugin-unicorn';
7
+ import tseslint from 'typescript-eslint';
8
+
9
+ // src/eslint-config/index.ts
10
+
11
+ // src/eslint-config/options.ts
12
+ var COMPLEXITY_OPTS = 10;
13
+ var MAX_LINES_PER_FUNCTION_OPTS = {
14
+ max: 50,
15
+ skipBlankLines: true,
16
+ skipComments: true
17
+ };
18
+ var MAX_STATEMENTS_OPTS = 15;
19
+ var MAX_DEPTH_OPTS = 4;
20
+ var MAX_PARAMS_OPTS = 4;
21
+ var PREVENT_ABBREVIATIONS_OPTS = {
22
+ allowList: {
23
+ id: true,
24
+ url: true,
25
+ uri: true,
26
+ api: true,
27
+ cli: true,
28
+ sdk: true,
29
+ os: true,
30
+ io: true,
31
+ ip: true,
32
+ tls: true,
33
+ ssl: true,
34
+ jwt: true,
35
+ json: true,
36
+ yaml: true,
37
+ html: true,
38
+ css: true,
39
+ dom: true,
40
+ ast: true,
41
+ gpu: true,
42
+ cpu: true,
43
+ ram: true,
44
+ vm: true,
45
+ props: true,
46
+ ref: true,
47
+ e: true
48
+ }
49
+ };
50
+
51
+ // src/eslint-config/index.ts
52
+ var PRAGMATIKS_LINT_FILES = ["**/*.{ts,tsx,mts,cts,js,mjs,cjs}"];
53
+ function findPackageRoot(start) {
54
+ let current = start;
55
+ for (; ; ) {
56
+ if (existsSync(path.join(current, "package.json"))) {
57
+ return current;
58
+ }
59
+ const parent = path.dirname(current);
60
+ if (parent === current) {
61
+ throw new Error(`package.json not found above ${start}`);
62
+ }
63
+ current = parent;
64
+ }
65
+ }
66
+ function semgrepRulesDirectory() {
67
+ const here = path.dirname(fileURLToPath(import.meta.url));
68
+ return path.join(findPackageRoot(here), "src", "semgrep-rules");
69
+ }
70
+ function recommendedOrThrow(plugin, name) {
71
+ const recommended = plugin.configs?.recommended;
72
+ if (!recommended) {
73
+ throw new Error(
74
+ `${name} has no recommended flat-config preset. Peer dependency major mismatch.`
75
+ );
76
+ }
77
+ return recommended;
78
+ }
79
+ function pragmatiksConfig() {
80
+ return defineConfig([
81
+ {
82
+ files: PRAGMATIKS_LINT_FILES,
83
+ languageOptions: {
84
+ parser: tseslint.parser,
85
+ parserOptions: {
86
+ ecmaVersion: "latest",
87
+ sourceType: "module"
88
+ }
89
+ },
90
+ settings: {
91
+ pragmatiksLint: {
92
+ semgrepRulesDirectory: semgrepRulesDirectory()
93
+ }
94
+ }
95
+ },
96
+ recommendedOrThrow(sonarjs, "eslint-plugin-sonarjs"),
97
+ recommendedOrThrow(unicorn, "eslint-plugin-unicorn"),
98
+ {
99
+ files: PRAGMATIKS_LINT_FILES,
100
+ rules: {
101
+ complexity: ["error", COMPLEXITY_OPTS],
102
+ "max-lines-per-function": ["error", MAX_LINES_PER_FUNCTION_OPTS],
103
+ "max-statements": ["error", MAX_STATEMENTS_OPTS],
104
+ "max-depth": ["error", MAX_DEPTH_OPTS],
105
+ "max-params": ["error", MAX_PARAMS_OPTS],
106
+ "unicorn/prevent-abbreviations": ["error", PREVENT_ABBREVIATIONS_OPTS]
107
+ }
108
+ },
109
+ globalIgnores(["dist/**", "node_modules/**", ".next/**", ".turbo/**"])
110
+ ]);
111
+ }
112
+ var eslint_config_default = pragmatiksConfig;
113
+
114
+ export { PRAGMATIKS_LINT_FILES, eslint_config_default as default, findPackageRoot, pragmatiksConfig, semgrepRulesDirectory };
115
+ //# sourceMappingURL=index.js.map
116
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/eslint-config/options.ts","../../src/eslint-config/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAAO,IAAM,eAAA,GAAkB,EAAA;AAExB,IAAM,2BAAA,GAA8B;AAAA,EACzC,GAAA,EAAK,EAAA;AAAA,EACL,cAAA,EAAgB,IAAA;AAAA,EAChB,YAAA,EAAc;AAChB,CAAA;AAEO,IAAM,mBAAA,GAAsB,EAAA;AAE5B,IAAM,cAAA,GAAiB,CAAA;AAEvB,IAAM,eAAA,GAAkB,CAAA;AAExB,IAAM,0BAAA,GAA6B;AAAA,EACxC,SAAA,EAAW;AAAA,IACT,EAAA,EAAI,IAAA;AAAA,IACJ,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,EAAA,EAAI,IAAA;AAAA,IACJ,EAAA,EAAI,IAAA;AAAA,IACJ,EAAA,EAAI,IAAA;AAAA,IACJ,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,IAAA,EAAM,IAAA;AAAA,IACN,IAAA,EAAM,IAAA;AAAA,IACN,IAAA,EAAM,IAAA;AAAA,IACN,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,EAAA,EAAI,IAAA;AAAA,IACJ,KAAA,EAAO,IAAA;AAAA,IACP,GAAA,EAAK,IAAA;AAAA,IACL,CAAA,EAAG;AAAA;AAEP,CAAA;;;ACxBO,IAAM,qBAAA,GAAwB,CAAC,kCAAkC;AAEjE,SAAS,gBAAgB,KAAA,EAAuB;AACrD,EAAA,IAAI,OAAA,GAAU,KAAA;AACd,EAAA,WAAS;AACP,IAAA,IAAI,WAAW,IAAA,CAAK,IAAA,CAAK,OAAA,EAAS,cAAc,CAAC,CAAA,EAAG;AAClD,MAAA,OAAO,OAAA;AAAA,IACT;AACA,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AACnC,IAAA,IAAI,WAAW,OAAA,EAAS;AACtB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6BAAA,EAAgC,KAAK,CAAA,CAAE,CAAA;AAAA,IACzD;AACA,IAAA,OAAA,GAAU,MAAA;AAAA,EACZ;AACF;AAEO,SAAS,qBAAA,GAAgC;AAC9C,EAAA,MAAM,OAAO,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,MAAA,CAAA,IAAA,CAAY,GAAG,CAAC,CAAA;AACxD,EAAA,OAAO,KAAK,IAAA,CAAK,eAAA,CAAgB,IAAI,CAAA,EAAG,OAAO,eAAe,CAAA;AAChE;AAEA,SAAS,kBAAA,CACP,QACA,IAAA,EACQ;AACR,EAAA,MAAM,WAAA,GAAc,OAAO,OAAA,EAAS,WAAA;AACpC,EAAA,IAAI,CAAC,WAAA,EAAa;AAChB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,GAAG,IAAI,CAAA,uEAAA;AAAA,KACT;AAAA,EACF;AACA,EAAA,OAAO,WAAA;AACT;AAEO,SAAS,gBAAA,GAAmB;AACjC,EAAA,OAAO,YAAA,CAAa;AAAA,IAClB;AAAA,MACE,KAAA,EAAO,qBAAA;AAAA,MACP,eAAA,EAAiB;AAAA,QACf,QAAQ,QAAA,CAAS,MAAA;AAAA,QACjB,aAAA,EAAe;AAAA,UACb,WAAA,EAAa,QAAA;AAAA,UACb,UAAA,EAAY;AAAA;AACd,OACF;AAAA,MACA,QAAA,EAAU;AAAA,QACR,cAAA,EAAgB;AAAA,UACd,uBAAuB,qBAAA;AAAsB;AAC/C;AACF,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,uBAAuB,CAAA;AAAA,IACnD,kBAAA,CAAmB,SAAS,uBAAuB,CAAA;AAAA,IACnD;AAAA,MACE,KAAA,EAAO,qBAAA;AAAA,MACP,KAAA,EAAO;AAAA,QACL,UAAA,EAAY,CAAC,OAAA,EAAS,eAAe,CAAA;AAAA,QACrC,wBAAA,EAA0B,CAAC,OAAA,EAAS,2BAA2B,CAAA;AAAA,QAC/D,gBAAA,EAAkB,CAAC,OAAA,EAAS,mBAAmB,CAAA;AAAA,QAC/C,WAAA,EAAa,CAAC,OAAA,EAAS,cAAc,CAAA;AAAA,QACrC,YAAA,EAAc,CAAC,OAAA,EAAS,eAAe,CAAA;AAAA,QACvC,+BAAA,EAAiC,CAAC,OAAA,EAAS,0BAA0B;AAAA;AACvE,KACF;AAAA,IACA,cAAc,CAAC,SAAA,EAAW,iBAAA,EAAmB,UAAA,EAAY,WAAW,CAAC;AAAA,GACtE,CAAA;AACH;AAEA,IAAO,qBAAA,GAAQ","file":"index.js","sourcesContent":["export const COMPLEXITY_OPTS = 10;\n\nexport const MAX_LINES_PER_FUNCTION_OPTS = {\n max: 50,\n skipBlankLines: true,\n skipComments: true,\n};\n\nexport const MAX_STATEMENTS_OPTS = 15;\n\nexport const MAX_DEPTH_OPTS = 4;\n\nexport const MAX_PARAMS_OPTS = 4;\n\nexport const PREVENT_ABBREVIATIONS_OPTS = {\n allowList: {\n id: true,\n url: true,\n uri: true,\n api: true,\n cli: true,\n sdk: true,\n os: true,\n io: true,\n ip: true,\n tls: true,\n ssl: true,\n jwt: true,\n json: true,\n yaml: true,\n html: true,\n css: true,\n dom: true,\n ast: true,\n gpu: true,\n cpu: true,\n ram: true,\n vm: true,\n props: true,\n ref: true,\n e: true,\n },\n};\n","import { existsSync } from \"node:fs\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nimport { type Config, defineConfig, globalIgnores } from \"eslint/config\";\nimport sonarjs from \"eslint-plugin-sonarjs\";\nimport unicorn from \"eslint-plugin-unicorn\";\nimport tseslint from \"typescript-eslint\";\n\nimport {\n COMPLEXITY_OPTS,\n MAX_DEPTH_OPTS,\n MAX_LINES_PER_FUNCTION_OPTS,\n MAX_PARAMS_OPTS,\n MAX_STATEMENTS_OPTS,\n PREVENT_ABBREVIATIONS_OPTS,\n} from \"./options.js\";\n\nexport const PRAGMATIKS_LINT_FILES = [\"**/*.{ts,tsx,mts,cts,js,mjs,cjs}\"];\n\nexport function findPackageRoot(start: string): string {\n let current = start;\n for (;;) {\n if (existsSync(path.join(current, \"package.json\"))) {\n return current;\n }\n const parent = path.dirname(current);\n if (parent === current) {\n throw new Error(`package.json not found above ${start}`);\n }\n current = parent;\n }\n}\n\nexport function semgrepRulesDirectory(): string {\n const here = path.dirname(fileURLToPath(import.meta.url));\n return path.join(findPackageRoot(here), \"src\", \"semgrep-rules\");\n}\n\nfunction recommendedOrThrow(\n plugin: { configs?: Record<string, unknown> },\n name: string,\n): Config {\n const recommended = plugin.configs?.recommended;\n if (!recommended) {\n throw new Error(\n `${name} has no recommended flat-config preset. Peer dependency major mismatch.`,\n );\n }\n return recommended as Config;\n}\n\nexport function pragmatiksConfig() {\n return defineConfig([\n {\n files: PRAGMATIKS_LINT_FILES,\n languageOptions: {\n parser: tseslint.parser,\n parserOptions: {\n ecmaVersion: \"latest\",\n sourceType: \"module\",\n },\n },\n settings: {\n pragmatiksLint: {\n semgrepRulesDirectory: semgrepRulesDirectory(),\n },\n },\n },\n recommendedOrThrow(sonarjs, \"eslint-plugin-sonarjs\"),\n recommendedOrThrow(unicorn, \"eslint-plugin-unicorn\"),\n {\n files: PRAGMATIKS_LINT_FILES,\n rules: {\n complexity: [\"error\", COMPLEXITY_OPTS],\n \"max-lines-per-function\": [\"error\", MAX_LINES_PER_FUNCTION_OPTS],\n \"max-statements\": [\"error\", MAX_STATEMENTS_OPTS],\n \"max-depth\": [\"error\", MAX_DEPTH_OPTS],\n \"max-params\": [\"error\", MAX_PARAMS_OPTS],\n \"unicorn/prevent-abbreviations\": [\"error\", PREVENT_ABBREVIATIONS_OPTS],\n },\n },\n globalIgnores([\"dist/**\", \"node_modules/**\", \".next/**\", \".turbo/**\"]),\n ]);\n}\n\nexport default pragmatiksConfig;\n"]}
@@ -0,0 +1,43 @@
1
+ export { PRAGMATIKS_LINT_FILES, findPackageRoot, default as pragmatiksConfig, semgrepRulesDirectory } from './eslint-config/index.js';
2
+ import 'eslint/config';
3
+
4
+ declare const COMPLEXITY_OPTS = 10;
5
+ declare const MAX_LINES_PER_FUNCTION_OPTS: {
6
+ max: number;
7
+ skipBlankLines: boolean;
8
+ skipComments: boolean;
9
+ };
10
+ declare const MAX_STATEMENTS_OPTS = 15;
11
+ declare const MAX_DEPTH_OPTS = 4;
12
+ declare const MAX_PARAMS_OPTS = 4;
13
+ declare const PREVENT_ABBREVIATIONS_OPTS: {
14
+ allowList: {
15
+ id: boolean;
16
+ url: boolean;
17
+ uri: boolean;
18
+ api: boolean;
19
+ cli: boolean;
20
+ sdk: boolean;
21
+ os: boolean;
22
+ io: boolean;
23
+ ip: boolean;
24
+ tls: boolean;
25
+ ssl: boolean;
26
+ jwt: boolean;
27
+ json: boolean;
28
+ yaml: boolean;
29
+ html: boolean;
30
+ css: boolean;
31
+ dom: boolean;
32
+ ast: boolean;
33
+ gpu: boolean;
34
+ cpu: boolean;
35
+ ram: boolean;
36
+ vm: boolean;
37
+ props: boolean;
38
+ ref: boolean;
39
+ e: boolean;
40
+ };
41
+ };
42
+
43
+ export { COMPLEXITY_OPTS, MAX_DEPTH_OPTS, MAX_LINES_PER_FUNCTION_OPTS, MAX_PARAMS_OPTS, MAX_STATEMENTS_OPTS, PREVENT_ABBREVIATIONS_OPTS };
package/dist/index.js ADDED
@@ -0,0 +1,115 @@
1
+ import { existsSync } from 'fs';
2
+ import path from 'path';
3
+ import { fileURLToPath } from 'url';
4
+ import { defineConfig, globalIgnores } from 'eslint/config';
5
+ import sonarjs from 'eslint-plugin-sonarjs';
6
+ import unicorn from 'eslint-plugin-unicorn';
7
+ import tseslint from 'typescript-eslint';
8
+
9
+ // src/eslint-config/index.ts
10
+
11
+ // src/eslint-config/options.ts
12
+ var COMPLEXITY_OPTS = 10;
13
+ var MAX_LINES_PER_FUNCTION_OPTS = {
14
+ max: 50,
15
+ skipBlankLines: true,
16
+ skipComments: true
17
+ };
18
+ var MAX_STATEMENTS_OPTS = 15;
19
+ var MAX_DEPTH_OPTS = 4;
20
+ var MAX_PARAMS_OPTS = 4;
21
+ var PREVENT_ABBREVIATIONS_OPTS = {
22
+ allowList: {
23
+ id: true,
24
+ url: true,
25
+ uri: true,
26
+ api: true,
27
+ cli: true,
28
+ sdk: true,
29
+ os: true,
30
+ io: true,
31
+ ip: true,
32
+ tls: true,
33
+ ssl: true,
34
+ jwt: true,
35
+ json: true,
36
+ yaml: true,
37
+ html: true,
38
+ css: true,
39
+ dom: true,
40
+ ast: true,
41
+ gpu: true,
42
+ cpu: true,
43
+ ram: true,
44
+ vm: true,
45
+ props: true,
46
+ ref: true,
47
+ e: true
48
+ }
49
+ };
50
+
51
+ // src/eslint-config/index.ts
52
+ var PRAGMATIKS_LINT_FILES = ["**/*.{ts,tsx,mts,cts,js,mjs,cjs}"];
53
+ function findPackageRoot(start) {
54
+ let current = start;
55
+ for (; ; ) {
56
+ if (existsSync(path.join(current, "package.json"))) {
57
+ return current;
58
+ }
59
+ const parent = path.dirname(current);
60
+ if (parent === current) {
61
+ throw new Error(`package.json not found above ${start}`);
62
+ }
63
+ current = parent;
64
+ }
65
+ }
66
+ function semgrepRulesDirectory() {
67
+ const here = path.dirname(fileURLToPath(import.meta.url));
68
+ return path.join(findPackageRoot(here), "src", "semgrep-rules");
69
+ }
70
+ function recommendedOrThrow(plugin, name) {
71
+ const recommended = plugin.configs?.recommended;
72
+ if (!recommended) {
73
+ throw new Error(
74
+ `${name} has no recommended flat-config preset. Peer dependency major mismatch.`
75
+ );
76
+ }
77
+ return recommended;
78
+ }
79
+ function pragmatiksConfig() {
80
+ return defineConfig([
81
+ {
82
+ files: PRAGMATIKS_LINT_FILES,
83
+ languageOptions: {
84
+ parser: tseslint.parser,
85
+ parserOptions: {
86
+ ecmaVersion: "latest",
87
+ sourceType: "module"
88
+ }
89
+ },
90
+ settings: {
91
+ pragmatiksLint: {
92
+ semgrepRulesDirectory: semgrepRulesDirectory()
93
+ }
94
+ }
95
+ },
96
+ recommendedOrThrow(sonarjs, "eslint-plugin-sonarjs"),
97
+ recommendedOrThrow(unicorn, "eslint-plugin-unicorn"),
98
+ {
99
+ files: PRAGMATIKS_LINT_FILES,
100
+ rules: {
101
+ complexity: ["error", COMPLEXITY_OPTS],
102
+ "max-lines-per-function": ["error", MAX_LINES_PER_FUNCTION_OPTS],
103
+ "max-statements": ["error", MAX_STATEMENTS_OPTS],
104
+ "max-depth": ["error", MAX_DEPTH_OPTS],
105
+ "max-params": ["error", MAX_PARAMS_OPTS],
106
+ "unicorn/prevent-abbreviations": ["error", PREVENT_ABBREVIATIONS_OPTS]
107
+ }
108
+ },
109
+ globalIgnores(["dist/**", "node_modules/**", ".next/**", ".turbo/**"])
110
+ ]);
111
+ }
112
+
113
+ export { COMPLEXITY_OPTS, MAX_DEPTH_OPTS, MAX_LINES_PER_FUNCTION_OPTS, MAX_PARAMS_OPTS, MAX_STATEMENTS_OPTS, PRAGMATIKS_LINT_FILES, PREVENT_ABBREVIATIONS_OPTS, findPackageRoot, pragmatiksConfig, semgrepRulesDirectory };
114
+ //# sourceMappingURL=index.js.map
115
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/eslint-config/options.ts","../src/eslint-config/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAAO,IAAM,eAAA,GAAkB;AAExB,IAAM,2BAAA,GAA8B;AAAA,EACzC,GAAA,EAAK,EAAA;AAAA,EACL,cAAA,EAAgB,IAAA;AAAA,EAChB,YAAA,EAAc;AAChB;AAEO,IAAM,mBAAA,GAAsB;AAE5B,IAAM,cAAA,GAAiB;AAEvB,IAAM,eAAA,GAAkB;AAExB,IAAM,0BAAA,GAA6B;AAAA,EACxC,SAAA,EAAW;AAAA,IACT,EAAA,EAAI,IAAA;AAAA,IACJ,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,EAAA,EAAI,IAAA;AAAA,IACJ,EAAA,EAAI,IAAA;AAAA,IACJ,EAAA,EAAI,IAAA;AAAA,IACJ,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,IAAA,EAAM,IAAA;AAAA,IACN,IAAA,EAAM,IAAA;AAAA,IACN,IAAA,EAAM,IAAA;AAAA,IACN,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,GAAA,EAAK,IAAA;AAAA,IACL,EAAA,EAAI,IAAA;AAAA,IACJ,KAAA,EAAO,IAAA;AAAA,IACP,GAAA,EAAK,IAAA;AAAA,IACL,CAAA,EAAG;AAAA;AAEP;;;ACxBO,IAAM,qBAAA,GAAwB,CAAC,kCAAkC;AAEjE,SAAS,gBAAgB,KAAA,EAAuB;AACrD,EAAA,IAAI,OAAA,GAAU,KAAA;AACd,EAAA,WAAS;AACP,IAAA,IAAI,WAAW,IAAA,CAAK,IAAA,CAAK,OAAA,EAAS,cAAc,CAAC,CAAA,EAAG;AAClD,MAAA,OAAO,OAAA;AAAA,IACT;AACA,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AACnC,IAAA,IAAI,WAAW,OAAA,EAAS;AACtB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6BAAA,EAAgC,KAAK,CAAA,CAAE,CAAA;AAAA,IACzD;AACA,IAAA,OAAA,GAAU,MAAA;AAAA,EACZ;AACF;AAEO,SAAS,qBAAA,GAAgC;AAC9C,EAAA,MAAM,OAAO,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,MAAA,CAAA,IAAA,CAAY,GAAG,CAAC,CAAA;AACxD,EAAA,OAAO,KAAK,IAAA,CAAK,eAAA,CAAgB,IAAI,CAAA,EAAG,OAAO,eAAe,CAAA;AAChE;AAEA,SAAS,kBAAA,CACP,QACA,IAAA,EACQ;AACR,EAAA,MAAM,WAAA,GAAc,OAAO,OAAA,EAAS,WAAA;AACpC,EAAA,IAAI,CAAC,WAAA,EAAa;AAChB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,GAAG,IAAI,CAAA,uEAAA;AAAA,KACT;AAAA,EACF;AACA,EAAA,OAAO,WAAA;AACT;AAEO,SAAS,gBAAA,GAAmB;AACjC,EAAA,OAAO,YAAA,CAAa;AAAA,IAClB;AAAA,MACE,KAAA,EAAO,qBAAA;AAAA,MACP,eAAA,EAAiB;AAAA,QACf,QAAQ,QAAA,CAAS,MAAA;AAAA,QACjB,aAAA,EAAe;AAAA,UACb,WAAA,EAAa,QAAA;AAAA,UACb,UAAA,EAAY;AAAA;AACd,OACF;AAAA,MACA,QAAA,EAAU;AAAA,QACR,cAAA,EAAgB;AAAA,UACd,uBAAuB,qBAAA;AAAsB;AAC/C;AACF,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,uBAAuB,CAAA;AAAA,IACnD,kBAAA,CAAmB,SAAS,uBAAuB,CAAA;AAAA,IACnD;AAAA,MACE,KAAA,EAAO,qBAAA;AAAA,MACP,KAAA,EAAO;AAAA,QACL,UAAA,EAAY,CAAC,OAAA,EAAS,eAAe,CAAA;AAAA,QACrC,wBAAA,EAA0B,CAAC,OAAA,EAAS,2BAA2B,CAAA;AAAA,QAC/D,gBAAA,EAAkB,CAAC,OAAA,EAAS,mBAAmB,CAAA;AAAA,QAC/C,WAAA,EAAa,CAAC,OAAA,EAAS,cAAc,CAAA;AAAA,QACrC,YAAA,EAAc,CAAC,OAAA,EAAS,eAAe,CAAA;AAAA,QACvC,+BAAA,EAAiC,CAAC,OAAA,EAAS,0BAA0B;AAAA;AACvE,KACF;AAAA,IACA,cAAc,CAAC,SAAA,EAAW,iBAAA,EAAmB,UAAA,EAAY,WAAW,CAAC;AAAA,GACtE,CAAA;AACH","file":"index.js","sourcesContent":["export const COMPLEXITY_OPTS = 10;\n\nexport const MAX_LINES_PER_FUNCTION_OPTS = {\n max: 50,\n skipBlankLines: true,\n skipComments: true,\n};\n\nexport const MAX_STATEMENTS_OPTS = 15;\n\nexport const MAX_DEPTH_OPTS = 4;\n\nexport const MAX_PARAMS_OPTS = 4;\n\nexport const PREVENT_ABBREVIATIONS_OPTS = {\n allowList: {\n id: true,\n url: true,\n uri: true,\n api: true,\n cli: true,\n sdk: true,\n os: true,\n io: true,\n ip: true,\n tls: true,\n ssl: true,\n jwt: true,\n json: true,\n yaml: true,\n html: true,\n css: true,\n dom: true,\n ast: true,\n gpu: true,\n cpu: true,\n ram: true,\n vm: true,\n props: true,\n ref: true,\n e: true,\n },\n};\n","import { existsSync } from \"node:fs\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nimport { type Config, defineConfig, globalIgnores } from \"eslint/config\";\nimport sonarjs from \"eslint-plugin-sonarjs\";\nimport unicorn from \"eslint-plugin-unicorn\";\nimport tseslint from \"typescript-eslint\";\n\nimport {\n COMPLEXITY_OPTS,\n MAX_DEPTH_OPTS,\n MAX_LINES_PER_FUNCTION_OPTS,\n MAX_PARAMS_OPTS,\n MAX_STATEMENTS_OPTS,\n PREVENT_ABBREVIATIONS_OPTS,\n} from \"./options.js\";\n\nexport const PRAGMATIKS_LINT_FILES = [\"**/*.{ts,tsx,mts,cts,js,mjs,cjs}\"];\n\nexport function findPackageRoot(start: string): string {\n let current = start;\n for (;;) {\n if (existsSync(path.join(current, \"package.json\"))) {\n return current;\n }\n const parent = path.dirname(current);\n if (parent === current) {\n throw new Error(`package.json not found above ${start}`);\n }\n current = parent;\n }\n}\n\nexport function semgrepRulesDirectory(): string {\n const here = path.dirname(fileURLToPath(import.meta.url));\n return path.join(findPackageRoot(here), \"src\", \"semgrep-rules\");\n}\n\nfunction recommendedOrThrow(\n plugin: { configs?: Record<string, unknown> },\n name: string,\n): Config {\n const recommended = plugin.configs?.recommended;\n if (!recommended) {\n throw new Error(\n `${name} has no recommended flat-config preset. Peer dependency major mismatch.`,\n );\n }\n return recommended as Config;\n}\n\nexport function pragmatiksConfig() {\n return defineConfig([\n {\n files: PRAGMATIKS_LINT_FILES,\n languageOptions: {\n parser: tseslint.parser,\n parserOptions: {\n ecmaVersion: \"latest\",\n sourceType: \"module\",\n },\n },\n settings: {\n pragmatiksLint: {\n semgrepRulesDirectory: semgrepRulesDirectory(),\n },\n },\n },\n recommendedOrThrow(sonarjs, \"eslint-plugin-sonarjs\"),\n recommendedOrThrow(unicorn, \"eslint-plugin-unicorn\"),\n {\n files: PRAGMATIKS_LINT_FILES,\n rules: {\n complexity: [\"error\", COMPLEXITY_OPTS],\n \"max-lines-per-function\": [\"error\", MAX_LINES_PER_FUNCTION_OPTS],\n \"max-statements\": [\"error\", MAX_STATEMENTS_OPTS],\n \"max-depth\": [\"error\", MAX_DEPTH_OPTS],\n \"max-params\": [\"error\", MAX_PARAMS_OPTS],\n \"unicorn/prevent-abbreviations\": [\"error\", PREVENT_ABBREVIATIONS_OPTS],\n },\n },\n globalIgnores([\"dist/**\", \"node_modules/**\", \".next/**\", \".turbo/**\"]),\n ]);\n}\n\nexport default pragmatiksConfig;\n"]}
package/package.json ADDED
@@ -0,0 +1,70 @@
1
+ {
2
+ "name": "@pragmatiks/lint",
3
+ "version": "0.2.0",
4
+ "description": "Pragmatiks engineering principles eslint config and bundled semgrep rules.",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "module": "./dist/index.js",
8
+ "types": "./dist/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "types": "./dist/index.d.ts",
12
+ "import": "./dist/index.js"
13
+ },
14
+ "./eslint-config": {
15
+ "types": "./dist/eslint-config/index.d.ts",
16
+ "import": "./dist/eslint-config/index.js"
17
+ }
18
+ },
19
+ "files": [
20
+ "dist",
21
+ "src/semgrep-rules",
22
+ "README.md",
23
+ "LICENSE",
24
+ "CHANGELOG.md"
25
+ ],
26
+ "peerDependencies": {
27
+ "eslint": "^9.0.0",
28
+ "eslint-plugin-sonarjs": "^4.0.0",
29
+ "eslint-plugin-unicorn": "^64.0.0",
30
+ "typescript-eslint": "^8.0.0"
31
+ },
32
+ "devDependencies": {
33
+ "@types/node": "^24.0.0",
34
+ "eslint": "^9.18.0",
35
+ "eslint-plugin-sonarjs": "^4.0.3",
36
+ "eslint-plugin-unicorn": "^64.0.0",
37
+ "knip": "^6.12.1",
38
+ "prettier": "^3.4.2",
39
+ "tsup": "^8.3.5",
40
+ "typescript": "^5.7.3",
41
+ "typescript-eslint": "^8.59.2",
42
+ "vitest": "^2.1.8"
43
+ },
44
+ "engines": {
45
+ "node": ">=20"
46
+ },
47
+ "publishConfig": {
48
+ "access": "public"
49
+ },
50
+ "keywords": [
51
+ "eslint",
52
+ "eslint-config",
53
+ "semgrep",
54
+ "lint",
55
+ "pragmatiks"
56
+ ],
57
+ "license": "MIT",
58
+ "author": "Pragmatiks",
59
+ "repository": {
60
+ "type": "git",
61
+ "url": "git+https://github.com/pragmatiks/pragma-lint.git",
62
+ "directory": "js"
63
+ },
64
+ "scripts": {
65
+ "build": "tsup",
66
+ "format": "prettier --write .",
67
+ "check": "eslint . && tsc --noEmit",
68
+ "test": "vitest run"
69
+ }
70
+ }
@@ -0,0 +1,27 @@
1
+ rules:
2
+ - id: pra-env-read-deep
3
+ pattern-either:
4
+ - pattern: os.environ[$KEY]
5
+ - pattern: os.environ.get($KEY)
6
+ - pattern: os.getenv($KEY)
7
+ paths:
8
+ exclude:
9
+ - "settings.py"
10
+ - "config.py"
11
+ - "env.py"
12
+ - "__main__.py"
13
+ - "__init__.py"
14
+ - "app.py"
15
+ - "cli.py"
16
+ - "main.py"
17
+ - "*/settings.py"
18
+ - "*/config.py"
19
+ - "*/env.py"
20
+ - "*/__main__.py"
21
+ - "*/__init__.py"
22
+ - "*/app.py"
23
+ - "*/cli.py"
24
+ - "*/main.py"
25
+ message: "principle #8 Environment reads belong at app boundaries. Move the read to settings or config."
26
+ severity: WARNING
27
+ languages: [python]
@@ -0,0 +1,44 @@
1
+ rules:
2
+ - id: pra-io-prefix-mismatch
3
+ patterns:
4
+ - pattern-either:
5
+ - pattern: |
6
+ def $NAME(...):
7
+ ...
8
+ - pattern: |
9
+ async def $NAME(...):
10
+ ...
11
+ - metavariable-regex:
12
+ metavariable: $NAME
13
+ regex: '^(get|fetch|retrieve|load|save|read|write|query)_.*'
14
+ - pattern-not: |
15
+ def $NAME(...):
16
+ ...
17
+ await $CALL
18
+ ...
19
+ - pattern-not: |
20
+ async def $NAME(...):
21
+ ...
22
+ await $CALL
23
+ ...
24
+ - pattern-not: |
25
+ def $NAME(...):
26
+ ...
27
+ open(...)
28
+ ...
29
+ - pattern-not: |
30
+ def $NAME(...):
31
+ ...
32
+ httpx.$METHOD(...)
33
+ ...
34
+ - pattern-not: |
35
+ def $NAME(...):
36
+ ...
37
+ requests.$METHOD(...)
38
+ ...
39
+ - pattern-not-regex: '(?s)(database|session|connection|cursor|client)\.(execute|fetch|get|post|put|delete|query|read|write|save)\('
40
+ message: "principle #7 I/O-prefixed function appears pure. Rename it with compute, build, derive, format, or parse."
41
+ severity: WARNING
42
+ languages: [python]
43
+ metadata:
44
+ note: "Heuristic rule; false positives are expected for hidden I/O wrappers."
@@ -0,0 +1,21 @@
1
+ rules:
2
+ - id: pra-no-abbreviations-python
3
+ patterns:
4
+ - pattern-either:
5
+ - pattern: $NAME = $VALUE
6
+ - pattern: "def $NAME(...): ..."
7
+ - pattern: "async def $NAME(...): ..."
8
+ - pattern: "def $FUNC($NAME, ...): ..."
9
+ - pattern: "def $FUNC(..., $NAME, ...): ..."
10
+ - pattern: "async def $FUNC($NAME, ...): ..."
11
+ - pattern: "async def $FUNC(..., $NAME, ...): ..."
12
+ - pattern: "for $NAME in $ITERABLE: ..."
13
+ - pattern: "class $NAME(...): ..."
14
+ - pattern: "class $NAME: ..."
15
+ - pattern: self.$NAME = $VALUE
16
+ - metavariable-regex:
17
+ metavariable: $NAME
18
+ regex: '^(k8s|cfg|db|req|res|ctx|tmp|pkg|svc|mgr|repo|usr|pwd|idx|cnt|msg|err|btn|txt|num|val)$'
19
+ message: "principle #11 Abbreviated identifier hides meaning. Rename it with full words."
20
+ severity: WARNING
21
+ languages: [python]
@@ -0,0 +1,11 @@
1
+ rules:
2
+ - id: pra-no-block-comments-python
3
+ pattern-regex: '(?m)^[ \t]*#(?![ \t]*WHY:).*\n[ \t]*#(?![ \t]*WHY:).*$'
4
+ message: "principle #10 Block comments make code harder to trust. Delete the comment or replace it with one WHY line."
5
+ severity: ERROR
6
+ languages: [python]
7
+ - id: pra-no-block-comments-js
8
+ pattern-regex: '/\*(?!\*)[\s\S]*?\*/'
9
+ message: "principle #10 Block comments make code harder to trust. Delete the comment or replace it with one WHY line."
10
+ severity: ERROR
11
+ languages: [typescript, javascript]
@@ -0,0 +1,11 @@
1
+ rules:
2
+ - id: pra-no-todo-comments-python
3
+ pattern-regex: '(?i)#\s*(TODO(?!\(PRA-[0-9]+\))|FIXME|XXX)\b'
4
+ message: "principle #10 Planning comments decay. Link a Linear issue or remove the comment."
5
+ severity: ERROR
6
+ languages: [python]
7
+ - id: pra-no-todo-comments-js
8
+ pattern-regex: '(?i)(//|/\*)\s*(TODO(?!\(PRA-[0-9]+\))|FIXME|XXX)\b'
9
+ message: "principle #10 Planning comments decay. Link a Linear issue or remove the comment."
10
+ severity: ERROR
11
+ languages: [typescript, javascript]
@@ -0,0 +1,24 @@
1
+ rules:
2
+ - id: pra-srp-and-or-name
3
+ patterns:
4
+ - pattern-either:
5
+ - pattern: "def $NAME(...): ..."
6
+ - pattern: "async def $NAME(...): ..."
7
+ - metavariable-regex:
8
+ metavariable: $NAME
9
+ regex: '.*(_and_|_or_|[a-z0-9](And|Or)(?=[A-Z]|$)).*'
10
+ message: "principle #12 Compound function name violates SRP. Split the function by responsibility."
11
+ severity: ERROR
12
+ languages: [python]
13
+ - id: pra-srp-and-or-name-js
14
+ patterns:
15
+ - pattern-either:
16
+ - pattern: "function $NAME(...) { ... }"
17
+ - pattern: "async function $NAME(...) { ... }"
18
+ - pattern: "const $NAME = (...) => ..."
19
+ - metavariable-regex:
20
+ metavariable: $NAME
21
+ regex: '.*(_and_|_or_|[a-z0-9](And|Or)(?=[A-Z]|$)).*'
22
+ message: "principle #12 Compound function name violates SRP. Split the function by responsibility."
23
+ severity: ERROR
24
+ languages: [typescript, javascript]