@stevenvo780/st-lang 4.10.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/distributed-exchange/index.d.ts +101 -0
- package/dist/proof-systems/distributed-exchange/index.d.ts.map +1 -0
- package/dist/proof-systems/distributed-exchange/index.js +408 -0
- package/dist/proof-systems/distributed-exchange/index.js.map +1 -0
- 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/graph-theory/index.d.ts +63 -0
- package/dist/reasoning/graph-theory/index.d.ts.map +1 -0
- package/dist/reasoning/graph-theory/index.js +1043 -0
- package/dist/reasoning/graph-theory/index.js.map +1 -0
- package/dist/reasoning/group-presentation/cayley.d.ts +8 -0
- package/dist/reasoning/group-presentation/cayley.d.ts.map +1 -0
- package/dist/reasoning/group-presentation/cayley.js +38 -0
- package/dist/reasoning/group-presentation/cayley.js.map +1 -0
- package/dist/reasoning/group-presentation/index.d.ts +8 -0
- package/dist/reasoning/group-presentation/index.d.ts.map +1 -0
- package/dist/reasoning/group-presentation/index.js +36 -0
- package/dist/reasoning/group-presentation/index.js.map +1 -0
- package/dist/reasoning/group-presentation/standard-groups.d.ts +6 -0
- package/dist/reasoning/group-presentation/standard-groups.d.ts.map +1 -0
- package/dist/reasoning/group-presentation/standard-groups.js +93 -0
- package/dist/reasoning/group-presentation/standard-groups.js.map +1 -0
- package/dist/reasoning/group-presentation/todd-coxeter.d.ts +10 -0
- package/dist/reasoning/group-presentation/todd-coxeter.d.ts.map +1 -0
- package/dist/reasoning/group-presentation/todd-coxeter.js +362 -0
- package/dist/reasoning/group-presentation/todd-coxeter.js.map +1 -0
- package/dist/reasoning/group-presentation/types.d.ts +7 -0
- package/dist/reasoning/group-presentation/types.d.ts.map +1 -0
- package/dist/reasoning/group-presentation/types.js +22 -0
- package/dist/reasoning/group-presentation/types.js.map +1 -0
- package/dist/reasoning/group-presentation/words.d.ts +10 -0
- package/dist/reasoning/group-presentation/words.d.ts.map +1 -0
- package/dist/reasoning/group-presentation/words.js +109 -0
- package/dist/reasoning/group-presentation/words.js.map +1 -0
- 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/distributed-exchange/distributed-exchange.test.d.ts +2 -0
- package/dist/tests/proof-systems/distributed-exchange/distributed-exchange.test.d.ts.map +1 -0
- package/dist/tests/proof-systems/distributed-exchange/distributed-exchange.test.js +328 -0
- package/dist/tests/proof-systems/distributed-exchange/distributed-exchange.test.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/graph-theory/graph-theory.test.d.ts +2 -0
- package/dist/tests/reasoning/graph-theory/graph-theory.test.d.ts.map +1 -0
- package/dist/tests/reasoning/graph-theory/graph-theory.test.js +363 -0
- package/dist/tests/reasoning/graph-theory/graph-theory.test.js.map +1 -0
- package/dist/tests/reasoning/group-presentation/group-presentation.test.d.ts +2 -0
- package/dist/tests/reasoning/group-presentation/group-presentation.test.d.ts.map +1 -0
- package/dist/tests/reasoning/group-presentation/group-presentation.test.js +229 -0
- package/dist/tests/reasoning/group-presentation/group-presentation.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/exporters/coq-v2/coq-v2-exporter.test.d.ts +2 -0
- package/dist/tests/tooling/exporters/coq-v2/coq-v2-exporter.test.d.ts.map +1 -0
- package/dist/tests/tooling/exporters/coq-v2/coq-v2-exporter.test.js +411 -0
- package/dist/tests/tooling/exporters/coq-v2/coq-v2-exporter.test.js.map +1 -0
- package/dist/tests/tooling/lemma-library/lemma-library.test.d.ts +2 -0
- package/dist/tests/tooling/lemma-library/lemma-library.test.d.ts.map +1 -0
- package/dist/tests/tooling/lemma-library/lemma-library.test.js +197 -0
- package/dist/tests/tooling/lemma-library/lemma-library.test.js.map +1 -0
- package/dist/tests/tooling/provenance/ledger.test.d.ts +2 -0
- package/dist/tests/tooling/provenance/ledger.test.d.ts.map +1 -0
- package/dist/tests/tooling/provenance/ledger.test.js +545 -0
- package/dist/tests/tooling/provenance/ledger.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/exporters/coq-v2/index.d.ts +68 -0
- package/dist/tooling/exporters/coq-v2/index.d.ts.map +1 -0
- package/dist/tooling/exporters/coq-v2/index.js +692 -0
- package/dist/tooling/exporters/coq-v2/index.js.map +1 -0
- package/dist/tooling/lemma-library/apply.d.ts +9 -0
- package/dist/tooling/lemma-library/apply.d.ts.map +1 -0
- package/dist/tooling/lemma-library/apply.js +94 -0
- package/dist/tooling/lemma-library/apply.js.map +1 -0
- package/dist/tooling/lemma-library/arithmetic.d.ts +3 -0
- package/dist/tooling/lemma-library/arithmetic.d.ts.map +1 -0
- package/dist/tooling/lemma-library/arithmetic.js +176 -0
- package/dist/tooling/lemma-library/arithmetic.js.map +1 -0
- package/dist/tooling/lemma-library/firstorder.d.ts +3 -0
- package/dist/tooling/lemma-library/firstorder.d.ts.map +1 -0
- package/dist/tooling/lemma-library/firstorder.js +136 -0
- package/dist/tooling/lemma-library/firstorder.js.map +1 -0
- package/dist/tooling/lemma-library/index.d.ts +13 -0
- package/dist/tooling/lemma-library/index.d.ts.map +1 -0
- package/dist/tooling/lemma-library/index.js +32 -0
- package/dist/tooling/lemma-library/index.js.map +1 -0
- package/dist/tooling/lemma-library/library.d.ts +34 -0
- package/dist/tooling/lemma-library/library.d.ts.map +1 -0
- package/dist/tooling/lemma-library/library.js +126 -0
- package/dist/tooling/lemma-library/library.js.map +1 -0
- package/dist/tooling/lemma-library/modal.d.ts +3 -0
- package/dist/tooling/lemma-library/modal.d.ts.map +1 -0
- package/dist/tooling/lemma-library/modal.js +138 -0
- package/dist/tooling/lemma-library/modal.js.map +1 -0
- package/dist/tooling/lemma-library/propositional.d.ts +3 -0
- package/dist/tooling/lemma-library/propositional.d.ts.map +1 -0
- package/dist/tooling/lemma-library/propositional.js +265 -0
- package/dist/tooling/lemma-library/propositional.js.map +1 -0
- package/dist/tooling/lemma-library/set-theory.d.ts +3 -0
- package/dist/tooling/lemma-library/set-theory.d.ts.map +1 -0
- package/dist/tooling/lemma-library/set-theory.js +134 -0
- package/dist/tooling/lemma-library/set-theory.js.map +1 -0
- package/dist/tooling/lemma-library/standard.d.ts +3 -0
- package/dist/tooling/lemma-library/standard.d.ts.map +1 -0
- package/dist/tooling/lemma-library/standard.js +27 -0
- package/dist/tooling/lemma-library/standard.js.map +1 -0
- package/dist/tooling/lemma-library/tfidf.d.ts +5 -0
- package/dist/tooling/lemma-library/tfidf.d.ts.map +1 -0
- package/dist/tooling/lemma-library/tfidf.js +100 -0
- package/dist/tooling/lemma-library/tfidf.js.map +1 -0
- package/dist/tooling/lemma-library/tokenize.d.ts +2 -0
- package/dist/tooling/lemma-library/tokenize.d.ts.map +1 -0
- package/dist/tooling/lemma-library/tokenize.js +74 -0
- package/dist/tooling/lemma-library/tokenize.js.map +1 -0
- package/dist/tooling/lemma-library/types.d.ts +53 -0
- package/dist/tooling/lemma-library/types.d.ts.map +1 -0
- package/dist/tooling/lemma-library/types.js +10 -0
- package/dist/tooling/lemma-library/types.js.map +1 -0
- package/dist/tooling/provenance/index.d.ts +3 -0
- package/dist/tooling/provenance/index.d.ts.map +1 -0
- package/dist/tooling/provenance/index.js +16 -0
- package/dist/tooling/provenance/index.js.map +1 -0
- package/dist/tooling/provenance/ledger.d.ts +89 -0
- package/dist/tooling/provenance/ledger.d.ts.map +1 -0
- package/dist/tooling/provenance/ledger.js +439 -0
- package/dist/tooling/provenance/ledger.js.map +1 -0
- package/dist/tooling/provenance/types.d.ts +70 -0
- package/dist/tooling/provenance/types.d.ts.map +1 -0
- package/dist/tooling/provenance/types.js +14 -0
- package/dist/tooling/provenance/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,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"}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// ============================================================
|
|
3
|
+
// JSDoc/TSDoc parser ligero.
|
|
4
|
+
//
|
|
5
|
+
// Tomamos el rawText de un JSDoc (incluyendo `/** ... */`) o el
|
|
6
|
+
// cuerpo limpio que ya entrega ts.getJSDocCommentRanges, y lo
|
|
7
|
+
// partimos en `description` + lista de `tags`.
|
|
8
|
+
//
|
|
9
|
+
// Soporta tags comunes: @param, @returns/@return, @example,
|
|
10
|
+
// @remarks, @see, @deprecated, @internal, @public, @beta,
|
|
11
|
+
// @experimental.
|
|
12
|
+
// ============================================================
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.stripCommentMarkers = stripCommentMarkers;
|
|
15
|
+
exports.parseJSDoc = parseJSDoc;
|
|
16
|
+
exports.parseParamTag = parseParamTag;
|
|
17
|
+
exports.parseReturnsTag = parseReturnsTag;
|
|
18
|
+
/**
|
|
19
|
+
* Quita los marcadores `/**`, `*\/` y el `*` líder de cada línea
|
|
20
|
+
* para dejar el contenido textual del comentario.
|
|
21
|
+
*/
|
|
22
|
+
function stripCommentMarkers(raw) {
|
|
23
|
+
let s = raw.trim();
|
|
24
|
+
if (s.startsWith('/**'))
|
|
25
|
+
s = s.slice(3);
|
|
26
|
+
else if (s.startsWith('/*'))
|
|
27
|
+
s = s.slice(2);
|
|
28
|
+
if (s.endsWith('*/'))
|
|
29
|
+
s = s.slice(0, -2);
|
|
30
|
+
// Quita el `*` líder por línea (con el espacio opcional).
|
|
31
|
+
const lines = s.split('\n').map((line) => {
|
|
32
|
+
const m = /^\s*\*\s?(.*)$/.exec(line);
|
|
33
|
+
return m ? (m[1] ?? '') : line;
|
|
34
|
+
});
|
|
35
|
+
// Trim final pero preservando saltos internos.
|
|
36
|
+
return lines
|
|
37
|
+
.join('\n')
|
|
38
|
+
.replace(/^\s*\n/, '')
|
|
39
|
+
.replace(/\s+$/, '');
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Parsea un comentario JSDoc/TSDoc en `description` + `tags`.
|
|
43
|
+
* Acepta tanto el raw con `/** ... *\/` como el contenido ya limpio.
|
|
44
|
+
*
|
|
45
|
+
* Cada tag se reconoce con la heurística clásica de TypeDoc/TSDoc:
|
|
46
|
+
* una línea que empieza con `@<word>` abre un nuevo tag y consume
|
|
47
|
+
* todas las líneas siguientes hasta el próximo `@<word>` o EOF.
|
|
48
|
+
*/
|
|
49
|
+
function parseJSDoc(comment) {
|
|
50
|
+
const cleaned = comment.includes('/*') ? stripCommentMarkers(comment) : comment;
|
|
51
|
+
const lines = cleaned.split('\n');
|
|
52
|
+
const descLines = [];
|
|
53
|
+
const tags = [];
|
|
54
|
+
let current = null;
|
|
55
|
+
const tagOpen = /^@([A-Za-z][A-Za-z0-9_-]*)\s*(.*)$/;
|
|
56
|
+
for (const raw of lines) {
|
|
57
|
+
const line = raw.replace(/\r$/, '');
|
|
58
|
+
const trimmed = line.trimStart();
|
|
59
|
+
const m = tagOpen.exec(trimmed);
|
|
60
|
+
if (m) {
|
|
61
|
+
if (current)
|
|
62
|
+
tags.push(finalizeTag(current));
|
|
63
|
+
current = { tag: m[1] ?? '', content: m[2] ?? '' };
|
|
64
|
+
}
|
|
65
|
+
else if (current) {
|
|
66
|
+
current.content += (current.content.length > 0 ? '\n' : '') + line;
|
|
67
|
+
}
|
|
68
|
+
else {
|
|
69
|
+
descLines.push(line);
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
if (current)
|
|
73
|
+
tags.push(finalizeTag(current));
|
|
74
|
+
return {
|
|
75
|
+
description: descLines.join('\n').trim(),
|
|
76
|
+
tags,
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
function finalizeTag(tag) {
|
|
80
|
+
return {
|
|
81
|
+
tag: tag.tag,
|
|
82
|
+
content: tag.content.replace(/\s+$/, '').trim(),
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* `@param name description` → { name, description, optional }.
|
|
87
|
+
*
|
|
88
|
+
* También soporta el formato con tipo `@param {Type} name desc` aunque
|
|
89
|
+
* los tipos reales los tomamos del compilador, no del JSDoc.
|
|
90
|
+
*/
|
|
91
|
+
function parseParamTag(content) {
|
|
92
|
+
// Formato: [{Type}] name[?] - description (el `-` es opcional)
|
|
93
|
+
let s = content.trim();
|
|
94
|
+
// Drop opcional `{Type}` líder.
|
|
95
|
+
if (s.startsWith('{')) {
|
|
96
|
+
const end = s.indexOf('}');
|
|
97
|
+
if (end > 0)
|
|
98
|
+
s = s.slice(end + 1).trim();
|
|
99
|
+
}
|
|
100
|
+
const m = /^(\[?[A-Za-z_$][A-Za-z0-9_$.[\]?=]*\]?)\s*[-:]?\s*([\s\S]*)$/.exec(s);
|
|
101
|
+
if (!m)
|
|
102
|
+
return null;
|
|
103
|
+
const rawName = m[1] ?? '';
|
|
104
|
+
let name = rawName;
|
|
105
|
+
let optional = false;
|
|
106
|
+
if (name.startsWith('[') && name.endsWith(']')) {
|
|
107
|
+
name = name.slice(1, -1);
|
|
108
|
+
optional = true;
|
|
109
|
+
}
|
|
110
|
+
if (name.endsWith('?')) {
|
|
111
|
+
name = name.slice(0, -1);
|
|
112
|
+
optional = true;
|
|
113
|
+
}
|
|
114
|
+
// `name=default` → name only
|
|
115
|
+
const eq = name.indexOf('=');
|
|
116
|
+
if (eq >= 0) {
|
|
117
|
+
name = name.slice(0, eq);
|
|
118
|
+
optional = true;
|
|
119
|
+
}
|
|
120
|
+
return {
|
|
121
|
+
name: name.trim(),
|
|
122
|
+
description: (m[2] ?? '').trim(),
|
|
123
|
+
optional,
|
|
124
|
+
};
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* `@returns description` → description string.
|
|
128
|
+
*/
|
|
129
|
+
function parseReturnsTag(content) {
|
|
130
|
+
let s = content.trim();
|
|
131
|
+
if (s.startsWith('{')) {
|
|
132
|
+
const end = s.indexOf('}');
|
|
133
|
+
if (end > 0)
|
|
134
|
+
s = s.slice(end + 1).trim();
|
|
135
|
+
}
|
|
136
|
+
if (s.startsWith('-'))
|
|
137
|
+
s = s.slice(1).trim();
|
|
138
|
+
return s;
|
|
139
|
+
}
|
|
140
|
+
//# sourceMappingURL=jsdoc.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jsdoc.js","sourceRoot":"","sources":["../../../src/tooling/doc-gen/jsdoc.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,6BAA6B;AAC7B,EAAE;AACF,gEAAgE;AAChE,8DAA8D;AAC9D,+CAA+C;AAC/C,EAAE;AACF,4DAA4D;AAC5D,0DAA0D;AAC1D,iBAAiB;AACjB,+DAA+D;;AAQ/D,kDAeC;AAUD,gCA6BC;AAeD,sCAkCC;AAKD,0CAQC;AAxHD;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,GAAW;IAC7C,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IACnB,IAAI,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;QAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACnC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5C,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzC,0DAA0D;IAC1D,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACvC,MAAM,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,+CAA+C;IAC/C,OAAO,KAAK;SACT,IAAI,CAAC,IAAI,CAAC;SACV,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAChF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,MAAM,IAAI,GAAe,EAAE,CAAC;IAC5B,IAAI,OAAO,GAAoB,IAAI,CAAC;IAEpC,MAAM,OAAO,GAAG,oCAAoC,CAAC;IAErD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,EAAE,CAAC;YACN,IAAI,OAAO;gBAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7C,OAAO,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACrD,CAAC;aAAM,IAAI,OAAO,EAAE,CAAC;YACnB,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;QACrE,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IACD,IAAI,OAAO;QAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7C,OAAO;QACL,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;QACxC,IAAI;KACL,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,GAAa;IAChC,OAAO;QACL,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;KAChD,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,OAAe;IAEf,kEAAkE;IAClE,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACvB,gCAAgC;IAChC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,GAAG,GAAG,CAAC;YAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3C,CAAC;IACD,MAAM,CAAC,GAAG,8DAA8D,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjF,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpB,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3B,IAAI,IAAI,GAAG,OAAO,CAAC;IACnB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzB,QAAQ,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzB,QAAQ,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,6BAA6B;IAC7B,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;QACZ,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACzB,QAAQ,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;QACjB,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QAChC,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,OAAe;IAC7C,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACvB,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,GAAG,GAAG,CAAC;YAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3C,CAAC;IACD,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7C,OAAO,CAAC,CAAC;AACX,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { DocModule } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Renderiza la documentación a Markdown. La salida es un Map en
|
|
4
|
+
* el que la clave es la ruta del archivo `.md` correspondiente
|
|
5
|
+
* (relativa) y el valor es su contenido textual.
|
|
6
|
+
*
|
|
7
|
+
* Además del archivo por módulo, se incluye `index.md` con el
|
|
8
|
+
* overview generado por `renderIndex`.
|
|
9
|
+
*/
|
|
10
|
+
export declare function renderMarkdown(modules: DocModule[]): Map<string, string>;
|
|
11
|
+
/**
|
|
12
|
+
* Serializa la estructura completa a JSON pretty-printed.
|
|
13
|
+
*
|
|
14
|
+
* Útil cuando el consumidor (otro generador, un buscador, un
|
|
15
|
+
* sitio estático) prefiere consumir la data cruda.
|
|
16
|
+
*/
|
|
17
|
+
export declare function renderJSON(modules: DocModule[]): string;
|
|
18
|
+
/**
|
|
19
|
+
* Construye un `index.md` resumen con:
|
|
20
|
+
* - conteo total de módulos y símbolos
|
|
21
|
+
* - tabla por módulo con # de exports y descripción opcional
|
|
22
|
+
* - sub-tablas por kind (functions, classes, etc.)
|
|
23
|
+
*/
|
|
24
|
+
export declare function renderIndex(modules: DocModule[]): string;
|
|
25
|
+
/**
|
|
26
|
+
* `tooling/doc-gen/extract.ts` → `tooling/doc-gen/extract.md`.
|
|
27
|
+
*/
|
|
28
|
+
export declare function toMarkdownPath(modulePath: string): string;
|
|
29
|
+
//# sourceMappingURL=render.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../../src/tooling/doc-gen/render.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAmB,SAAS,EAAE,MAAM,SAAS,CAAC;AAY1D;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAQxE;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,CAoCxD;AAiID;;GAEG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAEzD"}
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// ============================================================
|
|
3
|
+
// Renderers — Markdown / JSON / index.
|
|
4
|
+
//
|
|
5
|
+
// renderMarkdown devuelve Map<filePath, contenido>. La clave es
|
|
6
|
+
// relativa (`tooling/doc-gen.md`, `index.md`...) y se compone a
|
|
7
|
+
// partir del modulePath original (sin extensión `.ts`).
|
|
8
|
+
// ============================================================
|
|
9
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
exports.renderMarkdown = renderMarkdown;
|
|
11
|
+
exports.renderJSON = renderJSON;
|
|
12
|
+
exports.renderIndex = renderIndex;
|
|
13
|
+
exports.toMarkdownPath = toMarkdownPath;
|
|
14
|
+
const KIND_LABEL = {
|
|
15
|
+
function: 'Function',
|
|
16
|
+
class: 'Class',
|
|
17
|
+
interface: 'Interface',
|
|
18
|
+
type: 'Type',
|
|
19
|
+
const: 'Const',
|
|
20
|
+
enum: 'Enum',
|
|
21
|
+
namespace: 'Namespace',
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Renderiza la documentación a Markdown. La salida es un Map en
|
|
25
|
+
* el que la clave es la ruta del archivo `.md` correspondiente
|
|
26
|
+
* (relativa) y el valor es su contenido textual.
|
|
27
|
+
*
|
|
28
|
+
* Además del archivo por módulo, se incluye `index.md` con el
|
|
29
|
+
* overview generado por `renderIndex`.
|
|
30
|
+
*/
|
|
31
|
+
function renderMarkdown(modules) {
|
|
32
|
+
const files = new Map();
|
|
33
|
+
for (const mod of modules) {
|
|
34
|
+
const outPath = toMarkdownPath(mod.path);
|
|
35
|
+
files.set(outPath, renderModuleMarkdown(mod));
|
|
36
|
+
}
|
|
37
|
+
files.set('index.md', renderIndex(modules));
|
|
38
|
+
return files;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Serializa la estructura completa a JSON pretty-printed.
|
|
42
|
+
*
|
|
43
|
+
* Útil cuando el consumidor (otro generador, un buscador, un
|
|
44
|
+
* sitio estático) prefiere consumir la data cruda.
|
|
45
|
+
*/
|
|
46
|
+
function renderJSON(modules) {
|
|
47
|
+
return JSON.stringify({ modules }, null, 2) + '\n';
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Construye un `index.md` resumen con:
|
|
51
|
+
* - conteo total de módulos y símbolos
|
|
52
|
+
* - tabla por módulo con # de exports y descripción opcional
|
|
53
|
+
* - sub-tablas por kind (functions, classes, etc.)
|
|
54
|
+
*/
|
|
55
|
+
function renderIndex(modules) {
|
|
56
|
+
const lines = [];
|
|
57
|
+
const totalSymbols = modules.reduce((acc, m) => acc + m.exports.length, 0);
|
|
58
|
+
lines.push('# API Reference');
|
|
59
|
+
lines.push('');
|
|
60
|
+
lines.push(`> Auto-generado por \`tooling/doc-gen\`.`);
|
|
61
|
+
lines.push('');
|
|
62
|
+
lines.push(`- **Modules**: ${modules.length}`);
|
|
63
|
+
lines.push(`- **Symbols**: ${totalSymbols}`);
|
|
64
|
+
lines.push('');
|
|
65
|
+
// Conteo por kind
|
|
66
|
+
const byKind = countByKind(modules);
|
|
67
|
+
if (byKind.size > 0) {
|
|
68
|
+
lines.push('## Symbols by kind');
|
|
69
|
+
lines.push('');
|
|
70
|
+
lines.push('| Kind | Count |');
|
|
71
|
+
lines.push('| ---- | ----- |');
|
|
72
|
+
for (const [kind, count] of byKind) {
|
|
73
|
+
lines.push(`| ${KIND_LABEL[kind]} | ${count} |`);
|
|
74
|
+
}
|
|
75
|
+
lines.push('');
|
|
76
|
+
}
|
|
77
|
+
lines.push('## Modules');
|
|
78
|
+
lines.push('');
|
|
79
|
+
lines.push('| Module | Exports | Description |');
|
|
80
|
+
lines.push('| ------ | ------- | ----------- |');
|
|
81
|
+
for (const mod of modules) {
|
|
82
|
+
const link = `[\`${mod.path}\`](./${toMarkdownPath(mod.path)})`;
|
|
83
|
+
const desc = (mod.description ?? '').replace(/\|/g, '\\|').replace(/\n+/g, ' ');
|
|
84
|
+
lines.push(`| ${link} | ${mod.exports.length} | ${desc} |`);
|
|
85
|
+
}
|
|
86
|
+
lines.push('');
|
|
87
|
+
return lines.join('\n');
|
|
88
|
+
}
|
|
89
|
+
function renderModuleMarkdown(mod) {
|
|
90
|
+
const lines = [];
|
|
91
|
+
lines.push(`# \`${mod.path}\``);
|
|
92
|
+
lines.push('');
|
|
93
|
+
if (mod.description) {
|
|
94
|
+
lines.push(mod.description);
|
|
95
|
+
lines.push('');
|
|
96
|
+
}
|
|
97
|
+
// Index intra-módulo
|
|
98
|
+
if (mod.exports.length > 1) {
|
|
99
|
+
lines.push('## Contents');
|
|
100
|
+
lines.push('');
|
|
101
|
+
for (const sym of mod.exports) {
|
|
102
|
+
const anchor = slugify(sym.name);
|
|
103
|
+
const decoration = sym.deprecated ? ' _(deprecated)_' : '';
|
|
104
|
+
lines.push(`- [\`${sym.name}\`](#${anchor}) — ${KIND_LABEL[sym.kind]}${decoration}`);
|
|
105
|
+
}
|
|
106
|
+
lines.push('');
|
|
107
|
+
}
|
|
108
|
+
for (const sym of mod.exports) {
|
|
109
|
+
lines.push(renderSymbol(sym));
|
|
110
|
+
lines.push('');
|
|
111
|
+
}
|
|
112
|
+
return lines.join('\n');
|
|
113
|
+
}
|
|
114
|
+
function renderSymbol(sym) {
|
|
115
|
+
const lines = [];
|
|
116
|
+
const deprecated = sym.deprecated ? ' ⚠️ DEPRECATED' : '';
|
|
117
|
+
lines.push(`## \`${sym.name}\`${deprecated}`);
|
|
118
|
+
lines.push('');
|
|
119
|
+
lines.push(`> ${KIND_LABEL[sym.kind]} · \`${sym.module}:${sym.lineNumber}\``);
|
|
120
|
+
lines.push('');
|
|
121
|
+
if (sym.deprecated) {
|
|
122
|
+
lines.push('> **Deprecated.** No usar en código nuevo.');
|
|
123
|
+
lines.push('');
|
|
124
|
+
}
|
|
125
|
+
if (sym.description) {
|
|
126
|
+
lines.push(sym.description);
|
|
127
|
+
lines.push('');
|
|
128
|
+
}
|
|
129
|
+
if (sym.signature) {
|
|
130
|
+
lines.push('```ts');
|
|
131
|
+
lines.push(sym.signature);
|
|
132
|
+
lines.push('```');
|
|
133
|
+
lines.push('');
|
|
134
|
+
}
|
|
135
|
+
if (sym.parameters && sym.parameters.length > 0) {
|
|
136
|
+
lines.push('### Parameters');
|
|
137
|
+
lines.push('');
|
|
138
|
+
lines.push('| Name | Type | Optional | Description |');
|
|
139
|
+
lines.push('| ---- | ---- | -------- | ----------- |');
|
|
140
|
+
for (const p of sym.parameters) {
|
|
141
|
+
const desc = p.description.replace(/\|/g, '\\|').replace(/\n+/g, ' ');
|
|
142
|
+
lines.push(`| \`${p.name}\` | \`${escapeMd(p.type)}\` | ${p.optional ? 'yes' : 'no'} | ${desc} |`);
|
|
143
|
+
}
|
|
144
|
+
lines.push('');
|
|
145
|
+
}
|
|
146
|
+
if (sym.returns) {
|
|
147
|
+
lines.push('### Returns');
|
|
148
|
+
lines.push('');
|
|
149
|
+
lines.push(`\`${escapeMd(sym.returns.type)}\` — ${sym.returns.description}`);
|
|
150
|
+
lines.push('');
|
|
151
|
+
}
|
|
152
|
+
if (sym.examples && sym.examples.length > 0) {
|
|
153
|
+
lines.push('### Examples');
|
|
154
|
+
lines.push('');
|
|
155
|
+
for (const ex of sym.examples) {
|
|
156
|
+
lines.push(renderExample(ex));
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
if (sym.remarks) {
|
|
160
|
+
lines.push('### Remarks');
|
|
161
|
+
lines.push('');
|
|
162
|
+
lines.push(sym.remarks);
|
|
163
|
+
lines.push('');
|
|
164
|
+
}
|
|
165
|
+
if (sym.see && sym.see.length > 0) {
|
|
166
|
+
lines.push('### See also');
|
|
167
|
+
lines.push('');
|
|
168
|
+
for (const s of sym.see) {
|
|
169
|
+
lines.push(`- ${s}`);
|
|
170
|
+
}
|
|
171
|
+
lines.push('');
|
|
172
|
+
}
|
|
173
|
+
return lines.join('\n');
|
|
174
|
+
}
|
|
175
|
+
function renderExample(ex) {
|
|
176
|
+
// Si el example ya viene con su propio fence, respétalo.
|
|
177
|
+
if (/```/.test(ex)) {
|
|
178
|
+
return ex.trim() + '\n';
|
|
179
|
+
}
|
|
180
|
+
return ['```ts', ex.trim(), '```', ''].join('\n');
|
|
181
|
+
}
|
|
182
|
+
function countByKind(modules) {
|
|
183
|
+
const out = new Map();
|
|
184
|
+
for (const m of modules) {
|
|
185
|
+
for (const sym of m.exports) {
|
|
186
|
+
out.set(sym.kind, (out.get(sym.kind) ?? 0) + 1);
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
return out;
|
|
190
|
+
}
|
|
191
|
+
function escapeMd(s) {
|
|
192
|
+
return s.replace(/\|/g, '\\|').replace(/\n+/g, ' ');
|
|
193
|
+
}
|
|
194
|
+
function slugify(s) {
|
|
195
|
+
return s
|
|
196
|
+
.toLowerCase()
|
|
197
|
+
.replace(/[^a-z0-9]+/g, '-')
|
|
198
|
+
.replace(/^-+|-+$/g, '');
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* `tooling/doc-gen/extract.ts` → `tooling/doc-gen/extract.md`.
|
|
202
|
+
*/
|
|
203
|
+
function toMarkdownPath(modulePath) {
|
|
204
|
+
return modulePath.replace(/\.ts$/, '.md');
|
|
205
|
+
}
|
|
206
|
+
//# sourceMappingURL=render.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"render.js","sourceRoot":"","sources":["../../../src/tooling/doc-gen/render.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,uCAAuC;AACvC,EAAE;AACF,gEAAgE;AAChE,gEAAgE;AAChE,wDAAwD;AACxD,+DAA+D;;AAsB/D,wCAQC;AAQD,gCAEC;AAQD,kCAoCC;AAoID,wCAEC;AAtND,MAAM,UAAU,GAA4B;IAC1C,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,OAAoB;IACjD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5C,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,OAAoB;IAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,OAAoB;IAC9C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE3E,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,kBAAkB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/C,KAAK,CAAC,IAAI,CAAC,kBAAkB,YAAY,EAAE,CAAC,CAAC;IAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,kBAAkB;IAClB,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACzB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IACjD,KAAK,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IACjD,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,SAAS,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;QAChE,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAChF,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,MAAM,IAAI,IAAI,CAAC,CAAC;IAC9D,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,oBAAoB,CAAC,GAAc;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC;IAChC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,qBAAqB;IACrB,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3D,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,QAAQ,MAAM,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,UAAU,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,YAAY,CAAC,GAAW;IAC/B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC,CAAC;IAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC;IAC9E,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;QACnB,KAAK,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;QACzD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QACvD,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACtE,KAAK,CAAC,IAAI,CACR,OAAO,CAAC,CAAC,IAAI,UAAU,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,IAAI,CACvF,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAChB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7E,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAChB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACvB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,aAAa,CAAC,EAAU;IAC/B,yDAAyD;IACzD,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC;IAC1B,CAAC;IACD,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,WAAW,CAAC,OAAoB;IACvC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAmB,CAAC;IACvC,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,KAAK,MAAM,GAAG,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YAC5B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,QAAQ,CAAC,CAAS;IACzB,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,OAAO,CAAC,CAAS;IACxB,OAAO,CAAC;SACL,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,UAAkB;IAC/C,OAAO,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC5C,CAAC"}
|