@stevenvo780/st-lang 4.11.0 → 4.12.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/dist/proof-systems/fol-prover-advanced/index.d.ts +7 -0
- package/dist/proof-systems/fol-prover-advanced/index.d.ts.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/index.js +34 -0
- package/dist/proof-systems/fol-prover-advanced/index.js.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/ordering.d.ts +34 -0
- package/dist/proof-systems/fol-prover-advanced/ordering.d.ts.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/ordering.js +197 -0
- package/dist/proof-systems/fol-prover-advanced/ordering.js.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/prover.d.ts +22 -0
- package/dist/proof-systems/fol-prover-advanced/prover.d.ts.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/prover.js +219 -0
- package/dist/proof-systems/fol-prover-advanced/prover.js.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/resolve.d.ts +43 -0
- package/dist/proof-systems/fol-prover-advanced/resolve.d.ts.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/resolve.js +297 -0
- package/dist/proof-systems/fol-prover-advanced/resolve.js.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/subsumption.d.ts +28 -0
- package/dist/proof-systems/fol-prover-advanced/subsumption.d.ts.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/subsumption.js +172 -0
- package/dist/proof-systems/fol-prover-advanced/subsumption.js.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/types.d.ts +68 -0
- package/dist/proof-systems/fol-prover-advanced/types.d.ts.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/types.js +12 -0
- package/dist/proof-systems/fol-prover-advanced/types.js.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/unify.d.ts +15 -0
- package/dist/proof-systems/fol-prover-advanced/unify.d.ts.map +1 -0
- package/dist/proof-systems/fol-prover-advanced/unify.js +144 -0
- package/dist/proof-systems/fol-prover-advanced/unify.js.map +1 -0
- package/dist/reasoning/combinatorics/basic-counts.d.ts +6 -0
- package/dist/reasoning/combinatorics/basic-counts.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/basic-counts.js +82 -0
- package/dist/reasoning/combinatorics/basic-counts.js.map +1 -0
- package/dist/reasoning/combinatorics/bigint-helpers.d.ts +5 -0
- package/dist/reasoning/combinatorics/bigint-helpers.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/bigint-helpers.js +8 -0
- package/dist/reasoning/combinatorics/bigint-helpers.js.map +1 -0
- package/dist/reasoning/combinatorics/burnside.d.ts +15 -0
- package/dist/reasoning/combinatorics/burnside.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/burnside.js +91 -0
- package/dist/reasoning/combinatorics/burnside.js.map +1 -0
- package/dist/reasoning/combinatorics/generating-functions.d.ts +12 -0
- package/dist/reasoning/combinatorics/generating-functions.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/generating-functions.js +67 -0
- package/dist/reasoning/combinatorics/generating-functions.js.map +1 -0
- package/dist/reasoning/combinatorics/generators.d.ts +5 -0
- package/dist/reasoning/combinatorics/generators.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/generators.js +111 -0
- package/dist/reasoning/combinatorics/generators.js.map +1 -0
- package/dist/reasoning/combinatorics/inclusion-exclusion.d.ts +8 -0
- package/dist/reasoning/combinatorics/inclusion-exclusion.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/inclusion-exclusion.js +45 -0
- package/dist/reasoning/combinatorics/inclusion-exclusion.js.map +1 -0
- package/dist/reasoning/combinatorics/index.d.ts +10 -0
- package/dist/reasoning/combinatorics/index.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/index.js +44 -0
- package/dist/reasoning/combinatorics/index.js.map +1 -0
- package/dist/reasoning/combinatorics/partitions.d.ts +4 -0
- package/dist/reasoning/combinatorics/partitions.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/partitions.js +90 -0
- package/dist/reasoning/combinatorics/partitions.js.map +1 -0
- package/dist/reasoning/combinatorics/permutations.d.ts +6 -0
- package/dist/reasoning/combinatorics/permutations.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/permutations.js +124 -0
- package/dist/reasoning/combinatorics/permutations.js.map +1 -0
- package/dist/reasoning/combinatorics/set-partitions.d.ts +3 -0
- package/dist/reasoning/combinatorics/set-partitions.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/set-partitions.js +46 -0
- package/dist/reasoning/combinatorics/set-partitions.js.map +1 -0
- package/dist/reasoning/combinatorics/special-numbers.d.ts +7 -0
- package/dist/reasoning/combinatorics/special-numbers.d.ts.map +1 -0
- package/dist/reasoning/combinatorics/special-numbers.js +128 -0
- package/dist/reasoning/combinatorics/special-numbers.js.map +1 -0
- package/dist/reasoning/constructive-analysis/cauchy.d.ts +51 -0
- package/dist/reasoning/constructive-analysis/cauchy.d.ts.map +1 -0
- package/dist/reasoning/constructive-analysis/cauchy.js +77 -0
- package/dist/reasoning/constructive-analysis/cauchy.js.map +1 -0
- package/dist/reasoning/constructive-analysis/compact.d.ts +35 -0
- package/dist/reasoning/constructive-analysis/compact.d.ts.map +1 -0
- package/dist/reasoning/constructive-analysis/compact.js +61 -0
- package/dist/reasoning/constructive-analysis/compact.js.map +1 -0
- package/dist/reasoning/constructive-analysis/continuity.d.ts +62 -0
- package/dist/reasoning/constructive-analysis/continuity.d.ts.map +1 -0
- package/dist/reasoning/constructive-analysis/continuity.js +112 -0
- package/dist/reasoning/constructive-analysis/continuity.js.map +1 -0
- package/dist/reasoning/constructive-analysis/index.d.ts +24 -0
- package/dist/reasoning/constructive-analysis/index.d.ts.map +1 -0
- package/dist/reasoning/constructive-analysis/index.js +36 -0
- package/dist/reasoning/constructive-analysis/index.js.map +1 -0
- package/dist/reasoning/constructive-analysis/integral.d.ts +31 -0
- package/dist/reasoning/constructive-analysis/integral.d.ts.map +1 -0
- package/dist/reasoning/constructive-analysis/integral.js +59 -0
- package/dist/reasoning/constructive-analysis/integral.js.map +1 -0
- package/dist/reasoning/constructive-analysis/ivt.d.ts +41 -0
- package/dist/reasoning/constructive-analysis/ivt.d.ts.map +1 -0
- package/dist/reasoning/constructive-analysis/ivt.js +115 -0
- package/dist/reasoning/constructive-analysis/ivt.js.map +1 -0
- package/dist/reasoning/constructive-reals/index.d.ts +23 -0
- package/dist/reasoning/constructive-reals/index.d.ts.map +1 -1
- package/dist/reasoning/constructive-reals/index.js +52 -1
- package/dist/reasoning/constructive-reals/index.js.map +1 -1
- package/dist/reasoning/linear-algebra/index.d.ts +69 -0
- package/dist/reasoning/linear-algebra/index.d.ts.map +1 -0
- package/dist/reasoning/linear-algebra/index.js +859 -0
- package/dist/reasoning/linear-algebra/index.js.map +1 -0
- package/dist/reasoning/set-theory/hf-functions.d.ts +35 -0
- package/dist/reasoning/set-theory/hf-functions.d.ts.map +1 -0
- package/dist/reasoning/set-theory/hf-functions.js +147 -0
- package/dist/reasoning/set-theory/hf-functions.js.map +1 -0
- package/dist/reasoning/set-theory/hf-sets.d.ts +79 -0
- package/dist/reasoning/set-theory/hf-sets.d.ts.map +1 -0
- package/dist/reasoning/set-theory/hf-sets.js +338 -0
- package/dist/reasoning/set-theory/hf-sets.js.map +1 -0
- package/dist/reasoning/set-theory/index.d.ts +7 -0
- package/dist/reasoning/set-theory/index.d.ts.map +1 -0
- package/dist/reasoning/set-theory/index.js +44 -0
- package/dist/reasoning/set-theory/index.js.map +1 -0
- package/dist/reasoning/set-theory/zfc-axioms.d.ts +59 -0
- package/dist/reasoning/set-theory/zfc-axioms.d.ts.map +1 -0
- package/dist/reasoning/set-theory/zfc-axioms.js +245 -0
- package/dist/reasoning/set-theory/zfc-axioms.js.map +1 -0
- package/dist/tests/proof-systems/fol-prover-advanced/prover.test.d.ts +2 -0
- package/dist/tests/proof-systems/fol-prover-advanced/prover.test.d.ts.map +1 -0
- package/dist/tests/proof-systems/fol-prover-advanced/prover.test.js +253 -0
- package/dist/tests/proof-systems/fol-prover-advanced/prover.test.js.map +1 -0
- package/dist/tests/reasoning/combinatorics/combinatorics.test.d.ts +2 -0
- package/dist/tests/reasoning/combinatorics/combinatorics.test.d.ts.map +1 -0
- package/dist/tests/reasoning/combinatorics/combinatorics.test.js +256 -0
- package/dist/tests/reasoning/combinatorics/combinatorics.test.js.map +1 -0
- package/dist/tests/reasoning/constructive-analysis/constructive-analysis.test.d.ts +2 -0
- package/dist/tests/reasoning/constructive-analysis/constructive-analysis.test.d.ts.map +1 -0
- package/dist/tests/reasoning/constructive-analysis/constructive-analysis.test.js +174 -0
- package/dist/tests/reasoning/constructive-analysis/constructive-analysis.test.js.map +1 -0
- package/dist/tests/reasoning/linear-algebra/linear-algebra.test.d.ts +2 -0
- package/dist/tests/reasoning/linear-algebra/linear-algebra.test.d.ts.map +1 -0
- package/dist/tests/reasoning/linear-algebra/linear-algebra.test.js +369 -0
- package/dist/tests/reasoning/linear-algebra/linear-algebra.test.js.map +1 -0
- package/dist/tests/reasoning/set-theory/hf-functions.test.d.ts +2 -0
- package/dist/tests/reasoning/set-theory/hf-functions.test.d.ts.map +1 -0
- package/dist/tests/reasoning/set-theory/hf-functions.test.js +122 -0
- package/dist/tests/reasoning/set-theory/hf-functions.test.js.map +1 -0
- package/dist/tests/reasoning/set-theory/hf-sets.test.d.ts +2 -0
- package/dist/tests/reasoning/set-theory/hf-sets.test.d.ts.map +1 -0
- package/dist/tests/reasoning/set-theory/hf-sets.test.js +177 -0
- package/dist/tests/reasoning/set-theory/hf-sets.test.js.map +1 -0
- package/dist/tests/reasoning/set-theory/zfc-axioms.test.d.ts +2 -0
- package/dist/tests/reasoning/set-theory/zfc-axioms.test.d.ts.map +1 -0
- package/dist/tests/reasoning/set-theory/zfc-axioms.test.js +56 -0
- package/dist/tests/reasoning/set-theory/zfc-axioms.test.js.map +1 -0
- package/dist/tests/tooling/doc-gen/doc-gen.test.d.ts +2 -0
- package/dist/tests/tooling/doc-gen/doc-gen.test.d.ts.map +1 -0
- package/dist/tests/tooling/doc-gen/doc-gen.test.js +350 -0
- package/dist/tests/tooling/doc-gen/doc-gen.test.js.map +1 -0
- package/dist/tests/tooling/test-harness/test-harness.test.d.ts +2 -0
- package/dist/tests/tooling/test-harness/test-harness.test.d.ts.map +1 -0
- package/dist/tests/tooling/test-harness/test-harness.test.js +208 -0
- package/dist/tests/tooling/test-harness/test-harness.test.js.map +1 -0
- package/dist/tooling/doc-gen/extract.d.ts +13 -0
- package/dist/tooling/doc-gen/extract.d.ts.map +1 -0
- package/dist/tooling/doc-gen/extract.js +379 -0
- package/dist/tooling/doc-gen/extract.js.map +1 -0
- package/dist/tooling/doc-gen/generate.d.ts +9 -0
- package/dist/tooling/doc-gen/generate.d.ts.map +1 -0
- package/dist/tooling/doc-gen/generate.js +116 -0
- package/dist/tooling/doc-gen/generate.js.map +1 -0
- package/dist/tooling/doc-gen/index.d.ts +7 -0
- package/dist/tooling/doc-gen/index.d.ts.map +1 -0
- package/dist/tooling/doc-gen/index.js +39 -0
- package/dist/tooling/doc-gen/index.js.map +1 -0
- package/dist/tooling/doc-gen/jsdoc.d.ts +31 -0
- package/dist/tooling/doc-gen/jsdoc.d.ts.map +1 -0
- package/dist/tooling/doc-gen/jsdoc.js +140 -0
- package/dist/tooling/doc-gen/jsdoc.js.map +1 -0
- package/dist/tooling/doc-gen/render.d.ts +29 -0
- package/dist/tooling/doc-gen/render.d.ts.map +1 -0
- package/dist/tooling/doc-gen/render.js +206 -0
- package/dist/tooling/doc-gen/render.js.map +1 -0
- package/dist/tooling/doc-gen/types.d.ts +51 -0
- package/dist/tooling/doc-gen/types.d.ts.map +1 -0
- package/dist/tooling/doc-gen/types.js +10 -0
- package/dist/tooling/doc-gen/types.js.map +1 -0
- package/dist/tooling/test-harness/combinators.d.ts +14 -0
- package/dist/tooling/test-harness/combinators.d.ts.map +1 -0
- package/dist/tooling/test-harness/combinators.js +122 -0
- package/dist/tooling/test-harness/combinators.js.map +1 -0
- package/dist/tooling/test-harness/coverage.d.ts +3 -0
- package/dist/tooling/test-harness/coverage.d.ts.map +1 -0
- package/dist/tooling/test-harness/coverage.js +32 -0
- package/dist/tooling/test-harness/coverage.js.map +1 -0
- package/dist/tooling/test-harness/generators.d.ts +6 -0
- package/dist/tooling/test-harness/generators.d.ts.map +1 -0
- package/dist/tooling/test-harness/generators.js +66 -0
- package/dist/tooling/test-harness/generators.js.map +1 -0
- package/dist/tooling/test-harness/index.d.ts +7 -0
- package/dist/tooling/test-harness/index.d.ts.map +1 -0
- package/dist/tooling/test-harness/index.js +27 -0
- package/dist/tooling/test-harness/index.js.map +1 -0
- package/dist/tooling/test-harness/mutation.d.ts +4 -0
- package/dist/tooling/test-harness/mutation.d.ts.map +1 -0
- package/dist/tooling/test-harness/mutation.js +28 -0
- package/dist/tooling/test-harness/mutation.js.map +1 -0
- package/dist/tooling/test-harness/snapshot.d.ts +5 -0
- package/dist/tooling/test-harness/snapshot.d.ts.map +1 -0
- package/dist/tooling/test-harness/snapshot.js +86 -0
- package/dist/tooling/test-harness/snapshot.js.map +1 -0
- package/dist/tooling/test-harness/types.d.ts +32 -0
- package/dist/tooling/test-harness/types.d.ts.map +1 -0
- package/dist/tooling/test-harness/types.js +3 -0
- package/dist/tooling/test-harness/types.js.map +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,379 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// ============================================================
|
|
3
|
+
// Extractor — recorre los `.ts` de un rootDir con el TS Compiler
|
|
4
|
+
// API y construye un DocModule[] con todos los símbolos exportados
|
|
5
|
+
// (top-level) más su JSDoc/TSDoc asociado.
|
|
6
|
+
//
|
|
7
|
+
// Skip:
|
|
8
|
+
// - archivos de tests (`*.test.ts`, `src/tests/**`)
|
|
9
|
+
// - `index.ts` SIN re-export con doc propio (igual lo escaneamos,
|
|
10
|
+
// pero los re-exports sin doc no entran como ApiDoc — typescript
|
|
11
|
+
// los exporta sin nodo de declaración local).
|
|
12
|
+
// - símbolos no exportados, salvo `includeInternal: true`.
|
|
13
|
+
// ============================================================
|
|
14
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
15
|
+
if (k2 === undefined) k2 = k;
|
|
16
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
17
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
18
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
19
|
+
}
|
|
20
|
+
Object.defineProperty(o, k2, desc);
|
|
21
|
+
}) : (function(o, m, k, k2) {
|
|
22
|
+
if (k2 === undefined) k2 = k;
|
|
23
|
+
o[k2] = m[k];
|
|
24
|
+
}));
|
|
25
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
26
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
27
|
+
}) : function(o, v) {
|
|
28
|
+
o["default"] = v;
|
|
29
|
+
});
|
|
30
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
31
|
+
var ownKeys = function(o) {
|
|
32
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
33
|
+
var ar = [];
|
|
34
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
35
|
+
return ar;
|
|
36
|
+
};
|
|
37
|
+
return ownKeys(o);
|
|
38
|
+
};
|
|
39
|
+
return function (mod) {
|
|
40
|
+
if (mod && mod.__esModule) return mod;
|
|
41
|
+
var result = {};
|
|
42
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
43
|
+
__setModuleDefault(result, mod);
|
|
44
|
+
return result;
|
|
45
|
+
};
|
|
46
|
+
})();
|
|
47
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
48
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
49
|
+
};
|
|
50
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
51
|
+
exports.extractDocs = extractDocs;
|
|
52
|
+
const fs = __importStar(require("fs"));
|
|
53
|
+
const path = __importStar(require("path"));
|
|
54
|
+
const typescript_1 = __importDefault(require("typescript"));
|
|
55
|
+
const jsdoc_1 = require("./jsdoc");
|
|
56
|
+
/**
|
|
57
|
+
* Entrada principal. Recorre `rootDir` recursivamente, parsea cada
|
|
58
|
+
* archivo `.ts` y devuelve un `DocModule` por archivo con contenido.
|
|
59
|
+
*
|
|
60
|
+
* Archivos sin exports documentados se omiten (no aparecen en el
|
|
61
|
+
* resultado) para mantener el output compacto.
|
|
62
|
+
*/
|
|
63
|
+
function extractDocs(rootDir, opts = {}) {
|
|
64
|
+
const includeInternal = opts.includeInternal === true;
|
|
65
|
+
const absRoot = path.resolve(rootDir);
|
|
66
|
+
const files = collectTsFiles(absRoot);
|
|
67
|
+
const modules = [];
|
|
68
|
+
for (const file of files) {
|
|
69
|
+
const source = fs.readFileSync(file, 'utf8');
|
|
70
|
+
const sf = typescript_1.default.createSourceFile(file, source, typescript_1.default.ScriptTarget.ES2022, true, typescript_1.default.ScriptKind.TS);
|
|
71
|
+
const moduleRelPath = path.relative(absRoot, file).replace(/\\/g, '/');
|
|
72
|
+
const description = extractFileLevelDescription(sf, source);
|
|
73
|
+
const exports = extractFromSourceFile(sf, source, moduleRelPath, file, includeInternal);
|
|
74
|
+
if (exports.length === 0 && !description)
|
|
75
|
+
continue;
|
|
76
|
+
modules.push({
|
|
77
|
+
path: moduleRelPath,
|
|
78
|
+
description,
|
|
79
|
+
exports,
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
modules.sort((a, b) => a.path.localeCompare(b.path));
|
|
83
|
+
return modules;
|
|
84
|
+
}
|
|
85
|
+
function collectTsFiles(root) {
|
|
86
|
+
const out = [];
|
|
87
|
+
const stack = [root];
|
|
88
|
+
while (stack.length) {
|
|
89
|
+
const dir = stack.pop();
|
|
90
|
+
if (!dir)
|
|
91
|
+
continue;
|
|
92
|
+
let entries;
|
|
93
|
+
try {
|
|
94
|
+
entries = fs.readdirSync(dir, { withFileTypes: true });
|
|
95
|
+
}
|
|
96
|
+
catch {
|
|
97
|
+
continue;
|
|
98
|
+
}
|
|
99
|
+
for (const ent of entries) {
|
|
100
|
+
const full = path.join(dir, ent.name);
|
|
101
|
+
if (ent.isDirectory()) {
|
|
102
|
+
if (ent.name === 'node_modules' || ent.name === 'dist' || ent.name.startsWith('.')) {
|
|
103
|
+
continue;
|
|
104
|
+
}
|
|
105
|
+
if (ent.name === 'tests' || ent.name === '__tests__')
|
|
106
|
+
continue;
|
|
107
|
+
stack.push(full);
|
|
108
|
+
}
|
|
109
|
+
else if (ent.isFile()) {
|
|
110
|
+
if (!ent.name.endsWith('.ts'))
|
|
111
|
+
continue;
|
|
112
|
+
if (ent.name.endsWith('.d.ts'))
|
|
113
|
+
continue;
|
|
114
|
+
if (ent.name.endsWith('.test.ts') || ent.name.endsWith('.spec.ts'))
|
|
115
|
+
continue;
|
|
116
|
+
out.push(full);
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
out.sort();
|
|
121
|
+
return out;
|
|
122
|
+
}
|
|
123
|
+
function extractFileLevelDescription(sf, source) {
|
|
124
|
+
// Busca un bloque `/** ... */` que aparezca antes de la primera declaración.
|
|
125
|
+
const firstStatement = sf.statements[0];
|
|
126
|
+
const upTo = firstStatement ? firstStatement.getStart(sf) : source.length;
|
|
127
|
+
const head = source.slice(0, upTo);
|
|
128
|
+
const m = /\/\*\*([\s\S]*?)\*\//.exec(head);
|
|
129
|
+
if (!m) {
|
|
130
|
+
// También aceptamos comentarios `//` consecutivos al inicio.
|
|
131
|
+
const lines = head.split('\n');
|
|
132
|
+
const desc = [];
|
|
133
|
+
for (const line of lines) {
|
|
134
|
+
const t = line.trim();
|
|
135
|
+
if (t.startsWith('//')) {
|
|
136
|
+
const body = t.replace(/^\/+\s?/, '');
|
|
137
|
+
if (body)
|
|
138
|
+
desc.push(body);
|
|
139
|
+
}
|
|
140
|
+
else if (t === '') {
|
|
141
|
+
if (desc.length > 0)
|
|
142
|
+
continue;
|
|
143
|
+
}
|
|
144
|
+
else {
|
|
145
|
+
break;
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
if (desc.length === 0)
|
|
149
|
+
return undefined;
|
|
150
|
+
return desc.join(' ').trim() || undefined;
|
|
151
|
+
}
|
|
152
|
+
const cleaned = (0, jsdoc_1.stripCommentMarkers)(m[0]);
|
|
153
|
+
const parsed = (0, jsdoc_1.parseJSDoc)(cleaned);
|
|
154
|
+
// Si hay tag @fileoverview úsalo, si no, la description del bloque.
|
|
155
|
+
const fov = parsed.tags.find((t) => t.tag === 'fileoverview' || t.tag === 'file');
|
|
156
|
+
const desc = fov ? fov.content : parsed.description;
|
|
157
|
+
return desc.trim() || undefined;
|
|
158
|
+
}
|
|
159
|
+
function extractFromSourceFile(sf, source, modulePath, filePath, includeInternal) {
|
|
160
|
+
const ctx = {
|
|
161
|
+
source,
|
|
162
|
+
sf,
|
|
163
|
+
modulePath,
|
|
164
|
+
filePath,
|
|
165
|
+
includeInternal,
|
|
166
|
+
out: [],
|
|
167
|
+
};
|
|
168
|
+
for (const stmt of sf.statements) {
|
|
169
|
+
visitTopLevel(stmt, ctx);
|
|
170
|
+
}
|
|
171
|
+
return ctx.out;
|
|
172
|
+
}
|
|
173
|
+
function visitTopLevel(node, ctx) {
|
|
174
|
+
const exported = hasExportModifier(node);
|
|
175
|
+
if (!exported && !ctx.includeInternal)
|
|
176
|
+
return;
|
|
177
|
+
if (typescript_1.default.isFunctionDeclaration(node) && node.name) {
|
|
178
|
+
pushDoc(ctx, node, node.name.text, 'function');
|
|
179
|
+
return;
|
|
180
|
+
}
|
|
181
|
+
if (typescript_1.default.isClassDeclaration(node) && node.name) {
|
|
182
|
+
pushDoc(ctx, node, node.name.text, 'class');
|
|
183
|
+
return;
|
|
184
|
+
}
|
|
185
|
+
if (typescript_1.default.isInterfaceDeclaration(node)) {
|
|
186
|
+
pushDoc(ctx, node, node.name.text, 'interface');
|
|
187
|
+
return;
|
|
188
|
+
}
|
|
189
|
+
if (typescript_1.default.isTypeAliasDeclaration(node)) {
|
|
190
|
+
pushDoc(ctx, node, node.name.text, 'type');
|
|
191
|
+
return;
|
|
192
|
+
}
|
|
193
|
+
if (typescript_1.default.isEnumDeclaration(node)) {
|
|
194
|
+
pushDoc(ctx, node, node.name.text, 'enum');
|
|
195
|
+
return;
|
|
196
|
+
}
|
|
197
|
+
if (typescript_1.default.isModuleDeclaration(node) && node.name) {
|
|
198
|
+
const name = typescript_1.default.isIdentifier(node.name) ? node.name.text : node.name.text;
|
|
199
|
+
pushDoc(ctx, node, name, 'namespace');
|
|
200
|
+
return;
|
|
201
|
+
}
|
|
202
|
+
if (typescript_1.default.isVariableStatement(node)) {
|
|
203
|
+
for (const decl of node.declarationList.declarations) {
|
|
204
|
+
if (decl.name && typescript_1.default.isIdentifier(decl.name)) {
|
|
205
|
+
pushDoc(ctx, node, decl.name.text, 'const', decl);
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
return;
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
function hasExportModifier(node) {
|
|
212
|
+
const mods = node.modifiers;
|
|
213
|
+
if (!mods)
|
|
214
|
+
return false;
|
|
215
|
+
return mods.some((m) => m.kind === typescript_1.default.SyntaxKind.ExportKeyword);
|
|
216
|
+
}
|
|
217
|
+
function pushDoc(ctx, node, name, kind, detailNode) {
|
|
218
|
+
const exported = hasExportModifier(node);
|
|
219
|
+
const jsdoc = getJSDocFor(node, ctx.source);
|
|
220
|
+
const parsed = jsdoc ? (0, jsdoc_1.parseJSDoc)(jsdoc) : { description: '', tags: [] };
|
|
221
|
+
// @internal filter (cuando no se solicitó includeInternal)
|
|
222
|
+
if (!ctx.includeInternal && parsed.tags.some((t) => t.tag === 'internal'))
|
|
223
|
+
return;
|
|
224
|
+
const target = detailNode ?? node;
|
|
225
|
+
const signature = buildSignature(target, ctx.source);
|
|
226
|
+
const { line } = ctx.sf.getLineAndCharacterOfPosition(node.getStart(ctx.sf));
|
|
227
|
+
const doc = {
|
|
228
|
+
name,
|
|
229
|
+
kind,
|
|
230
|
+
description: parsed.description,
|
|
231
|
+
signature,
|
|
232
|
+
module: ctx.modulePath,
|
|
233
|
+
filePath: ctx.filePath,
|
|
234
|
+
lineNumber: line + 1,
|
|
235
|
+
exported,
|
|
236
|
+
};
|
|
237
|
+
const params = collectParameters(node, parsed);
|
|
238
|
+
if (params && params.length > 0)
|
|
239
|
+
doc.parameters = params;
|
|
240
|
+
const returns = collectReturns(node, parsed);
|
|
241
|
+
if (returns)
|
|
242
|
+
doc.returns = returns;
|
|
243
|
+
const examples = parsed.tags.filter((t) => t.tag === 'example').map((t) => t.content);
|
|
244
|
+
if (examples.length > 0)
|
|
245
|
+
doc.examples = examples;
|
|
246
|
+
const remarks = parsed.tags.find((t) => t.tag === 'remarks');
|
|
247
|
+
if (remarks)
|
|
248
|
+
doc.remarks = remarks.content;
|
|
249
|
+
const see = parsed.tags.filter((t) => t.tag === 'see').map((t) => t.content);
|
|
250
|
+
if (see.length > 0)
|
|
251
|
+
doc.see = see;
|
|
252
|
+
const deprecated = parsed.tags.find((t) => t.tag === 'deprecated');
|
|
253
|
+
if (deprecated)
|
|
254
|
+
doc.deprecated = true;
|
|
255
|
+
ctx.out.push(doc);
|
|
256
|
+
}
|
|
257
|
+
function getJSDocFor(node, source) {
|
|
258
|
+
// ts ofrece getJSDocCommentRanges sólo en internal API, usamos
|
|
259
|
+
// getLeadingCommentRanges + filtramos los que sean `/** ... */`.
|
|
260
|
+
const fullStart = node.getFullStart();
|
|
261
|
+
const ranges = typescript_1.default.getLeadingCommentRanges(source, fullStart);
|
|
262
|
+
if (!ranges || ranges.length === 0)
|
|
263
|
+
return undefined;
|
|
264
|
+
// El último range pegado al nodo es el "su" JSDoc.
|
|
265
|
+
const last = ranges[ranges.length - 1];
|
|
266
|
+
if (!last)
|
|
267
|
+
return undefined;
|
|
268
|
+
const raw = source.slice(last.pos, last.end);
|
|
269
|
+
if (!raw.startsWith('/**'))
|
|
270
|
+
return undefined;
|
|
271
|
+
return raw;
|
|
272
|
+
}
|
|
273
|
+
function buildSignature(node, source) {
|
|
274
|
+
// Para functions: hasta el final del header (signo `{` o `;`).
|
|
275
|
+
if (typescript_1.default.isFunctionDeclaration(node) || typescript_1.default.isMethodDeclaration(node)) {
|
|
276
|
+
return signatureFromFunctionLike(node, source);
|
|
277
|
+
}
|
|
278
|
+
if (typescript_1.default.isClassDeclaration(node)) {
|
|
279
|
+
// Solo el header `export class X<T> extends Y implements Z`.
|
|
280
|
+
const start = node.getStart();
|
|
281
|
+
const body = node.members.length > 0 ? node.members[0]?.getFullStart() : node.getEnd();
|
|
282
|
+
const headEnd = source.indexOf('{', start);
|
|
283
|
+
const end = headEnd > 0 ? headEnd : (body ?? node.getEnd());
|
|
284
|
+
return collapseWhitespace(source.slice(start, end));
|
|
285
|
+
}
|
|
286
|
+
if (typescript_1.default.isInterfaceDeclaration(node)) {
|
|
287
|
+
const start = node.getStart();
|
|
288
|
+
const headEnd = source.indexOf('{', start);
|
|
289
|
+
const end = headEnd > 0 ? headEnd : node.getEnd();
|
|
290
|
+
return collapseWhitespace(source.slice(start, end));
|
|
291
|
+
}
|
|
292
|
+
if (typescript_1.default.isTypeAliasDeclaration(node)) {
|
|
293
|
+
return collapseWhitespace(source.slice(node.getStart(), node.getEnd()));
|
|
294
|
+
}
|
|
295
|
+
if (typescript_1.default.isEnumDeclaration(node)) {
|
|
296
|
+
const start = node.getStart();
|
|
297
|
+
const headEnd = source.indexOf('{', start);
|
|
298
|
+
const end = headEnd > 0 ? headEnd : node.getEnd();
|
|
299
|
+
return collapseWhitespace(source.slice(start, end));
|
|
300
|
+
}
|
|
301
|
+
if (typescript_1.default.isVariableDeclaration(node)) {
|
|
302
|
+
// Reconstruye `const name: Type = ...` recortando inicializadores largos.
|
|
303
|
+
const name = node.name.getText();
|
|
304
|
+
const typeText = node.type ? `: ${node.type.getText()}` : '';
|
|
305
|
+
return `const ${name}${typeText}`;
|
|
306
|
+
}
|
|
307
|
+
if (typescript_1.default.isModuleDeclaration(node)) {
|
|
308
|
+
const start = node.getStart();
|
|
309
|
+
const headEnd = source.indexOf('{', start);
|
|
310
|
+
const end = headEnd > 0 ? headEnd : node.getEnd();
|
|
311
|
+
return collapseWhitespace(source.slice(start, end));
|
|
312
|
+
}
|
|
313
|
+
return collapseWhitespace(source.slice(node.getStart(), node.getEnd()));
|
|
314
|
+
}
|
|
315
|
+
function signatureFromFunctionLike(node, source) {
|
|
316
|
+
const start = node.getStart();
|
|
317
|
+
const bodyStart = node.body ? node.body.getFullStart() : node.getEnd();
|
|
318
|
+
let end = bodyStart;
|
|
319
|
+
// Recorta el `{` que abre el body.
|
|
320
|
+
const semi = source.lastIndexOf(';', end);
|
|
321
|
+
const brace = source.lastIndexOf('{', end);
|
|
322
|
+
if (brace > start)
|
|
323
|
+
end = brace;
|
|
324
|
+
else if (semi > start)
|
|
325
|
+
end = semi + 1;
|
|
326
|
+
return collapseWhitespace(source.slice(start, end));
|
|
327
|
+
}
|
|
328
|
+
function collapseWhitespace(s) {
|
|
329
|
+
return s.replace(/\s+/g, ' ').trim();
|
|
330
|
+
}
|
|
331
|
+
function collectParameters(node, parsed) {
|
|
332
|
+
let parameters;
|
|
333
|
+
if (typescript_1.default.isFunctionDeclaration(node) || typescript_1.default.isMethodDeclaration(node)) {
|
|
334
|
+
parameters = node.parameters;
|
|
335
|
+
}
|
|
336
|
+
else {
|
|
337
|
+
return undefined;
|
|
338
|
+
}
|
|
339
|
+
const paramTags = new Map();
|
|
340
|
+
for (const t of parsed.tags) {
|
|
341
|
+
if (t.tag !== 'param')
|
|
342
|
+
continue;
|
|
343
|
+
const parsedParam = (0, jsdoc_1.parseParamTag)(t.content);
|
|
344
|
+
if (parsedParam) {
|
|
345
|
+
paramTags.set(parsedParam.name, {
|
|
346
|
+
description: parsedParam.description,
|
|
347
|
+
optional: parsedParam.optional,
|
|
348
|
+
});
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
const out = [];
|
|
352
|
+
for (const p of parameters) {
|
|
353
|
+
const name = p.name.getText();
|
|
354
|
+
const type = p.type ? p.type.getText() : 'any';
|
|
355
|
+
const tag = paramTags.get(name);
|
|
356
|
+
out.push({
|
|
357
|
+
name,
|
|
358
|
+
type,
|
|
359
|
+
description: tag?.description ?? '',
|
|
360
|
+
optional: Boolean(p.questionToken) || tag?.optional === true || p.initializer != null,
|
|
361
|
+
});
|
|
362
|
+
}
|
|
363
|
+
return out;
|
|
364
|
+
}
|
|
365
|
+
function collectReturns(node, parsed) {
|
|
366
|
+
let typeText;
|
|
367
|
+
if ((typescript_1.default.isFunctionDeclaration(node) || typescript_1.default.isMethodDeclaration(node)) &&
|
|
368
|
+
node.type) {
|
|
369
|
+
typeText = node.type.getText();
|
|
370
|
+
}
|
|
371
|
+
const tag = parsed.tags.find((t) => t.tag === 'returns' || t.tag === 'return');
|
|
372
|
+
if (!typeText && !tag)
|
|
373
|
+
return undefined;
|
|
374
|
+
return {
|
|
375
|
+
type: typeText ?? 'unknown',
|
|
376
|
+
description: tag ? (0, jsdoc_1.parseReturnsTag)(tag.content) : '',
|
|
377
|
+
};
|
|
378
|
+
}
|
|
379
|
+
//# sourceMappingURL=extract.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extract.js","sourceRoot":"","sources":["../../../src/tooling/doc-gen/extract.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,iEAAiE;AACjE,mEAAmE;AACnE,2CAA2C;AAC3C,EAAE;AACF,QAAQ;AACR,qDAAqD;AACrD,mEAAmE;AACnE,oEAAoE;AACpE,iDAAiD;AACjD,4DAA4D;AAC5D,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoB/D,kCAsBC;AAxCD,uCAAyB;AACzB,2CAA6B;AAC7B,4DAA4B;AAG5B,mCAA0F;AAM1F;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,OAAe,EAAE,OAAuB,EAAE;IACpE,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,KAAK,IAAI,CAAC;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,OAAO,GAAgB,EAAE,CAAC;IAEhC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC7C,MAAM,EAAE,GAAG,oBAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,oBAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,oBAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC7F,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,2BAA2B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;QACxF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,WAAW;YAAE,SAAS;QACnD,OAAO,CAAC,IAAI,CAAC;YACX,IAAI,EAAE,aAAa;YACnB,WAAW;YACX,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,cAAc,CAAC,IAAY;IAClC,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;IACrB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,GAAG;YAAE,SAAS;QACnB,IAAI,OAAoB,CAAC;QACzB,IAAI,CAAC;YACH,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;YACtC,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;gBACtB,IAAI,GAAG,CAAC,IAAI,KAAK,cAAc,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACnF,SAAS;gBACX,CAAC;gBACD,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW;oBAAE,SAAS;gBAC/D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;iBAAM,IAAI,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC;gBACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;oBAAE,SAAS;gBACxC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;oBAAE,SAAS;gBACzC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;oBAAE,SAAS;gBAC7E,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;IACH,CAAC;IACD,GAAG,CAAC,IAAI,EAAE,CAAC;IACX,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,2BAA2B,CAAC,EAAiB,EAAE,MAAc;IACpE,6EAA6E;IAC7E,MAAM,cAAc,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IAC1E,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACnC,MAAM,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,6DAA6D;QAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBACtC,IAAI,IAAI;oBAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;iBAAM,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;gBACpB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;oBAAE,SAAS;YAChC,CAAC;iBAAM,CAAC;gBACN,MAAM;YACR,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IAC5C,CAAC;IACD,MAAM,OAAO,GAAG,IAAA,2BAAmB,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAA,kBAAU,EAAC,OAAO,CAAC,CAAC;IACnC,oEAAoE;IACpE,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,cAAc,IAAI,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC;IAClF,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC;IACpD,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;AAClC,CAAC;AAWD,SAAS,qBAAqB,CAC5B,EAAiB,EACjB,MAAc,EACd,UAAkB,EAClB,QAAgB,EAChB,eAAwB;IAExB,MAAM,GAAG,GAAiB;QACxB,MAAM;QACN,EAAE;QACF,UAAU;QACV,QAAQ;QACR,eAAe;QACf,GAAG,EAAE,EAAE;KACR,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QACjC,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,GAAG,CAAC,GAAG,CAAC;AACjB,CAAC;AAED,SAAS,aAAa,CAAC,IAAa,EAAE,GAAiB;IACrD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,eAAe;QAAE,OAAO;IAE9C,IAAI,oBAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAChD,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC/C,OAAO;IACT,CAAC;IACD,IAAI,oBAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAC7C,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO;IACT,CAAC;IACD,IAAI,oBAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,OAAO;IACT,CAAC;IACD,IAAI,oBAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,OAAO;IACT,CAAC;IACD,IAAI,oBAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,OAAO;IACT,CAAC;IACD,IAAI,oBAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,oBAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC1E,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QACtC,OAAO;IACT,CAAC;IACD,IAAI,oBAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QACjC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,CAAC;YACrD,IAAI,IAAI,CAAC,IAAI,IAAI,oBAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5C,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QACD,OAAO;IACT,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAa;IACtC,MAAM,IAAI,GAAI,IAAwB,CAAC,SAAS,CAAC;IACjD,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,OAAO,CACd,GAAiB,EACjB,IAAa,EACb,IAAY,EACZ,IAAa,EACb,UAAoB;IAEpB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAEzE,2DAA2D;IAC3D,IAAI,CAAC,GAAG,CAAC,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,UAAU,CAAC;QAAE,OAAO;IAElF,MAAM,MAAM,GAAG,UAAU,IAAI,IAAI,CAAC;IAClC,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC,6BAA6B,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAE7E,MAAM,GAAG,GAAW;QAClB,IAAI;QACJ,IAAI;QACJ,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,SAAS;QACT,MAAM,EAAE,GAAG,CAAC,UAAU;QACtB,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,UAAU,EAAE,IAAI,GAAG,CAAC;QACpB,QAAQ;KACT,CAAC;IAEF,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC/C,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC;IAEzD,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7C,IAAI,OAAO;QAAE,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;IAEnC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IACtF,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAEjD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC;IAC7D,IAAI,OAAO;QAAE,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE3C,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAC7E,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;IAElC,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC,CAAC;IACnE,IAAI,UAAU;QAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,WAAW,CAAC,IAAa,EAAE,MAAc;IAChD,+DAA+D;IAC/D,iEAAiE;IACjE,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,oBAAE,CAAC,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC7D,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACrD,mDAAmD;IACnD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC7C,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,cAAc,CAAC,IAAa,EAAE,MAAc;IACnD,+DAA+D;IAC/D,IAAI,oBAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,oBAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnE,OAAO,yBAAyB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,oBAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,6DAA6D;QAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACvF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC5D,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,oBAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAClD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,oBAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,oBAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAClD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,oBAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,0EAA0E;QAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,OAAO,SAAS,IAAI,GAAG,QAAQ,EAAE,CAAC;IACpC,CAAC;IACD,IAAI,oBAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAClD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,yBAAyB,CAAC,IAAgC,EAAE,MAAc;IACjF,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IACvE,IAAI,GAAG,GAAG,SAAS,CAAC;IACpB,mCAAmC;IACnC,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC3C,IAAI,KAAK,GAAG,KAAK;QAAE,GAAG,GAAG,KAAK,CAAC;SAC1B,IAAI,IAAI,GAAG,KAAK;QAAE,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC;IACtC,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,kBAAkB,CAAC,CAAS;IACnC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACvC,CAAC;AAED,SAAS,iBAAiB,CACxB,IAAa,EACb,MAAoD;IAEpD,IAAI,UAA6D,CAAC;IAClE,IAAI,oBAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,oBAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnE,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAsD,CAAC;IAChF,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO;YAAE,SAAS;QAChC,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,WAAW,EAAE,CAAC;YAChB,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC9B,WAAW,EAAE,WAAW,CAAC,WAAW;gBACpC,QAAQ,EAAE,WAAW,CAAC,QAAQ;aAC/B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAmB,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC/C,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,GAAG,CAAC,IAAI,CAAC;YACP,IAAI;YACJ,IAAI;YACJ,WAAW,EAAE,GAAG,EAAE,WAAW,IAAI,EAAE;YACnC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,GAAG,EAAE,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,WAAW,IAAI,IAAI;SACtF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,cAAc,CACrB,IAAa,EACb,MAAoD;IAEpD,IAAI,QAA4B,CAAC;IACjC,IACE,CAAC,oBAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,oBAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAmC,CAAC,IAAI,EACzC,CAAC;QACD,QAAQ,GAAK,IAAmC,CAAC,IAAoB,CAAC,OAAO,EAAE,CAAC;IAClF,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;IAC/E,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO;QACL,IAAI,EAAE,QAAQ,IAAI,SAAS;QAC3B,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,IAAA,uBAAe,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;KACrD,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { DocOptions, GenerateResult } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Genera documentación a disco según `opts.template`. Crea
|
|
4
|
+
* `outputDir` y subdirectorios necesarios.
|
|
5
|
+
*
|
|
6
|
+
* El default cuando `template` no se especifica es `'markdown'`.
|
|
7
|
+
*/
|
|
8
|
+
export declare function generateDocs(opts: DocOptions): Promise<GenerateResult>;
|
|
9
|
+
//# sourceMappingURL=generate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../../src/tooling/doc-gen/generate.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAa,UAAU,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAErE;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,CA8B5E"}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// ============================================================
|
|
3
|
+
// generateDocs — glue.
|
|
4
|
+
//
|
|
5
|
+
// extractDocs → render(markdown|json|html-minimal) → escribe a
|
|
6
|
+
// outputDir, devolviendo lista de archivos y warnings detectados
|
|
7
|
+
// durante el proceso (símbolos sin descripción, etc.).
|
|
8
|
+
// ============================================================
|
|
9
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
12
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
13
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
14
|
+
}
|
|
15
|
+
Object.defineProperty(o, k2, desc);
|
|
16
|
+
}) : (function(o, m, k, k2) {
|
|
17
|
+
if (k2 === undefined) k2 = k;
|
|
18
|
+
o[k2] = m[k];
|
|
19
|
+
}));
|
|
20
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
21
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
22
|
+
}) : function(o, v) {
|
|
23
|
+
o["default"] = v;
|
|
24
|
+
});
|
|
25
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
26
|
+
var ownKeys = function(o) {
|
|
27
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
28
|
+
var ar = [];
|
|
29
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
30
|
+
return ar;
|
|
31
|
+
};
|
|
32
|
+
return ownKeys(o);
|
|
33
|
+
};
|
|
34
|
+
return function (mod) {
|
|
35
|
+
if (mod && mod.__esModule) return mod;
|
|
36
|
+
var result = {};
|
|
37
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
38
|
+
__setModuleDefault(result, mod);
|
|
39
|
+
return result;
|
|
40
|
+
};
|
|
41
|
+
})();
|
|
42
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
43
|
+
exports.generateDocs = generateDocs;
|
|
44
|
+
const fs = __importStar(require("fs/promises"));
|
|
45
|
+
const path = __importStar(require("path"));
|
|
46
|
+
const extract_1 = require("./extract");
|
|
47
|
+
const render_1 = require("./render");
|
|
48
|
+
/**
|
|
49
|
+
* Genera documentación a disco según `opts.template`. Crea
|
|
50
|
+
* `outputDir` y subdirectorios necesarios.
|
|
51
|
+
*
|
|
52
|
+
* El default cuando `template` no se especifica es `'markdown'`.
|
|
53
|
+
*/
|
|
54
|
+
async function generateDocs(opts) {
|
|
55
|
+
const includeInternal = opts.includeInternal === true;
|
|
56
|
+
const modules = (0, extract_1.extractDocs)(opts.rootDir, { includeInternal });
|
|
57
|
+
const template = opts.template ?? 'markdown';
|
|
58
|
+
const warnings = collectWarnings(modules);
|
|
59
|
+
const filesWritten = [];
|
|
60
|
+
await fs.mkdir(opts.outputDir, { recursive: true });
|
|
61
|
+
if (template === 'markdown') {
|
|
62
|
+
const files = (0, render_1.renderMarkdown)(modules);
|
|
63
|
+
for (const [relPath, content] of files) {
|
|
64
|
+
const abs = path.join(opts.outputDir, relPath);
|
|
65
|
+
await fs.mkdir(path.dirname(abs), { recursive: true });
|
|
66
|
+
await fs.writeFile(abs, content, 'utf8');
|
|
67
|
+
filesWritten.push(abs);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
else if (template === 'json') {
|
|
71
|
+
const abs = path.join(opts.outputDir, 'api.json');
|
|
72
|
+
await fs.writeFile(abs, (0, render_1.renderJSON)(modules), 'utf8');
|
|
73
|
+
filesWritten.push(abs);
|
|
74
|
+
}
|
|
75
|
+
else if (template === 'html-minimal') {
|
|
76
|
+
const indexHtml = renderHtmlMinimal(modules);
|
|
77
|
+
const abs = path.join(opts.outputDir, 'index.html');
|
|
78
|
+
await fs.writeFile(abs, indexHtml, 'utf8');
|
|
79
|
+
filesWritten.push(abs);
|
|
80
|
+
}
|
|
81
|
+
return { filesWritten, warnings };
|
|
82
|
+
}
|
|
83
|
+
function collectWarnings(modules) {
|
|
84
|
+
const out = [];
|
|
85
|
+
for (const mod of modules) {
|
|
86
|
+
for (const sym of mod.exports) {
|
|
87
|
+
if (!sym.description) {
|
|
88
|
+
out.push(`${mod.path}:${sym.lineNumber}: ${sym.kind} \`${sym.name}\` sin descripción`);
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
return out;
|
|
93
|
+
}
|
|
94
|
+
function renderHtmlMinimal(modules) {
|
|
95
|
+
const md = (0, render_1.renderIndex)(modules);
|
|
96
|
+
// Minimal HTML que embebe el index como <pre>. Útil para preview
|
|
97
|
+
// rápida sin pipeline de Markdown.
|
|
98
|
+
const escaped = md.replace(/[&<>]/g, (c) => {
|
|
99
|
+
if (c === '&')
|
|
100
|
+
return '&';
|
|
101
|
+
if (c === '<')
|
|
102
|
+
return '<';
|
|
103
|
+
return '>';
|
|
104
|
+
});
|
|
105
|
+
return [
|
|
106
|
+
'<!doctype html>',
|
|
107
|
+
'<html lang="en">',
|
|
108
|
+
'<head><meta charset="utf-8"><title>API Reference</title></head>',
|
|
109
|
+
'<body><pre style="font:14px/1.4 monospace">',
|
|
110
|
+
escaped,
|
|
111
|
+
'</pre></body>',
|
|
112
|
+
'</html>',
|
|
113
|
+
'',
|
|
114
|
+
].join('\n');
|
|
115
|
+
}
|
|
116
|
+
//# sourceMappingURL=generate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/tooling/doc-gen/generate.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,uBAAuB;AACvB,EAAE;AACF,+DAA+D;AAC/D,iEAAiE;AACjE,uDAAuD;AACvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAe/D,oCA8BC;AA3CD,gDAAkC;AAClC,2CAA6B;AAE7B,uCAAwC;AACxC,qCAAmE;AAGnE;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,IAAgB;IACjD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,KAAK,IAAI,CAAC;IACtD,MAAM,OAAO,GAAG,IAAA,qBAAW,EAAC,IAAI,CAAC,OAAO,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC;IAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC;IAE7C,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,YAAY,GAAa,EAAE,CAAC;IAElC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEpD,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAA,uBAAc,EAAC,OAAO,CAAC,CAAC;QACtC,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;YACvC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC/C,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YACzC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;SAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAClD,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,IAAA,mBAAU,EAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;QACrD,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;SAAM,IAAI,QAAQ,KAAK,cAAc,EAAE,CAAC;QACvC,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACpD,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC3C,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;AACpC,CAAC;AAED,SAAS,eAAe,CAAC,OAAoB;IAC3C,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;gBACrB,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,oBAAoB,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAoB;IAC7C,MAAM,EAAE,GAAG,IAAA,oBAAW,EAAC,OAAO,CAAC,CAAC;IAChC,iEAAiE;IACjE,mCAAmC;IACnC,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;QACzC,IAAI,CAAC,KAAK,GAAG;YAAE,OAAO,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG;YAAE,OAAO,MAAM,CAAC;QAC7B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,OAAO;QACL,iBAAiB;QACjB,kBAAkB;QAClB,iEAAiE;QACjE,6CAA6C;QAC7C,OAAO;QACP,eAAe;QACf,SAAS;QACT,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export type { ApiDoc, ApiKind, ApiParameter, ApiReturns, DocModule, DocOptions, GenerateResult, JSDocTag, ParsedJSDoc, } from './types';
|
|
2
|
+
export { parseJSDoc, parseParamTag, parseReturnsTag, stripCommentMarkers } from './jsdoc';
|
|
3
|
+
export { extractDocs } from './extract';
|
|
4
|
+
export type { ExtractOptions } from './extract';
|
|
5
|
+
export { renderMarkdown, renderJSON, renderIndex, toMarkdownPath } from './render';
|
|
6
|
+
export { generateDocs } from './generate';
|
|
7
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tooling/doc-gen/index.ts"],"names":[],"mappings":"AAsBA,YAAY,EACV,MAAM,EACN,OAAO,EACP,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,cAAc,EACd,QAAQ,EACR,WAAW,GACZ,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC1F,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACnF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// ============================================================
|
|
3
|
+
// ST doc-gen — generador de documentación de API.
|
|
4
|
+
//
|
|
5
|
+
// Toma JSDoc/TSDoc de fuentes TypeScript usando el TS Compiler
|
|
6
|
+
// API y produce Markdown (o JSON, o HTML minimal) por módulo.
|
|
7
|
+
//
|
|
8
|
+
// Uso típico:
|
|
9
|
+
//
|
|
10
|
+
// ```ts
|
|
11
|
+
// import { generateDocs } from '@stevenvo780/st-lang/tooling/doc-gen';
|
|
12
|
+
// await generateDocs({
|
|
13
|
+
// rootDir: 'src',
|
|
14
|
+
// outputDir: 'docs/api',
|
|
15
|
+
// template: 'markdown',
|
|
16
|
+
// });
|
|
17
|
+
// ```
|
|
18
|
+
//
|
|
19
|
+
// La librería NO empaqueta a `dist/` un binario CLI; la idea es
|
|
20
|
+
// invocarla desde scripts (`scripts/build-docs.mjs`) o desde un
|
|
21
|
+
// task externo.
|
|
22
|
+
// ============================================================
|
|
23
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
24
|
+
exports.generateDocs = exports.toMarkdownPath = exports.renderIndex = exports.renderJSON = exports.renderMarkdown = exports.extractDocs = exports.stripCommentMarkers = exports.parseReturnsTag = exports.parseParamTag = exports.parseJSDoc = void 0;
|
|
25
|
+
var jsdoc_1 = require("./jsdoc");
|
|
26
|
+
Object.defineProperty(exports, "parseJSDoc", { enumerable: true, get: function () { return jsdoc_1.parseJSDoc; } });
|
|
27
|
+
Object.defineProperty(exports, "parseParamTag", { enumerable: true, get: function () { return jsdoc_1.parseParamTag; } });
|
|
28
|
+
Object.defineProperty(exports, "parseReturnsTag", { enumerable: true, get: function () { return jsdoc_1.parseReturnsTag; } });
|
|
29
|
+
Object.defineProperty(exports, "stripCommentMarkers", { enumerable: true, get: function () { return jsdoc_1.stripCommentMarkers; } });
|
|
30
|
+
var extract_1 = require("./extract");
|
|
31
|
+
Object.defineProperty(exports, "extractDocs", { enumerable: true, get: function () { return extract_1.extractDocs; } });
|
|
32
|
+
var render_1 = require("./render");
|
|
33
|
+
Object.defineProperty(exports, "renderMarkdown", { enumerable: true, get: function () { return render_1.renderMarkdown; } });
|
|
34
|
+
Object.defineProperty(exports, "renderJSON", { enumerable: true, get: function () { return render_1.renderJSON; } });
|
|
35
|
+
Object.defineProperty(exports, "renderIndex", { enumerable: true, get: function () { return render_1.renderIndex; } });
|
|
36
|
+
Object.defineProperty(exports, "toMarkdownPath", { enumerable: true, get: function () { return render_1.toMarkdownPath; } });
|
|
37
|
+
var generate_1 = require("./generate");
|
|
38
|
+
Object.defineProperty(exports, "generateDocs", { enumerable: true, get: function () { return generate_1.generateDocs; } });
|
|
39
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tooling/doc-gen/index.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,kDAAkD;AAClD,EAAE;AACF,+DAA+D;AAC/D,8DAA8D;AAC9D,EAAE;AACF,cAAc;AACd,EAAE;AACF,QAAQ;AACR,uEAAuE;AACvE,uBAAuB;AACvB,oBAAoB;AACpB,2BAA2B;AAC3B,0BAA0B;AAC1B,MAAM;AACN,MAAM;AACN,EAAE;AACF,gEAAgE;AAChE,gEAAgE;AAChE,gBAAgB;AAChB,+DAA+D;;;AAc/D,iCAA0F;AAAjF,mGAAA,UAAU,OAAA;AAAE,sGAAA,aAAa,OAAA;AAAE,wGAAA,eAAe,OAAA;AAAE,4GAAA,mBAAmB,OAAA;AACxE,qCAAwC;AAA/B,sGAAA,WAAW,OAAA;AAEpB,mCAAmF;AAA1E,wGAAA,cAAc,OAAA;AAAE,oGAAA,UAAU,OAAA;AAAE,qGAAA,WAAW,OAAA;AAAE,wGAAA,cAAc,OAAA;AAChE,uCAA0C;AAAjC,wGAAA,YAAY,OAAA"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { ParsedJSDoc } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Quita los marcadores `/**`, `*\/` y el `*` líder de cada línea
|
|
4
|
+
* para dejar el contenido textual del comentario.
|
|
5
|
+
*/
|
|
6
|
+
export declare function stripCommentMarkers(raw: string): string;
|
|
7
|
+
/**
|
|
8
|
+
* Parsea un comentario JSDoc/TSDoc en `description` + `tags`.
|
|
9
|
+
* Acepta tanto el raw con `/** ... *\/` como el contenido ya limpio.
|
|
10
|
+
*
|
|
11
|
+
* Cada tag se reconoce con la heurística clásica de TypeDoc/TSDoc:
|
|
12
|
+
* una línea que empieza con `@<word>` abre un nuevo tag y consume
|
|
13
|
+
* todas las líneas siguientes hasta el próximo `@<word>` o EOF.
|
|
14
|
+
*/
|
|
15
|
+
export declare function parseJSDoc(comment: string): ParsedJSDoc;
|
|
16
|
+
/**
|
|
17
|
+
* `@param name description` → { name, description, optional }.
|
|
18
|
+
*
|
|
19
|
+
* También soporta el formato con tipo `@param {Type} name desc` aunque
|
|
20
|
+
* los tipos reales los tomamos del compilador, no del JSDoc.
|
|
21
|
+
*/
|
|
22
|
+
export declare function parseParamTag(content: string): {
|
|
23
|
+
name: string;
|
|
24
|
+
description: string;
|
|
25
|
+
optional: boolean;
|
|
26
|
+
} | null;
|
|
27
|
+
/**
|
|
28
|
+
* `@returns description` → description string.
|
|
29
|
+
*/
|
|
30
|
+
export declare function parseReturnsTag(content: string): string;
|
|
31
|
+
//# sourceMappingURL=jsdoc.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jsdoc.d.ts","sourceRoot":"","sources":["../../../src/tooling/doc-gen/jsdoc.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAY,WAAW,EAAE,MAAM,SAAS,CAAC;AAErD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAevD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CA6BvD;AASD;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,MAAM,GACd;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,CAgCjE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAQvD"}
|