docstring-verifier/package.json at main · akrisanov/docstring-verifier · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
{
	"name": "docstring-verifier",
	"displayName": "docstring-verifier",
	"description": "Detect discrepancies between docstrings and code",
	"version": "0.0.1",
	"publisher": "akrisanov",
	"repository": {
		"type": "git",
		"url": "https://github.com/akrisanov/docstring-verifier.git"
	},
	"engines": {
		"vscode": "^1.104.0"
	},
	"categories": [
		"Other"
	],
	"activationEvents": [
		"onLanguage:python",
		"onLanguage:typescript",
		"onLanguage:javascript"
	],
	"main": "./dist/extension.js",
	"contributes": {
		"commands": [
			{
				"command": "docstring-verifier.helloWorld",
				"title": "Hello World"
			}
		],
		"configuration": {
			"title": "Docstring Verifier",
			"properties": {
				"docstringVerifier.enable": {
					"type": "boolean",
					"default": true,
					"description": "Enable/disable the Docstring Verifier extension"
				},
				"docstringVerifier.logLevel": {
					"type": "string",
					"enum": [
						"error",
						"warn",
						"info",
						"debug",
						"trace"
					],
					"default": "info",
					"description": "Logging level for the extension"
				},
				"docstringVerifier.pythonPath": {
					"type": "string",
					"default": "",
					"description": "Path to Python interpreter (leave empty for auto-detection)"
				},
				"docstringVerifier.pythonScriptPath": {
					"type": "string",
					"default": "",
					"description": "Custom path to ast_extractor.py (for development only)"
				},
				"docstringVerifier.preferUv": {
					"type": "boolean",
					"default": true,
					"description": "Prefer uv for running Python scripts (faster, more reliable)"
				},
				"docstringVerifier.docstringStyle": {
					"type": "string",
					"enum": [
						"auto",
						"google",
						"sphinx"
					],
					"default": "auto",
					"description": "Docstring style to use for validation and generation (auto = detect automatically)"
				},
				"docstringVerifier.useLLM": {
					"type": "boolean",
					"default": true,
					"description": "Use LLM (GitHub Copilot) to generate descriptions for Quick Fixes. If disabled, 'TODO' placeholders will be used instead."
				},
				"docstringVerifier.llmTimeout": {
					"type": "number",
					"default": 5000,
					"minimum": 1000,
					"maximum": 30000,
					"description": "Timeout in milliseconds for LLM requests (1000-30000). If the LLM doesn't respond in time, a 'TODO' placeholder will be used."
				},
				"docstringVerifier.llmProvider": {
					"type": "string",
					"enum": [
						"github-copilot"
					],
					"default": "github-copilot",
					"description": "LLM provider to use for generating descriptions. Currently only GitHub Copilot is supported."
				}
			}
		}
	},
	"scripts": {
		"vscode:prepublish": "pnpm run package",
		"compile": "pnpm run check-types && pnpm run lint && node esbuild.js",
		"watch": "npm-run-all -p watch:*",
		"watch:esbuild": "node esbuild.js --watch",
		"watch:tsc": "tsc --noEmit --watch --project tsconfig.json",
		"package": "pnpm run check-types && pnpm run lint && node esbuild.js --production",
		"compile-tests": "tsc -p . --outDir out",
		"watch-tests": "tsc -p . -w --outDir out",
		"pretest": "pnpm run compile-tests && pnpm run compile && pnpm run lint",
		"check-types": "tsc --noEmit",
		"lint": "eslint src",
		"lint:python": "cd tools/python && (uv run ruff check . || ruff check .)",
		"format:python": "cd tools/python && (uv run ruff format . || ruff format .)",
		"test": "vscode-test",
		"test:coverage": "vscode-test --coverage --coverage-output ./coverage --coverage-reporter lcov --coverage-reporter text-summary && node scripts/fix-lcov-paths.js",
		"test:validate-coverage": "node scripts/validate-coverage.js",
		"test:python": "cd tools/python && uv run python -m pytest"
	},
	"devDependencies": {
		"@istanbuljs/nyc-config-typescript": "^1.0.2",
		"@types/mocha": "^10.0.10",
		"@types/node": "22.x",
		"@types/vscode": "^1.104.0",
		"@typescript-eslint/eslint-plugin": "^8.45.0",
		"@typescript-eslint/parser": "^8.45.0",
		"@vscode/test-cli": "^0.0.11",
		"@vscode/test-electron": "^2.5.2",
		"esbuild": "^0.25.10",
		"eslint": "^9.36.0",
		"istanbul-lib-coverage": "^3.2.2",
		"istanbul-lib-report": "^3.0.1",
		"istanbul-reports": "^3.2.0",
		"npm-run-all": "^4.1.5",
		"typescript": "^5.9.3",
		"v8-to-istanbul": "^9.3.0"
	}
}