@techsquidtv/eslint-plugin-structured-logging 0.1.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 (39) hide show
  1. package/LICENSE.md +20 -0
  2. package/README.md +167 -0
  3. package/docs/rules/require-logger-inline-attributes.md +22 -0
  4. package/docs/rules/require-logger-message.md +22 -0
  5. package/docs/rules/require-logger-primitive-attributes.md +23 -0
  6. package/docs/rules/require-logger-scoped-dot-notation.md +31 -0
  7. package/lib/index.d.ts +31 -0
  8. package/lib/index.d.ts.map +1 -0
  9. package/lib/index.js +55 -0
  10. package/lib/index.js.map +1 -0
  11. package/lib/package.js +6 -0
  12. package/lib/package.js.map +1 -0
  13. package/lib/rules/index.d.ts +5 -0
  14. package/lib/rules/index.js +5 -0
  15. package/lib/rules/logger/require-logger-inline-attributes.d.ts +13 -0
  16. package/lib/rules/logger/require-logger-inline-attributes.d.ts.map +1 -0
  17. package/lib/rules/logger/require-logger-inline-attributes.js +46 -0
  18. package/lib/rules/logger/require-logger-inline-attributes.js.map +1 -0
  19. package/lib/rules/logger/require-logger-message.d.ts +13 -0
  20. package/lib/rules/logger/require-logger-message.d.ts.map +1 -0
  21. package/lib/rules/logger/require-logger-message.js +46 -0
  22. package/lib/rules/logger/require-logger-message.js.map +1 -0
  23. package/lib/rules/logger/require-logger-primitive-attributes.d.ts +20 -0
  24. package/lib/rules/logger/require-logger-primitive-attributes.d.ts.map +1 -0
  25. package/lib/rules/logger/require-logger-primitive-attributes.js +48 -0
  26. package/lib/rules/logger/require-logger-primitive-attributes.js.map +1 -0
  27. package/lib/rules/logger/require-logger-scoped-dot-notation.d.ts +21 -0
  28. package/lib/rules/logger/require-logger-scoped-dot-notation.d.ts.map +1 -0
  29. package/lib/rules/logger/require-logger-scoped-dot-notation.js +111 -0
  30. package/lib/rules/logger/require-logger-scoped-dot-notation.js.map +1 -0
  31. package/lib/rules/logger/utils.d.ts +156 -0
  32. package/lib/rules/logger/utils.d.ts.map +1 -0
  33. package/lib/rules/logger/utils.js +271 -0
  34. package/lib/rules/logger/utils.js.map +1 -0
  35. package/lib/utils.d.ts +17 -0
  36. package/lib/utils.d.ts.map +1 -0
  37. package/lib/utils.js +7 -0
  38. package/lib/utils.js.map +1 -0
  39. package/package.json +80 -0
