product-doc 0.0.0-stage → 0.13.2
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/LICENSE +21 -0
- package/README.md +566 -2
- package/bin.js +6 -0
- package/guide.md +251 -0
- package/lib/annotations.d.ts +44 -0
- package/lib/annotations.js +65 -0
- package/lib/changes.d.ts +96 -0
- package/lib/changes.js +111 -0
- package/lib/cli.d.ts +1 -0
- package/lib/cli.js +217 -0
- package/lib/codeNotes.d.ts +38 -0
- package/lib/codeNotes.js +113 -0
- package/lib/definitions.d.ts +23 -0
- package/lib/definitions.js +298 -0
- package/lib/diagramAnnotations.d.ts +7 -0
- package/lib/diagramAnnotations.js +27 -0
- package/lib/errors.d.ts +44 -0
- package/lib/errors.js +71 -0
- package/lib/extractDocument.d.ts +3 -0
- package/lib/extractDocument.js +22 -0
- package/lib/gist/route.d.ts +26 -0
- package/lib/gist/route.js +124 -0
- package/lib/git.d.ts +33 -0
- package/lib/git.js +474 -0
- package/lib/github/route.d.ts +28 -0
- package/lib/github/route.js +128 -0
- package/lib/index.d.ts +10 -0
- package/lib/index.js +7 -0
- package/lib/invokeCwd.d.ts +1 -0
- package/lib/invokeCwd.js +9 -0
- package/lib/media.d.ts +5 -0
- package/lib/media.js +9 -0
- package/lib/mermaid.d.ts +6 -0
- package/lib/mermaid.js +20 -0
- package/lib/mermaidTheme.d.ts +17 -0
- package/lib/mermaidTheme.js +28 -0
- package/lib/packageVersion.d.ts +1 -0
- package/lib/packageVersion.js +3 -0
- package/lib/parseFence.d.ts +76 -0
- package/lib/parseFence.js +137 -0
- package/lib/parseViewer.d.ts +74 -0
- package/lib/parseViewer.js +490 -0
- package/lib/readSpec.d.ts +25 -0
- package/lib/readSpec.js +62 -0
- package/lib/registry.d.ts +11 -0
- package/lib/registry.js +82 -0
- package/lib/serve.d.ts +70 -0
- package/lib/serve.js +756 -0
- package/lib/services.d.ts +107 -0
- package/lib/services.js +310 -0
- package/lib/share.d.ts +15 -0
- package/lib/share.js +153 -0
- package/lib/spec.d.ts +39 -0
- package/lib/spec.js +95 -0
- package/lib/telemetry.d.ts +6 -0
- package/lib/telemetry.js +109 -0
- package/lib/update.d.ts +43 -0
- package/lib/update.js +237 -0
- package/package.json +79 -4
- package/viewer-dist/assets/abap-CLvhMVsD.js +1 -0
- package/viewer-dist/assets/actionscript-3-Cs6JJXT5.js +1 -0
- package/viewer-dist/assets/ada-X3Y2mlq2.js +1 -0
- package/viewer-dist/assets/ahk-DwADkxyd.js +1 -0
- package/viewer-dist/assets/ahk2-_6rzW9BS.js +1 -0
- package/viewer-dist/assets/andromeeda-BJLMrMlp.js +1 -0
- package/viewer-dist/assets/andromeeda-vGVdxbeo.js +1 -0
- package/viewer-dist/assets/angular-html-BswFT_28.js +1 -0
- package/viewer-dist/assets/angular-html-Cwa-lTMy.js +1 -0
- package/viewer-dist/assets/angular-ts-DOMhGxLQ.js +1 -0
- package/viewer-dist/assets/apache-U0d_L8uA.js +1 -0
- package/viewer-dist/assets/apex-KFGFyKwG.js +1 -0
- package/viewer-dist/assets/apl-Dio8Ke0X.js +1 -0
- package/viewer-dist/assets/appendItems-BRdTC5zu.js +3 -0
- package/viewer-dist/assets/applescript-CCn79oCD.js +1 -0
- package/viewer-dist/assets/ara-4CJ0cIlV.js +1 -0
- package/viewer-dist/assets/asciidoc-SCjQUq34.js +1 -0
- package/viewer-dist/assets/asm-Cmm7eHzH.js +1 -0
- package/viewer-dist/assets/astro-CN6YWUG3.js +1 -0
- package/viewer-dist/assets/aurora-x-BCChoRpm.js +1 -0
- package/viewer-dist/assets/aurora-x-CDeNXAV0.js +1 -0
- package/viewer-dist/assets/awk-BWXHIvNe.js +1 -0
- package/viewer-dist/assets/ayu-dark-DluEY0Gj.js +1 -0
- package/viewer-dist/assets/ayu-dark-DzFZPuMV.js +1 -0
- package/viewer-dist/assets/ayu-light-C3h-C4tm.js +1 -0
- package/viewer-dist/assets/ayu-light-DSkcX_XD.js +1 -0
- package/viewer-dist/assets/ayu-mirage-Bqwy1Gya.js +1 -0
- package/viewer-dist/assets/ayu-mirage-DSve0zuE.js +1 -0
- package/viewer-dist/assets/ballerina-B7ZEbQpA.js +1 -0
- package/viewer-dist/assets/bat-Di-EdOIU.js +1 -0
- package/viewer-dist/assets/bat-HFWzIrao.js +1 -0
- package/viewer-dist/assets/beancount-C2IN4Vk8.js +1 -0
- package/viewer-dist/assets/berry-DKpUyyne.js +1 -0
- package/viewer-dist/assets/bibtex-CimSBJhw.js +1 -0
- package/viewer-dist/assets/bibtex-Conh3HYz.js +1 -0
- package/viewer-dist/assets/bicep-CUHmPFLl.js +1 -0
- package/viewer-dist/assets/bird2-CYIUgYqB.js +1 -0
- package/viewer-dist/assets/blade-BrDpNfUX.js +1 -0
- package/viewer-dist/assets/bsl-gRq8cI6V.js +1 -0
- package/viewer-dist/assets/c-DWGmR78Y.js +1 -0
- package/viewer-dist/assets/c-SSSlmE39.js +1 -0
- package/viewer-dist/assets/c3-D0apG41V.js +1 -0
- package/viewer-dist/assets/cadence-CQ2zXKGN.js +1 -0
- package/viewer-dist/assets/cairo-D66nqRlU.js +1 -0
- package/viewer-dist/assets/catppuccin-frappe-C9Q5zVZY.js +1 -0
- package/viewer-dist/assets/catppuccin-frappe-DbLkF0J2.js +1 -0
- package/viewer-dist/assets/catppuccin-latte-CtsyrtPq.js +1 -0
- package/viewer-dist/assets/catppuccin-latte-b6208YQK.js +1 -0
- package/viewer-dist/assets/catppuccin-macchiato-CNNBbV1L.js +1 -0
- package/viewer-dist/assets/catppuccin-macchiato-R8nAf1vR.js +1 -0
- package/viewer-dist/assets/catppuccin-mocha-DHkNF0Mp.js +1 -0
- package/viewer-dist/assets/catppuccin-mocha-DjuaAJKi.js +1 -0
- package/viewer-dist/assets/chapel-C1sUNn9S.js +1 -0
- package/viewer-dist/assets/clarity-CtfBBspg.js +1 -0
- package/viewer-dist/assets/clojure-BrC3BItl.js +1 -0
- package/viewer-dist/assets/clojure-zIjcJonk.js +1 -0
- package/viewer-dist/assets/cmake-BRht3inD.js +1 -0
- package/viewer-dist/assets/cmake-T_kMSWuN.js +1 -0
- package/viewer-dist/assets/cobol-BvqUwMCV.js +1 -0
- package/viewer-dist/assets/codeowners-C8r90Shi.js +1 -0
- package/viewer-dist/assets/codeql-oeQT6MSM.js +1 -0
- package/viewer-dist/assets/coffee-BSYIIMkB.js +1 -0
- package/viewer-dist/assets/coffee-drHG6SJT.js +1 -0
- package/viewer-dist/assets/commit-mono-latin-400-italic-BXinMwCi.woff +0 -0
- package/viewer-dist/assets/commit-mono-latin-400-italic-DjSHLl2N.woff2 +0 -0
- package/viewer-dist/assets/commit-mono-latin-400-normal-s0S3qwFW.woff +0 -0
- package/viewer-dist/assets/commit-mono-latin-400-normal-wzhe4RuD.woff2 +0 -0
- package/viewer-dist/assets/common-lisp-Cv5bFMCO.js +1 -0
- package/viewer-dist/assets/constants-CmGPilXJ.js +1 -0
- package/viewer-dist/assets/coq-CGaSfhwR.js +1 -0
- package/viewer-dist/assets/core-A38CGsfQ.js +4 -0
- package/viewer-dist/assets/core-B86SFyc0.js +1 -0
- package/viewer-dist/assets/cpp-BDT6bThX.js +1 -0
- package/viewer-dist/assets/cpp-CcLCVKG_.js +1 -0
- package/viewer-dist/assets/crystal-D0XIDmeW.js +1 -0
- package/viewer-dist/assets/csharp-B3DbjJyj.js +1 -0
- package/viewer-dist/assets/csharp-DtuFCOLR.js +1 -0
- package/viewer-dist/assets/css-BGIxQoYs.js +1 -0
- package/viewer-dist/assets/css-DUjzNfgv.js +1 -0
- package/viewer-dist/assets/csv-B_R7vXwK.js +1 -0
- package/viewer-dist/assets/csv-D6mwZ2PH.js +1 -0
- package/viewer-dist/assets/cue-CE9AQfxI.js +1 -0
- package/viewer-dist/assets/cypher-ClKdZ_lG.js +1 -0
- package/viewer-dist/assets/d-qD-0Kul2.js +1 -0
- package/viewer-dist/assets/dark-plus-BVZ_4wTZ.js +1 -0
- package/viewer-dist/assets/dark-plus-Cs2F2srj.js +1 -0
- package/viewer-dist/assets/dart-B8JJT_EX.js +1 -0
- package/viewer-dist/assets/dart-_dH3dQdM.js +1 -0
- package/viewer-dist/assets/dax-BkyTk9wS.js +1 -0
- package/viewer-dist/assets/desktop-Dlh5hvp9.js +1 -0
- package/viewer-dist/assets/diff-B0S3HUPm.js +1 -0
- package/viewer-dist/assets/diff-CR4ZX0DC.js +1 -0
- package/viewer-dist/assets/docker-B3DZKTds.js +1 -0
- package/viewer-dist/assets/docker-CAzcIhYn.js +1 -0
- package/viewer-dist/assets/dotenv-CuH5my32.js +1 -0
- package/viewer-dist/assets/dracula-BHWKrbxM.js +1 -0
- package/viewer-dist/assets/dracula-BoZgXveB.js +1 -0
- package/viewer-dist/assets/dracula-soft-5eyTD99u.js +1 -0
- package/viewer-dist/assets/dracula-soft-D-Kgh5gw.js +1 -0
- package/viewer-dist/assets/dream-maker-DW3nJb8Q.js +1 -0
- package/viewer-dist/assets/edge-B_SBzXGF.js +1 -0
- package/viewer-dist/assets/elixir-B0EKSUNS.js +1 -0
- package/viewer-dist/assets/elixir-BL8v4QDr.js +1 -0
- package/viewer-dist/assets/elk.bundled-CVOErv1M.js +24 -0
- package/viewer-dist/assets/elm-CC1TmzeR.js +1 -0
- package/viewer-dist/assets/emacs-lisp-DR2vtWaj.js +1 -0
- package/viewer-dist/assets/engine-javascript-BopS6peh.js +141 -0
- package/viewer-dist/assets/engine-oniguruma-BO8SA_1o.js +1 -0
- package/viewer-dist/assets/erb-CHbMJpQy.js +1 -0
- package/viewer-dist/assets/erlang-CCXss5H6.js +1 -0
- package/viewer-dist/assets/erlang-DAWODyxE.js +1 -0
- package/viewer-dist/assets/everforest-dark-Y6tr-2zD.js +1 -0
- package/viewer-dist/assets/everforest-dark-sB-x3p7T.js +1 -0
- package/viewer-dist/assets/everforest-light-CA0Ol4Qu.js +1 -0
- package/viewer-dist/assets/everforest-light-Df2xbC6M.js +1 -0
- package/viewer-dist/assets/fennel-DQxkIbk2.js +1 -0
- package/viewer-dist/assets/fish-BJitypiv.js +1 -0
- package/viewer-dist/assets/fluent-C03EYrpw.js +1 -0
- package/viewer-dist/assets/formatCSSVariablePrefix-KRh9vnZf.js +1 -0
- package/viewer-dist/assets/fortran-fixed-form-1cK5gXa1.js +1 -0
- package/viewer-dist/assets/fortran-free-form-9zh5t3u2.js +1 -0
- package/viewer-dist/assets/fortran-free-form-uHOymLAb.js +1 -0
- package/viewer-dist/assets/fsharp-C37UASp4.js +1 -0
- package/viewer-dist/assets/fsharp-D8ZPuVlk.js +1 -0
- package/viewer-dist/assets/gdresource-LxjHb83i.js +1 -0
- package/viewer-dist/assets/gdscript-C2iVvkL_.js +1 -0
- package/viewer-dist/assets/gdscript-DJFPOtzS.js +1 -0
- package/viewer-dist/assets/gdshader-BpaOOKdG.js +1 -0
- package/viewer-dist/assets/gdshader-kiBtQlv1.js +1 -0
- package/viewer-dist/assets/genie-CV2tkWYe.js +1 -0
- package/viewer-dist/assets/gherkin-DExj1W_8.js +1 -0
- package/viewer-dist/assets/git-commit-BAuDFD-1.js +1 -0
- package/viewer-dist/assets/git-commit-rNeRxB9Y.js +1 -0
- package/viewer-dist/assets/git-rebase-Bh7mDoAc.js +1 -0
- package/viewer-dist/assets/git-rebase-Cpv8mbcu.js +1 -0
- package/viewer-dist/assets/github-dark-C-LZuMrd.js +1 -0
- package/viewer-dist/assets/github-dark-C895GGrm.js +1 -0
- package/viewer-dist/assets/github-dark-default-DXG-b-1a.js +1 -0
- package/viewer-dist/assets/github-dark-default-adAWTKmX.js +1 -0
- package/viewer-dist/assets/github-dark-dimmed-Bx1FflLF.js +1 -0
- package/viewer-dist/assets/github-dark-dimmed-jPx1V1fR.js +1 -0
- package/viewer-dist/assets/github-dark-high-contrast-B_tTalzw.js +1 -0
- package/viewer-dist/assets/github-dark-high-contrast-UN5YjL_Z.js +1 -0
- package/viewer-dist/assets/github-light-B4HDwToD.js +1 -0
- package/viewer-dist/assets/github-light-EUqPIrTm.js +1 -0
- package/viewer-dist/assets/github-light-default-BXViO-2h.js +1 -0
- package/viewer-dist/assets/github-light-default-CfC59JYV.js +1 -0
- package/viewer-dist/assets/github-light-high-contrast-B68TUdTA.js +1 -0
- package/viewer-dist/assets/github-light-high-contrast-C3edEHcK.js +1 -0
- package/viewer-dist/assets/gleam-CSRkHgEL.js +1 -0
- package/viewer-dist/assets/glimmer-js-CIdbWayl.js +1 -0
- package/viewer-dist/assets/glimmer-ts-B16xCo2k.js +1 -0
- package/viewer-dist/assets/glsl-CaPTrB3a.js +1 -0
- package/viewer-dist/assets/glsl-ThNHWs2E.js +1 -0
- package/viewer-dist/assets/gn-CAXYAgV-.js +1 -0
- package/viewer-dist/assets/gnuplot-7GGW24-e.js +1 -0
- package/viewer-dist/assets/go-BrE3Phef.js +1 -0
- package/viewer-dist/assets/go-CFMhVTkq.js +1 -0
- package/viewer-dist/assets/graphql-DAzSVzvB.js +1 -0
- package/viewer-dist/assets/graphql-DEIChqxY.js +1 -0
- package/viewer-dist/assets/groovy-D_Q3n-An.js +1 -0
- package/viewer-dist/assets/groovy-Dj7WCBJM.js +1 -0
- package/viewer-dist/assets/gruvbox-dark-hard-BdGOuxq8.js +1 -0
- package/viewer-dist/assets/gruvbox-dark-hard-C820rvS2.js +1 -0
- package/viewer-dist/assets/gruvbox-dark-medium-BPjhmG05.js +1 -0
- package/viewer-dist/assets/gruvbox-dark-medium-CmygtSMi.js +1 -0
- package/viewer-dist/assets/gruvbox-dark-soft-BJH4XuY9.js +1 -0
- package/viewer-dist/assets/gruvbox-dark-soft-MrdJrrXF.js +1 -0
- package/viewer-dist/assets/gruvbox-light-hard-BC_s9l72.js +1 -0
- package/viewer-dist/assets/gruvbox-light-hard-BkSILF4E.js +1 -0
- package/viewer-dist/assets/gruvbox-light-medium-BAWPOn9u.js +1 -0
- package/viewer-dist/assets/gruvbox-light-medium-DiZUfgdz.js +1 -0
- package/viewer-dist/assets/gruvbox-light-soft-BSMLrYjP.js +1 -0
- package/viewer-dist/assets/gruvbox-light-soft-CRCTnbIj.js +1 -0
- package/viewer-dist/assets/hack-C30D-q0p.js +1 -0
- package/viewer-dist/assets/haml-C1zHJAQt.js +1 -0
- package/viewer-dist/assets/haml-mwfMQlUs.js +1 -0
- package/viewer-dist/assets/handlebars-CEZndQNl.js +1 -0
- package/viewer-dist/assets/handlebars-g-3gLrXt.js +1 -0
- package/viewer-dist/assets/haskell-D8IpX4py.js +1 -0
- package/viewer-dist/assets/haxe-CD8O8Ul0.js +1 -0
- package/viewer-dist/assets/haxe-j5FdAS1V.js +1 -0
- package/viewer-dist/assets/hcl-Dh228itO.js +1 -0
- package/viewer-dist/assets/highlights-B57wCzB5.js +3 -0
- package/viewer-dist/assets/hjson-CxZEssPk.js +1 -0
- package/viewer-dist/assets/hlsl-C3sg_olF.js +1 -0
- package/viewer-dist/assets/hlsl-ajL2FB-w.js +1 -0
- package/viewer-dist/assets/horizon-CE9ld1lL.js +1 -0
- package/viewer-dist/assets/horizon-DUI96lQn.js +1 -0
- package/viewer-dist/assets/horizon-bright-COxh1lHf.js +1 -0
- package/viewer-dist/assets/horizon-bright-DSNQnXHK.js +1 -0
- package/viewer-dist/assets/houston-CsvMBhTu.js +1 -0
- package/viewer-dist/assets/houston-DduE73P7.js +1 -0
- package/viewer-dist/assets/html-DSw1lh5G.js +1 -0
- package/viewer-dist/assets/html-WQKKblVZ.js +1 -0
- package/viewer-dist/assets/html-derivative-CjJKezcp.js +1 -0
- package/viewer-dist/assets/html-derivative-DyzJkWO6.js +1 -0
- package/viewer-dist/assets/http-BjrBtiM6.js +1 -0
- package/viewer-dist/assets/hurl-B4P9s9G3.js +1 -0
- package/viewer-dist/assets/hxml-DPF7XkXa.js +1 -0
- package/viewer-dist/assets/hy-CZbG8q4J.js +1 -0
- package/viewer-dist/assets/imba-DsUTQ-LC.js +1 -0
- package/viewer-dist/assets/index-B0ZrAosS.css +1 -0
- package/viewer-dist/assets/index-CVKGwJkR.js +255 -0
- package/viewer-dist/assets/ini-0B7NLFlx.js +1 -0
- package/viewer-dist/assets/ini-DxURaTxO.js +1 -0
- package/viewer-dist/assets/java-BtIQNnN0.js +1 -0
- package/viewer-dist/assets/java-DxlWrXwe.js +1 -0
- package/viewer-dist/assets/javascript-BzbQS41l.js +1 -0
- package/viewer-dist/assets/javascript-Yelw-5ZN.js +1 -0
- package/viewer-dist/assets/jinja-dRcm23Ea.js +1 -0
- package/viewer-dist/assets/jison-D3aJooqo.js +1 -0
- package/viewer-dist/assets/json-B88Oqtu5.js +1 -0
- package/viewer-dist/assets/json-CaljABEy.js +1 -0
- package/viewer-dist/assets/json5-BR5RXkoi.js +1 -0
- package/viewer-dist/assets/jsonc-CTI_jrid.js +1 -0
- package/viewer-dist/assets/jsonc-dcnCvL0G.js +1 -0
- package/viewer-dist/assets/jsonl-CmCQp5Yx.js +1 -0
- package/viewer-dist/assets/jsonnet-CJTPZ8u_.js +1 -0
- package/viewer-dist/assets/jssm-DXw9l8Rf.js +1 -0
- package/viewer-dist/assets/jsx-D3KKoC5L.js +1 -0
- package/viewer-dist/assets/jsx-hEbJ82HF.js +1 -0
- package/viewer-dist/assets/julia-BCOw4cyx.js +1 -0
- package/viewer-dist/assets/julia-hqywDEUR.js +1 -0
- package/viewer-dist/assets/just-Br47BmIC.js +1 -0
- package/viewer-dist/assets/kanagawa-dragon-BHDhSKDf.js +1 -0
- package/viewer-dist/assets/kanagawa-dragon-Bozd7klA.js +1 -0
- package/viewer-dist/assets/kanagawa-lotus-BmuOG9ZW.js +1 -0
- package/viewer-dist/assets/kanagawa-lotus-NJjGXXql.js +1 -0
- package/viewer-dist/assets/kanagawa-wave-BML5mF2J.js +1 -0
- package/viewer-dist/assets/kanagawa-wave-DsGe2Uqk.js +1 -0
- package/viewer-dist/assets/kdl-CsD5j6eV.js +1 -0
- package/viewer-dist/assets/kotlin-DhhofPvG.js +1 -0
- package/viewer-dist/assets/kusto-C7mF5XQf.js +1 -0
- package/viewer-dist/assets/langs-JgP7EaER.js +2 -0
- package/viewer-dist/assets/laserwave-C_8bwKvT.js +1 -0
- package/viewer-dist/assets/laserwave-DYV0fvJ_.js +1 -0
- package/viewer-dist/assets/latex-B_Ztlc7G.js +1 -0
- package/viewer-dist/assets/latex-Djh9Fg1h.js +1 -0
- package/viewer-dist/assets/lean-CewbzKMR.js +1 -0
- package/viewer-dist/assets/less-B64L-FWb.js +1 -0
- package/viewer-dist/assets/less-GWsDhusf.js +1 -0
- package/viewer-dist/assets/lib-IuaA1a0_.js +9 -0
- package/viewer-dist/assets/light-plus-DVQuIRkW.js +1 -0
- package/viewer-dist/assets/light-plus-FTnIShls.js +1 -0
- package/viewer-dist/assets/liquid-CQNtsgCr.js +1 -0
- package/viewer-dist/assets/llvm-DqHOMS-s.js +1 -0
- package/viewer-dist/assets/loader-D4gJynmd.js +1 -0
- package/viewer-dist/assets/log-BvtJ4bSl.js +1 -0
- package/viewer-dist/assets/log-DSUv6hjM.js +1 -0
- package/viewer-dist/assets/logo-Cluzi2Zq.js +1 -0
- package/viewer-dist/assets/lua-BJObVtAx.js +1 -0
- package/viewer-dist/assets/lua-DjuecEsk.js +1 -0
- package/viewer-dist/assets/luau-VGWVLoqX.js +1 -0
- package/viewer-dist/assets/make-BLT6fICl.js +1 -0
- package/viewer-dist/assets/make-URElk0GJ.js +1 -0
- package/viewer-dist/assets/markdown-CboqBxpY.js +1 -0
- package/viewer-dist/assets/markdown-Cla8Gbs6.js +1 -0
- package/viewer-dist/assets/marko-DPS0EkZ1.js +1 -0
- package/viewer-dist/assets/material-theme-Bm3Qr25_.js +1 -0
- package/viewer-dist/assets/material-theme-IcIb8QNx.js +1 -0
- package/viewer-dist/assets/material-theme-darker-2IIEA8gg.js +1 -0
- package/viewer-dist/assets/material-theme-darker-B_f2vxdL.js +1 -0
- package/viewer-dist/assets/material-theme-lighter-CR2Q-4Hp.js +1 -0
- package/viewer-dist/assets/material-theme-lighter-uhdI0v04.js +1 -0
- package/viewer-dist/assets/material-theme-ocean-BX6hAJ_y.js +1 -0
- package/viewer-dist/assets/material-theme-ocean-CHQ94UKr.js +1 -0
- package/viewer-dist/assets/material-theme-palenight-B5W6OYN7.js +1 -0
- package/viewer-dist/assets/material-theme-palenight-B6DWAotd.js +1 -0
- package/viewer-dist/assets/matlab-D7qyCx1q.js +1 -0
- package/viewer-dist/assets/mdc-C6srEd4p.js +1 -0
- package/viewer-dist/assets/mdx-DQZ5AkYe.js +1 -0
- package/viewer-dist/assets/mermaid-BxpfTIzt.js +1 -0
- package/viewer-dist/assets/min-dark-BSWPekZh.js +1 -0
- package/viewer-dist/assets/min-dark-DECtZcqS.js +1 -0
- package/viewer-dist/assets/min-light-DDpmG2fV.js +1 -0
- package/viewer-dist/assets/min-light-qRIVcaqf.js +1 -0
- package/viewer-dist/assets/mipsasm-BMqwQI7S.js +1 -0
- package/viewer-dist/assets/mojo-fg40_ntQ.js +1 -0
- package/viewer-dist/assets/monokai-BscAjiQZ.js +1 -0
- package/viewer-dist/assets/monokai-CLmrJ-8t.js +1 -0
- package/viewer-dist/assets/moonbit-D9W784E_.js +1 -0
- package/viewer-dist/assets/move-BYnGhZoM.js +1 -0
- package/viewer-dist/assets/narrat-_X_XdTYD.js +1 -0
- package/viewer-dist/assets/nextflow-groovy-1acFxZ7Y.js +1 -0
- package/viewer-dist/assets/nextflow-groovy-C770ykRh.js +1 -0
- package/viewer-dist/assets/nextflow-uA5IJerx.js +1 -0
- package/viewer-dist/assets/nginx-BxRBJ-Af.js +1 -0
- package/viewer-dist/assets/night-owl-DhmEMT88.js +1 -0
- package/viewer-dist/assets/night-owl-eR4AsyAP.js +1 -0
- package/viewer-dist/assets/night-owl-light-C74n5ti-.js +1 -0
- package/viewer-dist/assets/night-owl-light-eJ-hLW7d.js +1 -0
- package/viewer-dist/assets/nim-Dr8hIC6Y.js +1 -0
- package/viewer-dist/assets/nim-ZjzS1dcU.js +1 -0
- package/viewer-dist/assets/nix-IvuFDN5E.js +1 -0
- package/viewer-dist/assets/nord-Cb4Vim4T.js +1 -0
- package/viewer-dist/assets/nord-D4wy7NEP.js +1 -0
- package/viewer-dist/assets/nsis-CjNLYCLg.js +1 -0
- package/viewer-dist/assets/nushell--0fT3PI1.js +1 -0
- package/viewer-dist/assets/objective-c-DMLMCfZd.js +1 -0
- package/viewer-dist/assets/objective-c-D_ECFp-D.js +1 -0
- package/viewer-dist/assets/objective-cpp-BsSzOQcm.js +1 -0
- package/viewer-dist/assets/ocaml-D6dNsUd0.js +1 -0
- package/viewer-dist/assets/ocaml-oSZO9LTw.js +1 -0
- package/viewer-dist/assets/odin-B1RWQWA5.js +1 -0
- package/viewer-dist/assets/one-dark-pro-28TLzoS8.js +1 -0
- package/viewer-dist/assets/one-dark-pro-C6YyR8OD.js +1 -0
- package/viewer-dist/assets/one-light-C0UY_Fh7.js +1 -0
- package/viewer-dist/assets/one-light-D7Lr4KcI.js +1 -0
- package/viewer-dist/assets/openscad-BUDT5pXO.js +1 -0
- package/viewer-dist/assets/org-B3Y3gBCc.js +1 -0
- package/viewer-dist/assets/pascal-4ZHwLPI5.js +1 -0
- package/viewer-dist/assets/perl-Di9CLCS0.js +1 -0
- package/viewer-dist/assets/perl-sgZsTtaf.js +1 -0
- package/viewer-dist/assets/php-D9QpVhjP.js +1 -0
- package/viewer-dist/assets/php-DXPvgw5o.js +1 -0
- package/viewer-dist/assets/pierre-dark-CpLgRqie.js +1 -0
- package/viewer-dist/assets/pierre-dark-fPlffE7i.js +1 -0
- package/viewer-dist/assets/pierre-dark-protanopia-deuteranopia-B35FxJx-.js +1 -0
- package/viewer-dist/assets/pierre-dark-protanopia-deuteranopia-BmjibgrW.js +1 -0
- package/viewer-dist/assets/pierre-dark-soft-Cng2SYKc.js +1 -0
- package/viewer-dist/assets/pierre-dark-soft-kZQmAZld.js +1 -0
- package/viewer-dist/assets/pierre-dark-tritanopia-CpjhbsIL.js +1 -0
- package/viewer-dist/assets/pierre-dark-tritanopia-DneQ5i7L.js +1 -0
- package/viewer-dist/assets/pierre-dark-vibrant-BUK9Y-N_.js +1 -0
- package/viewer-dist/assets/pierre-dark-vibrant-CpQYzh95.js +1 -0
- package/viewer-dist/assets/pierre-light-BvcXQJIj.js +1 -0
- package/viewer-dist/assets/pierre-light-CoaEpmwp.js +1 -0
- package/viewer-dist/assets/pierre-light-protanopia-deuteranopia-0fSaH845.js +1 -0
- package/viewer-dist/assets/pierre-light-protanopia-deuteranopia-Cd5nk0bp.js +1 -0
- package/viewer-dist/assets/pierre-light-soft-BvU23vks.js +1 -0
- package/viewer-dist/assets/pierre-light-soft-lWLdNTOI.js +1 -0
- package/viewer-dist/assets/pierre-light-tritanopia-BSHccQzI.js +1 -0
- package/viewer-dist/assets/pierre-light-tritanopia-CEbqgOJL.js +1 -0
- package/viewer-dist/assets/pierre-light-vibrant-BgMZEwQI.js +1 -0
- package/viewer-dist/assets/pierre-light-vibrant-D80Fkn33.js +1 -0
- package/viewer-dist/assets/pkl-ot-7Btpt.js +1 -0
- package/viewer-dist/assets/plastic-B2V_PDVk.js +1 -0
- package/viewer-dist/assets/plastic-DQwYfKfQ.js +1 -0
- package/viewer-dist/assets/plsql-DGHpHOYJ.js +1 -0
- package/viewer-dist/assets/po-BiJDBrnU.js +1 -0
- package/viewer-dist/assets/poimandres-DB9-pI6r.js +1 -0
- package/viewer-dist/assets/poimandres-DRFjx7u4.js +1 -0
- package/viewer-dist/assets/polar-C7UOKdEL.js +1 -0
- package/viewer-dist/assets/postcss-D_Wz94rJ.js +1 -0
- package/viewer-dist/assets/postcss-e3XvZOFQ.js +1 -0
- package/viewer-dist/assets/powerquery-DNMTfnFr.js +1 -0
- package/viewer-dist/assets/powershell-CItYMEtV.js +1 -0
- package/viewer-dist/assets/powershell-DyPZnz5v.js +1 -0
- package/viewer-dist/assets/preload-helper-BZ1Pz5am.js +1 -0
- package/viewer-dist/assets/prisma-DMgNhnYS.js +1 -0
- package/viewer-dist/assets/prolog-iXnhIJG7.js +1 -0
- package/viewer-dist/assets/proto-DB4EqR-F.js +1 -0
- package/viewer-dist/assets/pug-BlofpNpK.js +1 -0
- package/viewer-dist/assets/pug-nGRwXpob.js +1 -0
- package/viewer-dist/assets/puppet-CDv2pdJW.js +1 -0
- package/viewer-dist/assets/purescript-9MfHhQsQ.js +1 -0
- package/viewer-dist/assets/python-CzFU0dpx.js +1 -0
- package/viewer-dist/assets/python-ORI17Sev.js +1 -0
- package/viewer-dist/assets/qml-BxleM7bJ.js +1 -0
- package/viewer-dist/assets/qmldir-DCQb3MpD.js +1 -0
- package/viewer-dist/assets/qss-Fe1Jh2GI.js +1 -0
- package/viewer-dist/assets/r-DWzjseEo.js +1 -0
- package/viewer-dist/assets/r-Dr1JUpHl.js +1 -0
- package/viewer-dist/assets/racket-DcIDlBhZ.js +1 -0
- package/viewer-dist/assets/raku-B6hKIqfP.js +1 -0
- package/viewer-dist/assets/raku-BtFKomnU.js +1 -0
- package/viewer-dist/assets/razor-UAq-8THt.js +1 -0
- package/viewer-dist/assets/rbs-C0MpOrj4.js +1 -0
- package/viewer-dist/assets/red-CYlAq2b0.js +1 -0
- package/viewer-dist/assets/red-CqYzoXtd.js +1 -0
- package/viewer-dist/assets/reg-CRGYupPL.js +1 -0
- package/viewer-dist/assets/regexp-B4pBNbU3.js +1 -0
- package/viewer-dist/assets/regexp-BWpGejPw.js +1 -0
- package/viewer-dist/assets/rel-BtDbiS_P.js +1 -0
- package/viewer-dist/assets/riscv-Ckw8ddFX.js +1 -0
- package/viewer-dist/assets/rolldown-runtime-Dd_uD5pT.js +1 -0
- package/viewer-dist/assets/ron-VUp2lXgN.js +1 -0
- package/viewer-dist/assets/rose-pine-C3zjVKxG.js +1 -0
- package/viewer-dist/assets/rose-pine-aMsaMD1D.js +1 -0
- package/viewer-dist/assets/rose-pine-dawn-8PwUyIlP.js +1 -0
- package/viewer-dist/assets/rose-pine-dawn-C72QYfqa.js +1 -0
- package/viewer-dist/assets/rose-pine-moon-CSM8ewhO.js +1 -0
- package/viewer-dist/assets/rose-pine-moon-DO-qXg-I.js +1 -0
- package/viewer-dist/assets/rosmsg-CAekHB0j.js +1 -0
- package/viewer-dist/assets/rst-DT-C-5fA.js +1 -0
- package/viewer-dist/assets/ruby-B6sU6EpJ.js +1 -0
- package/viewer-dist/assets/ruby-BwIxDKXu.js +1 -0
- package/viewer-dist/assets/rust-DBZE5Si3.js +1 -0
- package/viewer-dist/assets/rust-tUOVui2B.js +1 -0
- package/viewer-dist/assets/sas-BowjnAvi.js +1 -0
- package/viewer-dist/assets/sass-DXrisJhu.js +1 -0
- package/viewer-dist/assets/scala-Dcd77NNm.js +1 -0
- package/viewer-dist/assets/scala-o2NiCLJc.js +1 -0
- package/viewer-dist/assets/scheme-DQCgrYNe.js +1 -0
- package/viewer-dist/assets/scss-CWs8DVSa.js +1 -0
- package/viewer-dist/assets/scss-Dec6wfVg.js +1 -0
- package/viewer-dist/assets/sdbl-CpzYUp7e.js +1 -0
- package/viewer-dist/assets/sdbl-DFPhMlBm.js +1 -0
- package/viewer-dist/assets/shaderlab-DY7g_Ava.js +1 -0
- package/viewer-dist/assets/shellscript-BiGZg9Om.js +1 -0
- package/viewer-dist/assets/shellscript-CqHdAlCp.js +1 -0
- package/viewer-dist/assets/shellsession-DDrivR0a.js +1 -0
- package/viewer-dist/assets/shiki-BYYByAlk.js +2 -0
- package/viewer-dist/assets/slack-dark-DnToyrRv.js +1 -0
- package/viewer-dist/assets/slack-dark-Dtzi51su.js +1 -0
- package/viewer-dist/assets/slack-ochin-B2OO5cIa.js +1 -0
- package/viewer-dist/assets/slack-ochin-Bb7oPExa.js +1 -0
- package/viewer-dist/assets/smalltalk-BHpQb5nM.js +1 -0
- package/viewer-dist/assets/smithy-Dgaz7aur.js +1 -0
- package/viewer-dist/assets/snazzy-light-4G7pJPwS.js +1 -0
- package/viewer-dist/assets/snazzy-light-DXgiwzKu.js +1 -0
- package/viewer-dist/assets/solarized-dark-BKOT3ICq.js +1 -0
- package/viewer-dist/assets/solarized-dark-b97czJOk.js +1 -0
- package/viewer-dist/assets/solarized-light--Lk5pOfE.js +1 -0
- package/viewer-dist/assets/solarized-light-DFPxpIYQ.js +1 -0
- package/viewer-dist/assets/solidity-Bj7E1mRn.js +1 -0
- package/viewer-dist/assets/soy-CUUUw2U6.js +1 -0
- package/viewer-dist/assets/sparql-Dy5Sx-zJ.js +1 -0
- package/viewer-dist/assets/splunk-BC2Px7Mm.js +1 -0
- package/viewer-dist/assets/sql-BOsskAmu.js +1 -0
- package/viewer-dist/assets/sql-CNu3Or2W.js +1 -0
- package/viewer-dist/assets/ssh-config-BgfXC-Er.js +1 -0
- package/viewer-dist/assets/stata-Dj4sbAEx.js +1 -0
- package/viewer-dist/assets/stream-tokenizer-a_hv0fYK.js +4 -0
- package/viewer-dist/assets/stylus-BOYZFyl7.js +1 -0
- package/viewer-dist/assets/stylus-LiTfbrWi.js +1 -0
- package/viewer-dist/assets/surrealql-NoXzmj18.js +1 -0
- package/viewer-dist/assets/svelte-BaCIHHWd.js +1 -0
- package/viewer-dist/assets/swift-CpxeRS9H.js +1 -0
- package/viewer-dist/assets/swift-DQ24oLw9.js +1 -0
- package/viewer-dist/assets/synthwave-84-BJJFg-sc.js +1 -0
- package/viewer-dist/assets/synthwave-84-nFMaYfgc.js +1 -0
- package/viewer-dist/assets/system-verilog-CIGW6CHD.js +1 -0
- package/viewer-dist/assets/system-verilog-Dp2k_mze.js +1 -0
- package/viewer-dist/assets/systemd-BxMlprV5.js +1 -0
- package/viewer-dist/assets/talonscript-CohzipZa.js +1 -0
- package/viewer-dist/assets/tasl-DMoTqEGO.js +1 -0
- package/viewer-dist/assets/tcl-CZd0xW_V.js +1 -0
- package/viewer-dist/assets/templ-BfgLc4ra.js +1 -0
- package/viewer-dist/assets/terraform-DswuEJGm.js +1 -0
- package/viewer-dist/assets/tex-C9L8xJex.js +1 -0
- package/viewer-dist/assets/tex-CeakZqzU.js +1 -0
- package/viewer-dist/assets/themes-DP0gt5jG.js +2 -0
- package/viewer-dist/assets/tokyo-night-DvpptEDd.js +1 -0
- package/viewer-dist/assets/tokyo-night-oM2G3aXe.js +1 -0
- package/viewer-dist/assets/toml-CcmNWLt0.js +1 -0
- package/viewer-dist/assets/ts-tags-DLz2GTd3.js +1 -0
- package/viewer-dist/assets/tsv-sltzmVWM.js +1 -0
- package/viewer-dist/assets/tsx-5f3ulCja.js +1 -0
- package/viewer-dist/assets/tsx-BOvsFOI6.js +1 -0
- package/viewer-dist/assets/turtle-B2uMLKuz.js +1 -0
- package/viewer-dist/assets/turtle-CcN57yC0.js +1 -0
- package/viewer-dist/assets/twig-BuizuR2K.js +1 -0
- package/viewer-dist/assets/twig-p9meEoSL.js +1 -0
- package/viewer-dist/assets/typescript-Utq2Cl8c.js +1 -0
- package/viewer-dist/assets/typescript-j_1H8WHN.js +1 -0
- package/viewer-dist/assets/typespec-BGhR2SqG.js +1 -0
- package/viewer-dist/assets/typst-qZ7a-KdK.js +1 -0
- package/viewer-dist/assets/unwrapDefault-ByDmBtHB.js +1 -0
- package/viewer-dist/assets/v-DBj4K9d_.js +1 -0
- package/viewer-dist/assets/vala-zf12oZj6.js +1 -0
- package/viewer-dist/assets/vb-3nVziYZS.js +1 -0
- package/viewer-dist/assets/vb-Dcr14nCw.js +1 -0
- package/viewer-dist/assets/verilog-DUw2aqD4.js +1 -0
- package/viewer-dist/assets/verilog-kL8Dwv27.js +1 -0
- package/viewer-dist/assets/vesper-C1rBZbON.js +1 -0
- package/viewer-dist/assets/vesper-DdrHHSXu.js +1 -0
- package/viewer-dist/assets/vhdl-BroJfC0k.js +1 -0
- package/viewer-dist/assets/viml-DvXPmvsu.js +1 -0
- package/viewer-dist/assets/vitesse-black-Sqvrs2Sw.js +1 -0
- package/viewer-dist/assets/vitesse-black-fwtXNY1n.js +1 -0
- package/viewer-dist/assets/vitesse-dark-BWf_ZQtP.js +1 -0
- package/viewer-dist/assets/vitesse-dark-BZCL-v6S.js +1 -0
- package/viewer-dist/assets/vitesse-light-Cqenv4Qv.js +1 -0
- package/viewer-dist/assets/vitesse-light-VbXTXTou.js +1 -0
- package/viewer-dist/assets/vue-html-CGMs_6qn.js +1 -0
- package/viewer-dist/assets/vue-qH43U_rv.js +1 -0
- package/viewer-dist/assets/vue-vine-6XI2pIvQ.js +1 -0
- package/viewer-dist/assets/vyper-CgoNMtux.js +1 -0
- package/viewer-dist/assets/wasm-BnjxR4X6.js +1 -0
- package/viewer-dist/assets/wasm-ByWQv1Qj.js +1 -0
- package/viewer-dist/assets/wenyan-C8pVoKbM.js +1 -0
- package/viewer-dist/assets/wgsl-BsKzXJz4.js +1 -0
- package/viewer-dist/assets/wikitext-ClFFjSW2.js +1 -0
- package/viewer-dist/assets/wit-DdvCle-K.js +1 -0
- package/viewer-dist/assets/wolfram-DLL8P-h_.js +1 -0
- package/viewer-dist/assets/xml-CoDIzWF0.js +1 -0
- package/viewer-dist/assets/xml-WY0zc4PG.js +1 -0
- package/viewer-dist/assets/xsl-ChYNfH-b.js +1 -0
- package/viewer-dist/assets/xsl-Czhm44Ae.js +1 -0
- package/viewer-dist/assets/yaml-CxbubiML.js +1 -0
- package/viewer-dist/assets/yaml-DijMHRDA.js +1 -0
- package/viewer-dist/assets/zenscript-BnlCZFoB.js +1 -0
- package/viewer-dist/assets/zig-B7sSDI6F.js +1 -0
- package/viewer-dist/assets/zig-VWdiCTxG.js +1 -0
- package/viewer-dist/index.html +77 -0
package/lib/cli.js
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
import { readFileSync } from "node:fs";
|
|
2
|
+
import { Cli, z } from "incur";
|
|
3
|
+
import { resolveFromInvokeCwd } from "./invokeCwd.js";
|
|
4
|
+
import { packageVersion } from "./packageVersion.js";
|
|
5
|
+
import { listRunningDiffmaps } from "./registry.js";
|
|
6
|
+
import { exitAfterTelemetry, track, trackCommand } from "./telemetry.js";
|
|
7
|
+
import { detectInstallMethod, fetchLatestVersion, packageName, resolveUpdateArgv, runCommand, runUpdate, } from "./update.js";
|
|
8
|
+
const serveArgs = z.object({
|
|
9
|
+
file: z
|
|
10
|
+
.string()
|
|
11
|
+
.describe("The spec's directory, such as .diffmap/specs/<name>/"),
|
|
12
|
+
});
|
|
13
|
+
const serveOptions = z.object({
|
|
14
|
+
port: z.coerce.number().optional().describe("Port (default: a free port)"),
|
|
15
|
+
root: z.string().optional().describe("Workspace root for file excerpts"),
|
|
16
|
+
});
|
|
17
|
+
const serveOutput = z.object({
|
|
18
|
+
url: z.string(),
|
|
19
|
+
file: z.string(),
|
|
20
|
+
warnings: z.array(z.string()).optional(),
|
|
21
|
+
});
|
|
22
|
+
async function* runServe(c) {
|
|
23
|
+
trackCommand("serve");
|
|
24
|
+
// Loaded per command so `--version`, `list`, and `update` skip the server's dependencies.
|
|
25
|
+
const { startServer } = await import("./serve.js");
|
|
26
|
+
let readyAt = Date.now();
|
|
27
|
+
let opened = false;
|
|
28
|
+
const started = await startServer({
|
|
29
|
+
filePath: resolveFromInvokeCwd(c.args.file),
|
|
30
|
+
workspaceRoot: c.options.root === undefined
|
|
31
|
+
? resolveFromInvokeCwd(".")
|
|
32
|
+
: resolveFromInvokeCwd(c.options.root),
|
|
33
|
+
port: c.options.port,
|
|
34
|
+
onViewerEvent({ event, ...properties }) {
|
|
35
|
+
if (event !== "viewer_opened")
|
|
36
|
+
return track(event, properties, "viewer");
|
|
37
|
+
// Live reloads load the page again; only the first load says this spec was seen.
|
|
38
|
+
if (opened)
|
|
39
|
+
return;
|
|
40
|
+
opened = true;
|
|
41
|
+
track(event, { seconds_after_serve: Math.round((Date.now() - readyAt) / 1000) }, "viewer");
|
|
42
|
+
},
|
|
43
|
+
});
|
|
44
|
+
readyAt = Date.now();
|
|
45
|
+
if (started instanceof Error) {
|
|
46
|
+
track("serve_result", { ok: false, error: started.name });
|
|
47
|
+
return c.error({
|
|
48
|
+
code: "DIFFMAP",
|
|
49
|
+
message: started.message,
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
// How many of each fence kind the spec uses across its pages (a kind it never uses is left out), to see which parts of the guide agents follow.
|
|
53
|
+
const contents = {
|
|
54
|
+
pages: started.documents.length,
|
|
55
|
+
references: started.documents.reduce((sum, document) => sum + document.references.length, 0),
|
|
56
|
+
};
|
|
57
|
+
const { collectFences } = await import("./parseViewer.js");
|
|
58
|
+
for (const document of started.documents) {
|
|
59
|
+
for (const fence of collectFences(document.nodes))
|
|
60
|
+
contents[`fence_${fence.kind}`] =
|
|
61
|
+
(contents[`fence_${fence.kind}`] ?? 0) + 1;
|
|
62
|
+
}
|
|
63
|
+
track("serve_result", { ok: true, ...contents });
|
|
64
|
+
const output = {
|
|
65
|
+
url: started.url,
|
|
66
|
+
file: started.filePath,
|
|
67
|
+
...(started.warnings.length > 0 ? { warnings: started.warnings } : {}),
|
|
68
|
+
};
|
|
69
|
+
yield output;
|
|
70
|
+
await started.closed;
|
|
71
|
+
return output;
|
|
72
|
+
}
|
|
73
|
+
const cli = Cli.create("product-doc", {
|
|
74
|
+
description: "Explain systems, plan work, and review changes as visual documents",
|
|
75
|
+
version: packageVersion,
|
|
76
|
+
args: serveArgs,
|
|
77
|
+
options: serveOptions,
|
|
78
|
+
output: serveOutput,
|
|
79
|
+
hint: "`guide` prints how to write a spec. A spec is a directory of Markdown pages, such as `.diffmap/specs/<name>/`. `validate <spec>` checks it without starting a server. `serve <spec>` runs the local viewer. `share <spec>` publishes an unlisted gist. `update` (or `--update`) installs the latest product-doc.",
|
|
80
|
+
examples: [
|
|
81
|
+
{
|
|
82
|
+
args: { file: ".diffmap/specs/sessions/" },
|
|
83
|
+
description: "Same as `product-doc serve .diffmap/specs/sessions/`",
|
|
84
|
+
},
|
|
85
|
+
],
|
|
86
|
+
run: runServe,
|
|
87
|
+
})
|
|
88
|
+
.command("serve", {
|
|
89
|
+
description: "Run the local viewer server",
|
|
90
|
+
args: serveArgs,
|
|
91
|
+
options: serveOptions,
|
|
92
|
+
output: serveOutput,
|
|
93
|
+
examples: [
|
|
94
|
+
{
|
|
95
|
+
args: { file: ".diffmap/specs/sessions/" },
|
|
96
|
+
description: "Open the local viewer",
|
|
97
|
+
},
|
|
98
|
+
],
|
|
99
|
+
run: runServe,
|
|
100
|
+
})
|
|
101
|
+
.command("validate", {
|
|
102
|
+
description: "Check a spec's syntax, diagrams, and annotations without starting a server",
|
|
103
|
+
args: serveArgs,
|
|
104
|
+
output: z.object({
|
|
105
|
+
file: z.string(),
|
|
106
|
+
valid: z.literal(true),
|
|
107
|
+
pages: z.array(z.string()),
|
|
108
|
+
}),
|
|
109
|
+
async run(c) {
|
|
110
|
+
trackCommand("validate");
|
|
111
|
+
const { parseSpec, readSpec } = await import("./readSpec.js");
|
|
112
|
+
const file = resolveFromInvokeCwd(c.args.file);
|
|
113
|
+
const read = await readSpec(file);
|
|
114
|
+
const result = read instanceof Error ? read : parseSpec(read);
|
|
115
|
+
if (result instanceof Error)
|
|
116
|
+
return c.error({ code: "DIFFMAP", message: result.message });
|
|
117
|
+
return c.ok({
|
|
118
|
+
file,
|
|
119
|
+
valid: true,
|
|
120
|
+
pages: result.map((page) => page.file),
|
|
121
|
+
});
|
|
122
|
+
},
|
|
123
|
+
})
|
|
124
|
+
.command("share", {
|
|
125
|
+
description: "Publish an unlisted gist and print https://diffmap.dev/g/<id>",
|
|
126
|
+
args: serveArgs,
|
|
127
|
+
options: z.object({
|
|
128
|
+
public: z.boolean().optional().describe("Create a public gist"),
|
|
129
|
+
}),
|
|
130
|
+
output: z.object({
|
|
131
|
+
gistId: z.string(),
|
|
132
|
+
gistUrl: z.string(),
|
|
133
|
+
viewerUrl: z.string(),
|
|
134
|
+
}),
|
|
135
|
+
examples: [
|
|
136
|
+
{
|
|
137
|
+
args: { file: ".diffmap/specs/sessions/" },
|
|
138
|
+
description: "Unlisted gist → https://diffmap.dev/g/<id>",
|
|
139
|
+
},
|
|
140
|
+
],
|
|
141
|
+
async run(c) {
|
|
142
|
+
trackCommand("share");
|
|
143
|
+
const { shareMarkdownFile } = await import("./share.js");
|
|
144
|
+
const shared = await shareMarkdownFile({
|
|
145
|
+
filePath: resolveFromInvokeCwd(c.args.file),
|
|
146
|
+
workspaceRoot: resolveFromInvokeCwd("."),
|
|
147
|
+
isPublic: c.options.public === true,
|
|
148
|
+
});
|
|
149
|
+
if (shared instanceof Error) {
|
|
150
|
+
return c.error({
|
|
151
|
+
code: "DIFFMAP",
|
|
152
|
+
message: shared.message,
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
return c.ok(shared);
|
|
156
|
+
},
|
|
157
|
+
})
|
|
158
|
+
.command("guide", {
|
|
159
|
+
description: "Print the instructions agents follow to write a spec",
|
|
160
|
+
output: z.string(),
|
|
161
|
+
run() {
|
|
162
|
+
trackCommand("guide");
|
|
163
|
+
return readFileSync(new URL("../guide.md", import.meta.url), "utf8");
|
|
164
|
+
},
|
|
165
|
+
})
|
|
166
|
+
.command("list", {
|
|
167
|
+
description: "List running productdoc viewers",
|
|
168
|
+
output: z.object({
|
|
169
|
+
instances: z.array(z.object({
|
|
170
|
+
pid: z.number(),
|
|
171
|
+
title: z.string(),
|
|
172
|
+
url: z.string(),
|
|
173
|
+
file: z.string(),
|
|
174
|
+
})),
|
|
175
|
+
}),
|
|
176
|
+
async run(c) {
|
|
177
|
+
trackCommand("list");
|
|
178
|
+
const instances = await listRunningDiffmaps();
|
|
179
|
+
if (instances instanceof Error) {
|
|
180
|
+
return c.error({
|
|
181
|
+
code: "DIFFMAP",
|
|
182
|
+
message: instances.message,
|
|
183
|
+
});
|
|
184
|
+
}
|
|
185
|
+
return c.ok({ instances });
|
|
186
|
+
},
|
|
187
|
+
})
|
|
188
|
+
.command("update", {
|
|
189
|
+
description: `Update product-doc to the latest ${packageName} on npm (same as --update)`,
|
|
190
|
+
output: z.object({
|
|
191
|
+
status: z.enum(["up-to-date", "updated", "manual"]),
|
|
192
|
+
message: z.string(),
|
|
193
|
+
current: z.string(),
|
|
194
|
+
previous: z.string().optional(),
|
|
195
|
+
latest: z.string().optional(),
|
|
196
|
+
command: z.string().optional(),
|
|
197
|
+
}),
|
|
198
|
+
async run(c) {
|
|
199
|
+
trackCommand("update");
|
|
200
|
+
const result = await runUpdate({
|
|
201
|
+
currentVersion: packageVersion,
|
|
202
|
+
fetchLatestVersion,
|
|
203
|
+
detectInstallMethod,
|
|
204
|
+
runCommand,
|
|
205
|
+
});
|
|
206
|
+
if (result instanceof Error) {
|
|
207
|
+
return c.error({
|
|
208
|
+
code: "UPDATE_FAILED",
|
|
209
|
+
message: result.message,
|
|
210
|
+
});
|
|
211
|
+
}
|
|
212
|
+
return c.ok(result);
|
|
213
|
+
},
|
|
214
|
+
});
|
|
215
|
+
await cli.serve(resolveUpdateArgv(process.argv.slice(2)), {
|
|
216
|
+
exit: exitAfterTelemetry,
|
|
217
|
+
});
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export type CodeNote = {
|
|
2
|
+
target: {
|
|
3
|
+
kind: "lines";
|
|
4
|
+
start: number;
|
|
5
|
+
end: number;
|
|
6
|
+
} | {
|
|
7
|
+
kind: "symbol";
|
|
8
|
+
symbol: string;
|
|
9
|
+
lines?: {
|
|
10
|
+
start: number;
|
|
11
|
+
end: number;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
text: string;
|
|
15
|
+
};
|
|
16
|
+
/** A symbol note's match on one line: `[start, end)` columns. */
|
|
17
|
+
export type SymbolMatch = {
|
|
18
|
+
start: number;
|
|
19
|
+
end: number;
|
|
20
|
+
note: CodeNote;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Splits trailing `// [!note target] text` lines off a code fence. Blank
|
|
24
|
+
* lines between notes are allowed; note-like lines above other code stay
|
|
25
|
+
* code, so fences that document this syntax render unchanged.
|
|
26
|
+
*/
|
|
27
|
+
export declare function parseCodeNotes(source: string): {
|
|
28
|
+
code: string;
|
|
29
|
+
notes: CodeNote[];
|
|
30
|
+
};
|
|
31
|
+
/** Why a fence's highlights or notes are invalid, or undefined. `lines` is the rendered text of each line or row. */
|
|
32
|
+
export declare function notesProblem(fence: {
|
|
33
|
+
lines: string[];
|
|
34
|
+
highlights: number[];
|
|
35
|
+
notes: CodeNote[];
|
|
36
|
+
}): string | undefined;
|
|
37
|
+
/** First whole-word occurrence of each eligible symbol note on a 1-based line. */
|
|
38
|
+
export declare function lineSymbolMatches(line: string, notes: CodeNote[], row: number): SymbolMatch[];
|
package/lib/codeNotes.js
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
const notePrefix = /^\s*(?:\/\/|#|--)\s*\[!note\b/;
|
|
2
|
+
const notePattern = /^\s*(?:\/\/|#|--)\s*\[!note\s+([^\]]+?)\s*\]\s*(.*?)\s*$/;
|
|
3
|
+
const linesPattern = /^L(\d+)(?:-L(\d+))?(?:\s+(.+))?$/;
|
|
4
|
+
const identifierChar = /[\w$]/;
|
|
5
|
+
/**
|
|
6
|
+
* Splits trailing `// [!note target] text` lines off a code fence. Blank
|
|
7
|
+
* lines between notes are allowed; note-like lines above other code stay
|
|
8
|
+
* code, so fences that document this syntax render unchanged.
|
|
9
|
+
*/
|
|
10
|
+
export function parseCodeNotes(source) {
|
|
11
|
+
const lines = source.split("\n");
|
|
12
|
+
let end = lines.length;
|
|
13
|
+
while (end > 0 &&
|
|
14
|
+
(lines[end - 1].trim() === "" || notePrefix.test(lines[end - 1])))
|
|
15
|
+
end--;
|
|
16
|
+
const notes = lines.slice(end).flatMap((line) => {
|
|
17
|
+
if (line.trim() === "")
|
|
18
|
+
return [];
|
|
19
|
+
const match = notePattern.exec(line);
|
|
20
|
+
if (match === null || match[2] === "")
|
|
21
|
+
return [{ target: { kind: "symbol", symbol: "" }, text: line }];
|
|
22
|
+
const lineRange = linesPattern.exec(match[1]);
|
|
23
|
+
const target = lineRange === null
|
|
24
|
+
? { kind: "symbol", symbol: match[1] }
|
|
25
|
+
: lineRange[3] === undefined
|
|
26
|
+
? {
|
|
27
|
+
kind: "lines",
|
|
28
|
+
start: Number(lineRange[1]),
|
|
29
|
+
end: Number(lineRange[2] ?? lineRange[1]),
|
|
30
|
+
}
|
|
31
|
+
: {
|
|
32
|
+
kind: "symbol",
|
|
33
|
+
symbol: lineRange[3],
|
|
34
|
+
lines: {
|
|
35
|
+
start: Number(lineRange[1]),
|
|
36
|
+
end: Number(lineRange[2] ?? lineRange[1]),
|
|
37
|
+
},
|
|
38
|
+
};
|
|
39
|
+
return [{ target, text: match[2] }];
|
|
40
|
+
});
|
|
41
|
+
return { code: lines.slice(0, end).join("\n"), notes };
|
|
42
|
+
}
|
|
43
|
+
/** Why a fence's highlights or notes are invalid, or undefined. `lines` is the rendered text of each line or row. */
|
|
44
|
+
export function notesProblem(fence) {
|
|
45
|
+
const lines = fence.lines;
|
|
46
|
+
const highlight = fence.highlights.find((n) => n < 1 || n > lines.length);
|
|
47
|
+
if (highlight !== undefined)
|
|
48
|
+
return `Highlighted line ${highlight} is outside the ${lines.length}-line code fence`;
|
|
49
|
+
const covered = new Set();
|
|
50
|
+
for (const note of fence.notes) {
|
|
51
|
+
const target = note.target;
|
|
52
|
+
const range = target.kind === "lines" ? target : target.lines;
|
|
53
|
+
if (range !== undefined &&
|
|
54
|
+
(range.start < 1 || range.end < range.start || range.end > lines.length))
|
|
55
|
+
return `Note lines L${range.start}-L${range.end} are outside the ${lines.length}-line code fence`;
|
|
56
|
+
if (target.kind === "symbol") {
|
|
57
|
+
if (target.symbol === "")
|
|
58
|
+
return `Invalid note "${note.text.trim()}". Use // [!note symbol] text or // [!note L3-L5] text`;
|
|
59
|
+
const scopedLines = range === undefined ? lines : lines.slice(range.start - 1, range.end);
|
|
60
|
+
if (!scopedLines.some((line) => symbolStart(line, target.symbol) !== undefined))
|
|
61
|
+
return `Note target "${target.symbol}" does not appear in its code fence${range === undefined ? "" : ` on lines L${range.start}-L${range.end}`}`;
|
|
62
|
+
continue;
|
|
63
|
+
}
|
|
64
|
+
for (let n = target.start; n <= target.end; n++) {
|
|
65
|
+
if (covered.has(n))
|
|
66
|
+
return `Line notes overlap at line ${n}`;
|
|
67
|
+
covered.add(n);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
/** First whole-word occurrence of each eligible symbol note on a 1-based line. */
|
|
73
|
+
export function lineSymbolMatches(line, notes, row) {
|
|
74
|
+
const matches = notes
|
|
75
|
+
.flatMap((note) => {
|
|
76
|
+
const target = note.target;
|
|
77
|
+
if (target.kind !== "symbol" ||
|
|
78
|
+
(target.lines !== undefined &&
|
|
79
|
+
(row < target.lines.start || row > target.lines.end)))
|
|
80
|
+
return [];
|
|
81
|
+
const start = symbolStart(line, target.symbol);
|
|
82
|
+
return start === undefined
|
|
83
|
+
? []
|
|
84
|
+
: [{ start, end: start + target.symbol.length, note }];
|
|
85
|
+
})
|
|
86
|
+
.toSorted((a, b) => a.start - b.start ||
|
|
87
|
+
b.end - a.end ||
|
|
88
|
+
Number(b.note.target.kind === "symbol" && b.note.target.lines !== undefined) -
|
|
89
|
+
Number(a.note.target.kind === "symbol" &&
|
|
90
|
+
a.note.target.lines !== undefined));
|
|
91
|
+
const kept = [];
|
|
92
|
+
for (const match of matches) {
|
|
93
|
+
const last = kept.at(-1);
|
|
94
|
+
if (last === undefined || match.start >= last.end)
|
|
95
|
+
kept.push(match);
|
|
96
|
+
}
|
|
97
|
+
return kept;
|
|
98
|
+
}
|
|
99
|
+
/** First whole-word start column, respecting identifier boundaries. */
|
|
100
|
+
function symbolStart(line, symbol) {
|
|
101
|
+
for (let at = line.indexOf(symbol); at !== -1; at = line.indexOf(symbol, at + 1)) {
|
|
102
|
+
const before = line[at - 1];
|
|
103
|
+
const after = line[at + symbol.length];
|
|
104
|
+
const wordStart = identifierChar.test(symbol[0]);
|
|
105
|
+
const wordEnd = identifierChar.test(symbol.at(-1));
|
|
106
|
+
if (wordStart && before !== undefined && identifierChar.test(before))
|
|
107
|
+
continue;
|
|
108
|
+
if (wordEnd && after !== undefined && identifierChar.test(after))
|
|
109
|
+
continue;
|
|
110
|
+
return at;
|
|
111
|
+
}
|
|
112
|
+
return undefined;
|
|
113
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DiffmapDefinitionError } from "./errors.js";
|
|
2
|
+
export type SourceDefinition = {
|
|
3
|
+
path: string;
|
|
4
|
+
contents: string;
|
|
5
|
+
start: number;
|
|
6
|
+
end: number;
|
|
7
|
+
};
|
|
8
|
+
export type DefinitionResponse = {
|
|
9
|
+
definition?: SourceDefinition;
|
|
10
|
+
error?: string;
|
|
11
|
+
};
|
|
12
|
+
export declare function findDefinition(workspaceRoot: string, params: URLSearchParams): DiffmapDefinitionError | {
|
|
13
|
+
path: string;
|
|
14
|
+
contents: string;
|
|
15
|
+
start: number;
|
|
16
|
+
end: number;
|
|
17
|
+
} | undefined;
|
|
18
|
+
export declare function readSourceReference(workspaceRoot: string, params: URLSearchParams): DiffmapDefinitionError | {
|
|
19
|
+
path: string;
|
|
20
|
+
contents: string;
|
|
21
|
+
start: number;
|
|
22
|
+
end: number;
|
|
23
|
+
};
|
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
|
|
2
|
+
if (value !== null && value !== void 0) {
|
|
3
|
+
if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
|
|
4
|
+
var dispose, inner;
|
|
5
|
+
if (async) {
|
|
6
|
+
if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
|
|
7
|
+
dispose = value[Symbol.asyncDispose];
|
|
8
|
+
}
|
|
9
|
+
if (dispose === void 0) {
|
|
10
|
+
if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
|
|
11
|
+
dispose = value[Symbol.dispose];
|
|
12
|
+
if (async) inner = dispose;
|
|
13
|
+
}
|
|
14
|
+
if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
|
|
15
|
+
if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
|
|
16
|
+
env.stack.push({ value: value, dispose: dispose, async: async });
|
|
17
|
+
}
|
|
18
|
+
else if (async) {
|
|
19
|
+
env.stack.push({ async: true });
|
|
20
|
+
}
|
|
21
|
+
return value;
|
|
22
|
+
};
|
|
23
|
+
var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
|
|
24
|
+
return function (env) {
|
|
25
|
+
function fail(e) {
|
|
26
|
+
env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
|
|
27
|
+
env.hasError = true;
|
|
28
|
+
}
|
|
29
|
+
var r, s = 0;
|
|
30
|
+
function next() {
|
|
31
|
+
while (r = env.stack.pop()) {
|
|
32
|
+
try {
|
|
33
|
+
if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
|
|
34
|
+
if (r.dispose) {
|
|
35
|
+
var result = r.dispose.call(r.value);
|
|
36
|
+
if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
|
|
37
|
+
}
|
|
38
|
+
else s |= 1;
|
|
39
|
+
}
|
|
40
|
+
catch (e) {
|
|
41
|
+
fail(e);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
|
|
45
|
+
if (env.hasError) throw env.error;
|
|
46
|
+
}
|
|
47
|
+
return next();
|
|
48
|
+
};
|
|
49
|
+
})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
|
|
50
|
+
var e = new Error(message);
|
|
51
|
+
return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
|
|
52
|
+
});
|
|
53
|
+
import { readFileSync } from "node:fs";
|
|
54
|
+
import path from "node:path";
|
|
55
|
+
import { isClassDeclaration, isEnumDeclaration, isEnumMember, isFunctionDeclaration, isGetAccessorDeclaration, isInterfaceDeclaration, isMethodDeclaration, isMethodSignatureDeclaration, isModuleDeclaration, isPropertyDeclaration, isPropertySignatureDeclaration, isSetAccessorDeclaration, isTypeAliasDeclaration, isVariableDeclaration, } from "typescript/unstable/ast";
|
|
56
|
+
import { API, SymbolFlags, } from "typescript/unstable/sync";
|
|
57
|
+
import * as errore from "errore";
|
|
58
|
+
import { DiffmapDefinitionError } from "./errors.js";
|
|
59
|
+
export function findDefinition(workspaceRoot, params) {
|
|
60
|
+
const requestedPath = params.get("path");
|
|
61
|
+
const line = Number(params.get("line"));
|
|
62
|
+
const column = Number(params.get("column"));
|
|
63
|
+
const lineText = params.get("text");
|
|
64
|
+
if (requestedPath === null ||
|
|
65
|
+
lineText === null ||
|
|
66
|
+
!Number.isSafeInteger(line) ||
|
|
67
|
+
line < 1 ||
|
|
68
|
+
!Number.isSafeInteger(column) ||
|
|
69
|
+
column < 0)
|
|
70
|
+
return new DiffmapDefinitionError({ reason: "Invalid source position." });
|
|
71
|
+
const fileName = path.resolve(workspaceRoot, requestedPath);
|
|
72
|
+
if (!fileName.startsWith(workspaceRoot + path.sep)) {
|
|
73
|
+
return new DiffmapDefinitionError({
|
|
74
|
+
reason: "Path escapes the workspace.",
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
if (!/\.[cm]?[jt]sx?$/i.test(fileName)) {
|
|
78
|
+
return new DiffmapDefinitionError({
|
|
79
|
+
reason: "Definition navigation supports TypeScript and JavaScript.",
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
const contents = readSource(fileName, "This file is no longer in the workspace.");
|
|
83
|
+
if (contents instanceof Error)
|
|
84
|
+
return contents;
|
|
85
|
+
const lines = contents.split(/\r?\n/);
|
|
86
|
+
if (lines[line - 1] !== lineText || column >= lineText.length) {
|
|
87
|
+
return new DiffmapDefinitionError({
|
|
88
|
+
reason: "This diff line differs from the current workspace. Its definition cannot be resolved.",
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
return withProject(workspaceRoot, fileName, (project, source) => {
|
|
92
|
+
const position = source.getPositionOfLineAndCharacter(line - 1, column);
|
|
93
|
+
let symbol = project.checker.getSymbolAtPosition(fileName, position);
|
|
94
|
+
if (symbol === undefined)
|
|
95
|
+
return undefined;
|
|
96
|
+
if ((symbol.flags & SymbolFlags.Alias) !== 0) {
|
|
97
|
+
symbol = project.checker.getAliasedSymbol(symbol);
|
|
98
|
+
}
|
|
99
|
+
const handle = symbol.valueDeclaration ?? symbol.declarations[0];
|
|
100
|
+
const declaration = handle?.resolve();
|
|
101
|
+
if (declaration === undefined)
|
|
102
|
+
return undefined;
|
|
103
|
+
const target = declaration.getSourceFile();
|
|
104
|
+
const name = declarationName(declaration);
|
|
105
|
+
const start = name?.getStart(target) ?? declaration.getStart(target);
|
|
106
|
+
const end = name?.getEnd() ?? declaration.getEnd();
|
|
107
|
+
return {
|
|
108
|
+
path: path.relative(workspaceRoot, target.fileName),
|
|
109
|
+
contents: target.text,
|
|
110
|
+
start: target.getLineAndCharacterOfPosition(start).line + 1,
|
|
111
|
+
end: target.getLineAndCharacterOfPosition(end).line + 1,
|
|
112
|
+
};
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
export function readSourceReference(workspaceRoot, params) {
|
|
116
|
+
const requestedPath = params.get("path");
|
|
117
|
+
if (requestedPath === null || requestedPath.length === 0)
|
|
118
|
+
return new DiffmapDefinitionError({ reason: "Missing file path." });
|
|
119
|
+
const fileName = path.resolve(workspaceRoot, requestedPath);
|
|
120
|
+
if (!fileName.startsWith(workspaceRoot + path.sep))
|
|
121
|
+
return new DiffmapDefinitionError({
|
|
122
|
+
reason: "Path escapes the workspace.",
|
|
123
|
+
});
|
|
124
|
+
const contents = readSource(fileName, `Could not read ${requestedPath}.`);
|
|
125
|
+
if (contents instanceof Error)
|
|
126
|
+
return contents;
|
|
127
|
+
const symbol = params.get("symbol");
|
|
128
|
+
if (symbol !== null) {
|
|
129
|
+
if (!/\.[cm]?[jt]sx?$/i.test(fileName))
|
|
130
|
+
return new DiffmapDefinitionError({
|
|
131
|
+
reason: "Symbol references support TypeScript and JavaScript.",
|
|
132
|
+
});
|
|
133
|
+
return withProject(workspaceRoot, fileName, (project, sourceFile) => {
|
|
134
|
+
const matches = sourceDeclarations(project, sourceFile, symbol);
|
|
135
|
+
if (matches.length === 0)
|
|
136
|
+
return new DiffmapDefinitionError({
|
|
137
|
+
reason: `Symbol "${symbol}" was not found in ${requestedPath}.`,
|
|
138
|
+
});
|
|
139
|
+
if (matches.length > 1)
|
|
140
|
+
return new DiffmapDefinitionError({
|
|
141
|
+
reason: `Symbol "${symbol}" is ambiguous. Use a qualified name: ${matches.map((match) => match.name).join(", ")}.`,
|
|
142
|
+
});
|
|
143
|
+
const match = matches[0];
|
|
144
|
+
const start = Math.min(...match.nodes.map((node) => node.getStart(sourceFile)));
|
|
145
|
+
const end = Math.max(...match.nodes.map((node) => node.getEnd()));
|
|
146
|
+
return {
|
|
147
|
+
path: path.relative(workspaceRoot, fileName),
|
|
148
|
+
contents,
|
|
149
|
+
start: sourceFile.getLineAndCharacterOfPosition(start).line + 1,
|
|
150
|
+
end: sourceFile.getLineAndCharacterOfPosition(Math.max(start, end - 1))
|
|
151
|
+
.line + 1,
|
|
152
|
+
};
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
const lineCount = contents.split("\n").length;
|
|
156
|
+
const start = params.has("start") ? Number(params.get("start")) : 1;
|
|
157
|
+
const end = params.has("end") ? Number(params.get("end")) : lineCount;
|
|
158
|
+
if (!Number.isSafeInteger(start) ||
|
|
159
|
+
!Number.isSafeInteger(end) ||
|
|
160
|
+
start < 1 ||
|
|
161
|
+
end < start ||
|
|
162
|
+
end > lineCount)
|
|
163
|
+
return new DiffmapDefinitionError({
|
|
164
|
+
reason: `Invalid line range for ${requestedPath}.`,
|
|
165
|
+
});
|
|
166
|
+
return {
|
|
167
|
+
path: path.relative(workspaceRoot, fileName),
|
|
168
|
+
contents,
|
|
169
|
+
start,
|
|
170
|
+
end,
|
|
171
|
+
};
|
|
172
|
+
}
|
|
173
|
+
function readSource(fileName, reason) {
|
|
174
|
+
return errore.try({
|
|
175
|
+
try: () => readFileSync(fileName, "utf8"),
|
|
176
|
+
catch: (cause) => new DiffmapDefinitionError({ reason, cause }),
|
|
177
|
+
});
|
|
178
|
+
}
|
|
179
|
+
function withProject(workspaceRoot, fileName, run) {
|
|
180
|
+
return errore.try({
|
|
181
|
+
try: () => {
|
|
182
|
+
const env_1 = { stack: [], error: void 0, hasError: false };
|
|
183
|
+
try {
|
|
184
|
+
const resources = __addDisposableResource(env_1, new errore.DisposableStack(), false);
|
|
185
|
+
const api = new API({ cwd: workspaceRoot });
|
|
186
|
+
resources.defer(() => api.close());
|
|
187
|
+
const snapshot = api.updateSnapshot({ openFiles: [fileName] });
|
|
188
|
+
resources.defer(() => snapshot.dispose());
|
|
189
|
+
const project = snapshot.getDefaultProjectForFile(fileName);
|
|
190
|
+
const source = project?.program.getSourceFile(fileName);
|
|
191
|
+
if (project === undefined || source === undefined)
|
|
192
|
+
return new DiffmapDefinitionError({
|
|
193
|
+
reason: "TypeScript could not open this source file.",
|
|
194
|
+
});
|
|
195
|
+
return run(project, source);
|
|
196
|
+
}
|
|
197
|
+
catch (e_1) {
|
|
198
|
+
env_1.error = e_1;
|
|
199
|
+
env_1.hasError = true;
|
|
200
|
+
}
|
|
201
|
+
finally {
|
|
202
|
+
__disposeResources(env_1);
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
catch: (cause) => new DiffmapDefinitionError({
|
|
206
|
+
reason: "TypeScript could not resolve this source file.",
|
|
207
|
+
cause,
|
|
208
|
+
}),
|
|
209
|
+
});
|
|
210
|
+
}
|
|
211
|
+
function sourceDeclarations(project, source, requestedName) {
|
|
212
|
+
const resolved = resolveSourceSymbol(project, source, requestedName);
|
|
213
|
+
if (resolved.length > 0)
|
|
214
|
+
return resolved;
|
|
215
|
+
const matches = new Map();
|
|
216
|
+
const visit = (node, parents) => {
|
|
217
|
+
const nameNode = isSourceDeclaration(node)
|
|
218
|
+
? declarationName(node)
|
|
219
|
+
: undefined;
|
|
220
|
+
const name = nameNode === undefined
|
|
221
|
+
? undefined
|
|
222
|
+
: declarationNameText(nameNode, source);
|
|
223
|
+
const qualifiedName = name === undefined ? undefined : [...parents, name].join(".");
|
|
224
|
+
if (qualifiedName !== undefined &&
|
|
225
|
+
(qualifiedName === requestedName ||
|
|
226
|
+
qualifiedName.endsWith(`.${requestedName}`))) {
|
|
227
|
+
const declarations = matches.get(qualifiedName) ?? [];
|
|
228
|
+
declarations.push(node);
|
|
229
|
+
matches.set(qualifiedName, declarations);
|
|
230
|
+
}
|
|
231
|
+
const childParents = name !== undefined && isDeclarationContainer(node)
|
|
232
|
+
? [...parents, name]
|
|
233
|
+
: parents;
|
|
234
|
+
node.forEachChild((child) => visit(child, childParents));
|
|
235
|
+
};
|
|
236
|
+
source.forEachChild((child) => visit(child, []));
|
|
237
|
+
return [...matches].map(([name, nodes]) => ({ name, nodes }));
|
|
238
|
+
}
|
|
239
|
+
function resolveSourceSymbol(project, source, requestedName) {
|
|
240
|
+
const [rootName, ...memberNames] = requestedName.split(".");
|
|
241
|
+
if (rootName === undefined || rootName.length === 0)
|
|
242
|
+
return [];
|
|
243
|
+
let symbol = project.checker.resolveName(rootName, SymbolFlags.Value | SymbolFlags.Type | SymbolFlags.Namespace, { document: source.fileName, position: 0 });
|
|
244
|
+
for (const memberName of memberNames) {
|
|
245
|
+
if (symbol === undefined)
|
|
246
|
+
return [];
|
|
247
|
+
symbol = symbolMember(symbol, memberName);
|
|
248
|
+
}
|
|
249
|
+
if (symbol === undefined)
|
|
250
|
+
return [];
|
|
251
|
+
const nodes = symbol.declarations.flatMap((handle) => {
|
|
252
|
+
const node = handle.resolve();
|
|
253
|
+
if (node === undefined || node.getSourceFile().fileName !== source.fileName)
|
|
254
|
+
return [];
|
|
255
|
+
return [node];
|
|
256
|
+
});
|
|
257
|
+
return nodes.length === 0 ? [] : [{ name: requestedName, nodes }];
|
|
258
|
+
}
|
|
259
|
+
function symbolMember(symbol, name) {
|
|
260
|
+
return ([...symbol.getMembers()].find(([memberName]) => memberName === name)?.[1] ??
|
|
261
|
+
[...symbol.getExports()].find(([exportName]) => exportName === name)?.[1]);
|
|
262
|
+
}
|
|
263
|
+
function declarationName(node) {
|
|
264
|
+
if (!("name" in node))
|
|
265
|
+
return undefined;
|
|
266
|
+
return node.name;
|
|
267
|
+
}
|
|
268
|
+
function declarationNameText(name, source) {
|
|
269
|
+
if ("text" in name) {
|
|
270
|
+
const text = name.text;
|
|
271
|
+
if (typeof text === "string")
|
|
272
|
+
return text;
|
|
273
|
+
}
|
|
274
|
+
return name.getText(source);
|
|
275
|
+
}
|
|
276
|
+
function isSourceDeclaration(node) {
|
|
277
|
+
return (isClassDeclaration(node) ||
|
|
278
|
+
isEnumDeclaration(node) ||
|
|
279
|
+
isEnumMember(node) ||
|
|
280
|
+
isFunctionDeclaration(node) ||
|
|
281
|
+
isGetAccessorDeclaration(node) ||
|
|
282
|
+
isInterfaceDeclaration(node) ||
|
|
283
|
+
isMethodDeclaration(node) ||
|
|
284
|
+
isMethodSignatureDeclaration(node) ||
|
|
285
|
+
isModuleDeclaration(node) ||
|
|
286
|
+
isPropertyDeclaration(node) ||
|
|
287
|
+
isPropertySignatureDeclaration(node) ||
|
|
288
|
+
isSetAccessorDeclaration(node) ||
|
|
289
|
+
isTypeAliasDeclaration(node) ||
|
|
290
|
+
isVariableDeclaration(node));
|
|
291
|
+
}
|
|
292
|
+
function isDeclarationContainer(node) {
|
|
293
|
+
return (isClassDeclaration(node) ||
|
|
294
|
+
isEnumDeclaration(node) ||
|
|
295
|
+
isFunctionDeclaration(node) ||
|
|
296
|
+
isInterfaceDeclaration(node) ||
|
|
297
|
+
isModuleDeclaration(node));
|
|
298
|
+
}
|