Code reference detail
phonebook.ts
scripts/phonebook.ts
| Idea | Status | Tags | Summary |
|---|---|---|---|
| extension_readme_build | Generate `packages/extension/README.md` from [extension_readme_script] and README. template. md before VSIX packaging. Marketplace links are resolved from ["../../scripts/phonebook.ts"]; changelog body comes from packages / extension / CHANGELOG. md ( Changesets output ). Invoked as `pnpm run build:readme` at the start of [extension_build_script]. Requirement: ["../distribution/distribution.rq".extension_readme]. | ||
| scope | extension build steps for local development and CI | ||
| extension_readme | The VSIX package must include a README for the Marketplace and Open VSX listings. Contact and repository links come from [phonebook_reqs.phonebook] via ["../../scripts/phonebook.ts"] per [phonebook_reqs.extension_readme_links]. Release notes are appended from ["../../packages/extension/CHANGELOG.md"], which Changesets maintains per [version_management]. Generated during extension build from ["../../packages/extension/README.template.md"] by ["../../packages/extension/scripts/generate-readme.ts"] per ["../development/build.rq".extension_readme_build]. | ||
| npm_package_readme | Publishable npm packages ( `@reqlan/language`, `@reqlan/analytical`, `@reqlan/cli` ) ship README. md generated from each package's `README.template.md`. Pattern matches [extension_readme]: centered logo, package name, description, features, phonebook links, and Changesets changelog body. Generated by ["../../scripts/generate-npm-package-readmes.ts"] via root `pnpm run build:readme`. Contact and repository links come from [phonebook_reqs.phonebook] via ["../../scripts/phonebook.ts"] per [phonebook_reqs.npm_package_readme_links]. | ||
| root_readme | The GitHub repository README is the primary repo lander per ["./landers.rq".landers]. Site, marketplace, repository, and contact links come from [phonebook_reqs.phonebook] via ["../../scripts/phonebook.ts"] per [phonebook_reqs.root_readme_links]. Generated from ["../../README.template.md"] by ["../../scripts/generate-root-readme.ts"]. | ||
| stopgap | Stopgap distribution is at https: / / marketplace. visualstudio. com / manage / publishers / reqlan | ||
| landers | The reqlan extension has the following entry points: - the vsc marketplace and open vsx marketplace via the ["../../packages/extension/README.template.md"] - npm packages via ["../../packages/language/README.template.md"], ["../../packages/analytical/README.template.md"], and ["../../packages/cli/README.template.md"] - the site. - the github repository via the ["../../README.template.md"] - landers must keep cross references up to date via the ["../../scripts/phonebook.ts"] [phonebook] | ||
| npm_packages | Publishable npm packages ( `@reqlan/language`, `@reqlan/analytical`, `@reqlan/cli` ) live under the `packages` key in ["./phonebook.json"]. Package ids are `language`, `analytical`, and `cli`. The site Links section renders them under Packages per ["../site/reqs/core.rq".links] / ["../site/reqs/icons.rq".package_icons]. Typed helpers: `phonebookPackages`, `getPhonebookPackage` in ["../scripts/phonebook.ts"]. | ||
| phonebook | Canonical project links and publishable npm package URLs live in ["./phonebook.json"]. Modules that need contact, repo, marketplace, or npm package URLs should read from there instead of hardcoding values. Typed access is shared via ["../scripts/phonebook.ts"] for the site and extension README generator. | ||
| phonebook_icon_keys | per [phonebook_reqs.phonebook_icons] Each phonebook link or package carries an `icon` object with `set` and `name`. Set ids and lookup URLs are canonical in ["../../reqlan rq/phonebook.json"]. icons. Use each set's `search` URL to find replacement slugs when a name changes or an icon is removed upstream. Typed helpers live in [phonebook_script]: `formatPhonebookIconKey`, `getPhonebookIconSearchUrl`. | ||
| scope | site icon rendering for phonebook links and CTAs |
Reference labels
../../scripts/phonebook.ts, ../scripts/phonebook.ts, phonebook_script