gen-tm: color JSDoc @template [Name=Default] type-parameter (#994)
#29
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: README ledger | |
| # Auto-refreshes the cross-language bug ledger in README.md (between the | |
| # <!-- issues:start --> / <!-- issues:end --> markers) and commits it back to master. | |
| # | |
| # The ledger grades Monogram's DERIVED grammars against each hand-written OFFICIAL one on | |
| # real reported bugs (test/issue-table.ts → `npm run bench:issues`). It covers FOUR languages, | |
| # so every official grammar must be present or the run refuses to write (issue-table.ts aborts | |
| # on a partial table rather than clobbering committed sections): | |
| # - TS / TSX / HTML / CSS / JS — VS Code's bundled grammars, FETCHED at a pinned tag below. | |
| # - Vue — vuejs/language-tools' three grammars, VENDORED at test/fixtures/vue-official/ | |
| # (the shipped Vue grammar has no clean raw-fetch URL; the harness embeds Monogram's own | |
| # HTML/TS so no VS Code install is needed for the Vue head-to-head). | |
| # | |
| # Determinism: same inputs (pinned official grammars + in-repo derived grammars + in-repo | |
| # issue-case data) → same block. The parser-conformance corpus (heavy, version-sensitive) is | |
| # deliberately out; that axis lives in a hand-written note next to the block. | |
| # | |
| # No infinite loop: the bot commit touches only README.md, which is NOT in the paths filter | |
| # below, so it can't re-trigger this workflow ([skip ci] is a backstop). | |
| on: | |
| push: | |
| branches: [master] | |
| paths: | |
| # Derived grammars graded by the ledger. | |
| - 'typescript.tmLanguage.json' | |
| - 'typescriptreact.tmLanguage.json' | |
| - 'html.tmLanguage.json' | |
| - 'html-derivative.tmLanguage.json' | |
| - 'javascript.tmLanguage.json' | |
| - 'vue.tmLanguage.json' | |
| - 'vue.directives.tmLanguage.json' | |
| - 'vue.interpolations.tmLanguage.json' | |
| # The grader + per-language issue-case data + the Vue harness. | |
| - 'test/issue-table.ts' | |
| - 'test/issue-cases.ts' | |
| - 'test/tsx-issue-cases.ts' | |
| - 'test/html-issue-cases.ts' | |
| - 'test/vue-issue-cases.ts' | |
| - 'test/vue-grammar-harness.ts' | |
| - 'test/fixtures/vue-official/**' | |
| - '.github/workflows/readme-bench.yml' | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| concurrency: | |
| group: readme-ledger-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| # Pinned VS Code tag whose bundled grammars are the "official" baseline for TS/TSX/HTML/CSS/JS. | |
| # Bump deliberately to re-baseline against newer official grammars. | |
| OFFICIAL_TM_TAG: '1.96.0' | |
| jobs: | |
| update-readme: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Node 24+ runs the .ts sources directly (native type stripping) — no build, no tsx. | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 24 | |
| - run: npm ci | |
| - name: Fetch pinned official VS Code grammars (TS / TSX / HTML / CSS / JS) | |
| run: | | |
| base="https://raw.githubusercontent.com/microsoft/vscode/${OFFICIAL_TM_TAG}/extensions" | |
| curl -fsSL "$base/typescript-basics/syntaxes/TypeScript.tmLanguage.json" -o "${RUNNER_TEMP}/official-ts.json" | |
| curl -fsSL "$base/typescript-basics/syntaxes/TypeScriptReact.tmLanguage.json" -o "${RUNNER_TEMP}/official-tsx.json" | |
| curl -fsSL "$base/html/syntaxes/html.tmLanguage.json" -o "${RUNNER_TEMP}/official-html.json" | |
| curl -fsSL "$base/css/syntaxes/css.tmLanguage.json" -o "${RUNNER_TEMP}/official-css.json" | |
| curl -fsSL "$base/javascript/syntaxes/JavaScript.tmLanguage.json" -o "${RUNNER_TEMP}/official-js.json" | |
| - name: Regenerate the README ledger (all four languages) | |
| env: | |
| MONOGRAM_OFFICIAL_TM: ${{ runner.temp }}/official-ts.json | |
| MONOGRAM_OFFICIAL_TSX: ${{ runner.temp }}/official-tsx.json | |
| MONOGRAM_OFFICIAL_HTML: ${{ runner.temp }}/official-html.json | |
| MONOGRAM_OFFICIAL_CSS: ${{ runner.temp }}/official-css.json | |
| MONOGRAM_OFFICIAL_JS: ${{ runner.temp }}/official-js.json | |
| run: npm run bench:issues | |
| - name: Commit the refreshed ledger (if it changed) | |
| run: | | |
| if git diff --quiet -- README.md; then | |
| echo "README ledger already current — nothing to commit." | |
| exit 0 | |
| fi | |
| git config user.name "github-actions[bot]" | |
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git add README.md | |
| git commit -m "chore: refresh README cross-language bug ledger [skip ci]" | |
| git push |