Code reference detail
phonebook.ts
scripts/phonebook.ts
| Idea | Status | Tags | Summary | Katz |
|---|---|---|---|---|
| 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]. | 0.048 | ||
| scope | extension build steps for local development and CI | 0.040 | ||
| phonebook_icon_keys | done | per [phonebook_reqs.phonebook_icons] A phonebook link or package can omit `icon`. If `icon` is present, it is an object with `set` and `name`. Set ids and lookup URLs are canonical in ["../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`. | 0.048 | |
| extension_readme | The VSIX package must include a README for the Marketplace and Open VSX listings. Contact, Discord, sponsorship, 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]. | 0.059 | ||
| npm_package_readme | done | Publishable npm packages ( `@reqlan/language`, `@reqlan/analytical`, `@reqlan/cli`, `@reqlan/mcp` ) 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, Discord, sponsorship, and repository links come from [phonebook_reqs.phonebook] via ["../../scripts/phonebook.ts"] per [phonebook_reqs.npm_package_readme_links]. CLI native-engine install note: ["./native_host_binary.rq".published_host_native_install]. | 0.046 | |
| root_readme | The GitHub repository README is the primary repo lander per ["./landers.rq".landers]. Site, marketplace, repository, Discord, sponsorship, 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"]. | 0.046 | ||
| stopgap | Stopgap distribution is at https://marketplace.visualstudio.com/manage/publishers/reqlan | 0.040 | ||
| 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"], ["../../packages/cli/README.template.md"], and ["../../packages/mcp/README.template.md"] - the site. - the github repository via the ["../../README.template.md"] - the GitHub sponsor button via [github_funding] - landers must keep cross references up to date via the ["../../scripts/phonebook.ts"] [phonebook] | 0.046 | ||
| npm_packages | Publishable npm packages ( `@reqlan/language`, `@reqlan/analytical`, `@reqlan/cli`, `@reqlan/mcp` ) live under the `packages` key in ["./phonebook.json"]. Package ids are `language`, `analytical`, `cli`, and `mcp`. The site Links section renders them under Packages per ["./site/site.rq".links] / ["./site/site.rq".package_icons]. Typed helpers: `phonebookPackages`, `getPhonebookPackage` in ["../scripts/phonebook.ts"]. | 0.095 | ||
| phonebook | Canonical project links and publishable npm package URLs live in ["./phonebook.json"]. Modules that need contact, repo, marketplace, Discord, sponsorship, 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. | 0.176 | ||
| show_in_footer | done | Each entry under `links` in ["./phonebook.json"] may set `show-in-footer`. The property is optional. Omitted means true. Set `show-in-footer` to false to keep a link out of the site footer and the landing contact list. Packages do not have this property. Schema: ["./phonebook.schema.json"]. Typed helpers: `isShownInFooter`, `phonebookFooterLinks` in ["../scripts/phonebook.ts"] and ["../site/src/lib/phonebook.ts"]. per ["./site/site.rq".footer] per ["./site/site.rq".links] | 0.072 |
Reference labels
"../../scripts/phonebook.ts", "../scripts/phonebook.ts", ../../scripts/phonebook.ts, ../scripts/phonebook.ts