package/lib/utils.d.ts ADDED
@@ -0,0 +1,17 @@
1
+ import { ESLintUtils } from "@typescript-eslint/utils";
2
+
3
+ //#region src/utils.d.ts
4
+ interface StructuredLoggingPluginDocs {
5
+ description: string;
6
+ recommended?: boolean;
7
+ }
8
+ declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({
9
+ meta,
10
+ name,
11
+ ...rule
12
+ }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, StructuredLoggingPluginDocs>>) => ESLintUtils.RuleModule<MessageIds, Options, StructuredLoggingPluginDocs, ESLintUtils.RuleListener> & {
13
+ name: string;
14
+ };
15
+ //#endregion
16
+ export { StructuredLoggingPluginDocs, createRule };
17
+ //# sourceMappingURL=utils.d.ts.map
package/lib/utils.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","names":[],"sources":["../src/utils.ts"],"mappings":";;;UAEiB,2BAAA;EAChB,WAAA;EACA,WAAW;AAAA;AAAA,cAGC,UAAA;EAAU,IAAA;EAAA,IAAA;EAAA,GAAA;AAAA,GAAA,QAAA,CAAA,WAAA,CAAA,mBAAA,CAAA,OAAA,EAAA,UAAA,EAAA,2BAAA,OAAA,WAAA,CAAA,UAAA,CAAA,UAAA,EAAA,OAAA,EAAA,2BAAA,EAAA,WAAA,CAAA,YAAA"}
package/lib/utils.js ADDED
@@ -0,0 +1,7 @@
1
+ import { ESLintUtils } from "@typescript-eslint/utils";
2
+ //#region src/utils.ts
3
+ const createRule = ESLintUtils.RuleCreator((name) => `https://github.com/KyleTryon/eslint-plugin-structured-logging/tree/main/docs/rules/${name}.md`);
4
+ //#endregion
5
+ export { createRule };
6
+
7
+ //# sourceMappingURL=utils.js.map
package/lib/utils.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","names":[],"sources":["../src/utils.ts"],"sourcesContent":["import { ESLintUtils } from \"@typescript-eslint/utils\";\n\nexport interface StructuredLoggingPluginDocs {\n\tdescription: string;\n\trecommended?: boolean;\n}\n\nexport const createRule = ESLintUtils.RuleCreator<StructuredLoggingPluginDocs>(\n\t(name) =>\n\t\t`https://github.com/KyleTryon/eslint-plugin-structured-logging/tree/main/docs/rules/${name}.md`,\n);\n"],"mappings":";;AAOA,MAAa,aAAa,YAAY,aACpC,SACA,sFAAsF,KAAK,IAC7F"}
package/package.json ADDED
@@ -0,0 +1,80 @@
1
+ {
2
+ "name": "@techsquidtv/eslint-plugin-structured-logging",
3
+ "version": "0.1.0",
4
+ "description": "ESLint plugin with library-agnostic lint rules for structured logging in TypeScript.",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/KyleTryon/eslint-plugin-structured-logging.git"
8
+ },
9
+ "license": "MIT",
10
+ "type": "module",
11
+ "main": "lib/index.js",
12
+ "types": "lib/index.d.ts",
13
+ "exports": {
14
+ ".": {
15
+ "types": "./lib/index.d.ts",
16
+ "default": "./lib/index.js"
17
+ }
18
+ },
19
+ "files": [
20
+ "docs/",
21
+ "lib/",
22
+ "LICENSE.md",
23
+ "README.md"
24
+ ],
25
+ "scripts": {
26
+ "build": "vp pack",
27
+ "check": "vp check && vp run knip && vp run docs:rules:check && vp run tsc && vp test",
28
+ "docs:rules": "vp pack && eslint-doc-generator",
29
+ "docs:rules:check": "vp pack && eslint-doc-generator --check true",
30
+ "format": "vp fmt .",
31
+ "format:check": "vp fmt . --check",
32
+ "format:write": "vp fmt .",
33
+ "knip": "knip",
34
+ "lint": "vp lint . --max-warnings 0",
35
+ "prepare": "vp config",
36
+ "release": "node scripts/release.mjs",
37
+ "release:dry-run": "node scripts/release.mjs --dry-run",
38
+ "test": "vp test",
39
+ "tsc": "tsc"
40
+ },
41
+ "dependencies": {
42
+ "@typescript-eslint/utils": "^8.62.1"
43
+ },
44
+ "devDependencies": {
45
+ "@types/node": "26.1.0",
46
+ "@typescript-eslint/parser": "^8.62.1",
47
+ "@typescript-eslint/rule-tester": "^8.62.1",
48
+ "@vitest/coverage-v8": "catalog:",
49
+ "console-fail-test": "0.6.1",
50
+ "eslint": "10.6.0",
51
+ "eslint-doc-generator": "^3.6.0",
52
+ "eslint-plugin-eslint-plugin": "^7.4.1",
53
+ "knip": "^6.16.0",
54
+ "typescript": "6.0.3",
55
+ "vite-plus": "catalog:"
56
+ },
57
+ "peerDependencies": {
58
+ "@typescript-eslint/parser": "^8.0.0",
59
+ "eslint": ">=9.0.0",
60
+ "typescript": ">=5.0.0"
61
+ },
62
+ "publishConfig": {},
63
+ "packageManager": "pnpm@10.4.0",
64
+ "engines": {
65
+ "node": ">=20.19.0"
66
+ },
67
+ "pnpm": {
68
+ "overrides": {
69
+ "vite": "npm:@voidzero-dev/vite-plus-core@0.2.2"
70
+ },
71
+ "peerDependencyRules": {
72
+ "allowAny": [
73
+ "vite"
74
+ ],
75
+ "allowedVersions": {
76
+ "vite": "*"
77
+ }
78
+ }
79
+ }
80
+ }