scip-query 0.3.3 → 0.3.5
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/README.md +1 -26
- package/dist/{chunk-FYYOWQXK.js → chunk-6FKIA6EI.js} +10 -27
- package/dist/{chunk-HLKAFWWJ.js → chunk-EN2Z2CLO.js} +59 -91
- package/dist/chunk-FVH3Y44U.js +1 -0
- package/dist/{chunk-HJZUSUPU.js → chunk-TRESG7OB.js} +4 -4
- package/dist/{chunk-GJDHTTR2.js → chunk-VMM4SYV4.js} +17 -15
- package/dist/{chunk-P4WO3BBW.js → chunk-YGGFLMTM.js} +31 -12
- package/dist/cli.js +109 -225
- package/dist/{db-ShvwGDKf.d.ts → db-viWlyVtv.d.ts} +1 -13
- package/dist/index.d.ts +2 -3
- package/dist/index.js +14 -18
- package/dist/queries/affected.d.ts +1 -1
- package/dist/queries/bottlenecks.d.ts +1 -1
- package/dist/queries/by-kind.d.ts +1 -1
- package/dist/queries/by-kind.js +1 -1
- package/dist/queries/call-graph.d.ts +1 -1
- package/dist/queries/change-surface.d.ts +1 -1
- package/dist/queries/code.d.ts +1 -1
- package/dist/queries/complexity-hotspots.d.ts +1 -1
- package/dist/queries/complexity.d.ts +1 -1
- package/dist/queries/convergence.d.ts +1 -1
- package/dist/queries/convergence.js +1 -1
- package/dist/queries/coupling.d.ts +1 -1
- package/dist/queries/cycles.d.ts +1 -1
- package/dist/queries/dataflow.d.ts +1 -1
- package/dist/queries/dead.d.ts +1 -1
- package/dist/queries/deep-chains.d.ts +1 -1
- package/dist/queries/deps.d.ts +1 -1
- package/dist/queries/diff-impact.d.ts +1 -1
- package/dist/queries/drift.d.ts +1 -1
- package/dist/queries/extract-candidates.d.ts +1 -1
- package/dist/queries/fan.d.ts +1 -1
- package/dist/queries/fan.js +1 -1
- package/dist/queries/files.d.ts +1 -1
- package/dist/queries/health.d.ts +1 -1
- package/dist/queries/health.js +3 -3
- package/dist/queries/hierarchy.d.ts +1 -1
- package/dist/queries/hotspots.d.ts +1 -1
- package/dist/queries/imports.d.ts +1 -1
- package/dist/queries/index.d.ts +1 -2
- package/dist/queries/index.js +14 -18
- package/dist/queries/isolated.d.ts +1 -1
- package/dist/queries/members.d.ts +1 -1
- package/dist/queries/methods.d.ts +1 -1
- package/dist/queries/outline.d.ts +1 -1
- package/dist/queries/passthrough-candidates.d.ts +1 -1
- package/dist/queries/redundant-reexports.d.ts +1 -1
- package/dist/queries/refs.d.ts +1 -1
- package/dist/queries/similar-chains.d.ts +1 -1
- package/dist/queries/similar-files.d.ts +1 -1
- package/dist/queries/similar-signatures.d.ts +1 -1
- package/dist/queries/similar.d.ts +1 -1
- package/dist/queries/slice.d.ts +1 -1
- package/dist/queries/stale-abstractions.d.ts +1 -1
- package/dist/queries/stale-abstractions.js +1 -1
- package/dist/queries/stats.d.ts +1 -1
- package/dist/queries/surface.d.ts +1 -1
- package/dist/queries/symbols.d.ts +1 -1
- package/dist/queries/system.d.ts +1 -1
- package/dist/queries/trace.d.ts +1 -1
- package/dist/queries/wrapper-candidates.d.ts +1 -1
- package/package.json +1 -1
- package/skills/concrete-plan/SKILL.md +1 -1
- package/skills/scip-debloat/SKILL.md +2 -5
- package/skills/scip-explore/SKILL.md +3 -5
- package/skills/scip-verify/SKILL.md +15 -31
- package/dist/chunk-2UELLEBI.js +0 -1
- package/dist/chunk-YZ6L7GFO.js +0 -73
- package/dist/queries/doc-coverage.d.ts +0 -14
- package/dist/queries/doc-coverage.js +0 -8
package/dist/chunk-YZ6L7GFO.js
DELETED
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
shortenSymbol
|
|
3
|
-
} from "./chunk-QIXNAB5K.js";
|
|
4
|
-
|
|
5
|
-
// src/queries/doc-coverage.ts
|
|
6
|
-
function docCoverage(db, opts = {}) {
|
|
7
|
-
const { scope, minLoc = 3, limit = 50 } = opts;
|
|
8
|
-
const scopeFilter = scope ? `AND d.relative_path LIKE '%${scope}%'` : "";
|
|
9
|
-
const totalRow = db.get(
|
|
10
|
-
`SELECT COUNT(*) AS c
|
|
11
|
-
FROM global_symbols gs
|
|
12
|
-
JOIN defn_enclosing_ranges der ON gs.id = der.symbol_id
|
|
13
|
-
JOIN documents d ON der.document_id = d.id
|
|
14
|
-
WHERE 1 = 1
|
|
15
|
-
${db.pathExclusionsFor("d")}
|
|
16
|
-
${db.symbolNoiseFor("gs")}
|
|
17
|
-
AND gs.symbol NOT LIKE '%#%'
|
|
18
|
-
AND (der.end_line - der.start_line + 1) >= ?
|
|
19
|
-
${scopeFilter}`,
|
|
20
|
-
minLoc
|
|
21
|
-
);
|
|
22
|
-
const docRow = db.get(
|
|
23
|
-
`SELECT COUNT(*) AS c
|
|
24
|
-
FROM global_symbols gs
|
|
25
|
-
JOIN defn_enclosing_ranges der ON gs.id = der.symbol_id
|
|
26
|
-
JOIN documents d ON der.document_id = d.id
|
|
27
|
-
WHERE 1 = 1
|
|
28
|
-
${db.pathExclusionsFor("d")}
|
|
29
|
-
${db.symbolNoiseFor("gs")}
|
|
30
|
-
AND gs.symbol NOT LIKE '%#%'
|
|
31
|
-
AND (der.end_line - der.start_line + 1) >= ?
|
|
32
|
-
AND gs.documentation IS NOT NULL
|
|
33
|
-
AND gs.documentation != ''
|
|
34
|
-
${scopeFilter}`,
|
|
35
|
-
minLoc
|
|
36
|
-
);
|
|
37
|
-
const total = totalRow?.c ?? 0;
|
|
38
|
-
const documented = docRow?.c ?? 0;
|
|
39
|
-
const undocRows = db.all(
|
|
40
|
-
`SELECT gs.symbol, d.relative_path, der.start_line
|
|
41
|
-
FROM global_symbols gs
|
|
42
|
-
JOIN defn_enclosing_ranges der ON gs.id = der.symbol_id
|
|
43
|
-
JOIN documents d ON der.document_id = d.id
|
|
44
|
-
WHERE 1 = 1
|
|
45
|
-
${db.pathExclusionsFor("d")}
|
|
46
|
-
${db.symbolNoiseFor("gs")}
|
|
47
|
-
AND gs.symbol NOT LIKE '%#%'
|
|
48
|
-
AND (der.end_line - der.start_line + 1) >= ?
|
|
49
|
-
AND (gs.documentation IS NULL OR gs.documentation = '')
|
|
50
|
-
${scopeFilter}
|
|
51
|
-
ORDER BY d.relative_path, der.start_line
|
|
52
|
-
LIMIT ?`,
|
|
53
|
-
minLoc,
|
|
54
|
-
limit
|
|
55
|
-
);
|
|
56
|
-
return {
|
|
57
|
-
totalSymbols: total,
|
|
58
|
-
documented,
|
|
59
|
-
undocumented: total - documented,
|
|
60
|
-
coveragePercent: total > 0 ? Math.round(documented / total * 100) : 0,
|
|
61
|
-
undocumentedSymbols: undocRows.filter((r) => !db.isIgnored(r.relative_path)).map((r) => ({
|
|
62
|
-
symbol: r.symbol,
|
|
63
|
-
shortName: shortenSymbol(r.symbol),
|
|
64
|
-
relativePath: r.relative_path,
|
|
65
|
-
startLine: r.start_line
|
|
66
|
-
}))
|
|
67
|
-
};
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
export {
|
|
71
|
-
docCoverage
|
|
72
|
-
};
|
|
73
|
-
//# sourceMappingURL=chunk-YZ6L7GFO.js.map
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { S as ScipDatabase, n as DocCoverageResult } from '../db-ShvwGDKf.js';
|
|
2
|
-
import 'better-sqlite3';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Check documentation coverage: what percentage of symbols have doc strings?
|
|
6
|
-
* Reports overall stats and lists undocumented symbols.
|
|
7
|
-
*/
|
|
8
|
-
declare function docCoverage(db: ScipDatabase, opts?: {
|
|
9
|
-
scope?: string;
|
|
10
|
-
minLoc?: number;
|
|
11
|
-
limit?: number;
|
|
12
|
-
}): DocCoverageResult;
|
|
13
|
-
|
|
14
|
-
export { docCoverage };
|