cadl/cspell.yaml

version: "0.2"
language: en
allowCompoundWords: true
dictionaries:
  - node
  - typescript
words:
  - autorest
  - azsdk
  - azsdkengsys
  - azurecr
  - azuresdk
  - blockful
  - blockless
  - cadl
  - cadleditor
  - cadleng
  - cadlplayground
  - clsx
  - cobertura
  - codeql
  - Contoso
  - CORGE
  - createsorreplacesresource
  - createsorupdatesresource
  - CRUDL
  - debouncer
  - devdiv
  - dogfood
  - eastus
  - ecmarkup
  - esbuild
  - ESRP
  - fluentui
  - genproto
  - globby
  - Infima
  - inmemory
  - instanceid
  - interner
  - intrinsics
  - jsyaml
  - keyer
  - lifecyle
  - lzutf
  - mocharc
  - msbuild
  - MSRC
  - multis
  - munge
  - mylib
  - nanos
  - noformat
  - noopener
  - noreferrer
  - nostdlib
  - npmjs
  - oapi
  - OIDC
  - oneds
  - oneof
  - onig
  - onigasm
  - onwarn
  - openapi
  - openapiv
  - picocolors
  - prismjs
  - proto
  - protobuf
  - protoc
  - pwsh
  - regen
  - respecify
  - rpaas
  - rushx
  - safeint
  - segmentof
  - sfixed
  - sint
  - ssvs
  - strs
  - syncpack
  - TRYIT
  - TSES
  - tspd
  - tspwebsitepr
  - tsvs
  - typespecvs
  - Uhoh
  - uitestresults
  - unassignable
  - Uncapitalize
  - uninstantiated
  - unioned
  - unprefixed
  - unprojected
  - unsourced
  - unversioned
  - vsix
  - VSSDK
  - vswhere
  - westus
  - xlarge
  - xplat
ignorePaths:
  - "**/node_modules/**"
  - "**/dist/**"
  - "**/dist-dev/**"
  - "**/.docusaurus/**"
  - "**/CHANGELOG.md"
  - "**/coverage/**"
  - grammars/**
  - packages/website/build/**
  - common/scripts/*
  - "**/ThirdPartyNotices.txt"
  - packages/compiler/test/formatter/scenarios/**
  - pnpm-lock.yaml
  - "**/*.mp4"
  - packages/samples/test/output/**
useGitignore: true
enableFiletypes:
  - cadl
patterns:
  - name: cursortest
    pattern: /(.*)┆(.*)/g
  - name: Authorization_Basic
    description: Ignore Base64 authorization tokens
    pattern: "/Authorization: Basic\\s+\\S+/g"
ignoreRegExpList:
  - cursortest
  - Authorization_Basic
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`version: "0.2"`
			`language: en`
			`allowCompoundWords: true`
			`dictionaries:`
			`- node`
			`- typescript`
			`words:`
			`- autorest`
Publish Visual Studio Extension (#2854) closes #527 2024-01-30 22:17:38 +03:00			`- azsdk`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- azsdkengsys`
			`- azurecr`
Vscode publish (#2838) Extension https://marketplace.visualstudio.com/items?itemName=typespec.typespec-vscode 2024-01-30 01:01:33 +03:00			`- azuresdk`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- blockful`
			`- blockless`
			`- cadl`
Reusability: Use css in JS for playground and export a Playground component (#1146) 2022-10-19 19:55:05 +03:00			`- cadleditor`
Add github action to run formatter for you (#1219) 2022-10-25 01:30:51 +03:00			`- cadleng`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- cadlplayground`
Playground version picker (#2661) fix https://github.com/microsoft/typespec/issues/2044 <img width="456" alt="image" src="https://github.com/microsoft/typespec/assets/1031227/63f2b07f-7eba-4d0f-9bbd-2ef6348efd4c"> 2023-11-17 19:04:18 +03:00			`- clsx`
Use "c8" to merge coverage files (#2432) - Fixes Azure/typespec-azure#3582 2023-09-19 21:38:42 +03:00			`- cobertura`
Use workflow for codeql configuration (#2720) Somehow the default UI configuration doesn't run on pull requests so hopefully this will work. Right now we just get the security warnings after merging which is unfortunate. It is also hard to run codeql locally so having it on a PR to make sure we resolve it is nice We'll get error like that <img width="993" alt="image" src="https://github.com/microsoft/typespec/assets/1031227/e1ff03d0-1f6a-49e5-8b27-b7c03e2b69f2"> 2023-12-05 04:18:34 +03:00			`- codeql`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- Contoso`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- CORGE`
Playground: Emitter config selection and improve UI (#1498) 2023-01-03 19:34:50 +03:00			`- createsorreplacesresource`
			`- createsorupdatesresource`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- CRUDL`
Fix: Linking example from url (#1872) 2023-05-06 02:06:30 +03:00			`- debouncer`
Vscode publish (#2838) Extension https://marketplace.visualstudio.com/items?itemName=typespec.typespec-vscode 2024-01-30 01:01:33 +03:00			`- devdiv`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- dogfood`
			`- eastus`
			`- ecmarkup`
			`- esbuild`
Sign VSCode and Visual Studio extensions & pipeline organization (#2913) Add steps to sign the extensions ## Reorganize pipelines This is a part of the change done here https://github.com/microsoft/typespec/pull/2869 without separating the npm publish into its own publish stage as this wasn't that easy with pure pnpm and the esrp release task isn;t supporting custom tags yet. <img width="539" alt="image" src="https://github.com/microsoft/typespec/assets/1031227/57b3ab2a-846c-4f9a-83fb-f8c8ef17434d"> 2024-02-15 22:24:06 +03:00			`- ESRP`
Playground: Emitter config selection and improve UI (#1498) 2023-01-03 19:34:50 +03:00			`- fluentui`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- genproto`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- globby`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- Infima`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- inmemory`
			`- instanceid`
[gRPC] @typespec/protobuf (#636) * gRPC: initial commit moving from demo to public repo * Added a README * remove copied changelogs * added fresh changelog.json * Some cleanup, removed synthetic models * WIP testing system * Recorded a test * Fixed bug bypassing effective type calculation. * Made 'simple' even simpler. * Added test for inferring message names from context * Supported output message name inference and refactored unreachable types. * Unleaked discriminated union tags. * Updated some documentation. * Capitalize method names, remove space between method name and input type. * Tweaked proto header * Extracted writing reservations into own function * Taught the expectation system to look for diagnostics. * Check for namespace collisions. * Fixed simple-error test * Re-recorded a simple test. * Renamed grpc -> protobuf, improved handling of many protobuf features * Implement cross-package references * Reworked a bunch of docs issues and diagnostics. * Lazy initialize scalars map * Some doc updates * Removed protoc output * Renamed tests to .tsp * Updated diagnostics and some documentation * Updated entrypoint from typespecMain to tspMain * Updated docs * Lint/spell fixes * Updated enum error messages * Improved namespace handling * Reject anonymous models in messages * Removed TODOs * Fixed test harness on windows * addressbook scenario * Several small updates * Ignored .protoc-out integration folder * Updated a few documentation entries * Import from fs rather than import fs * Increased resilience to failed scalar resolutions. * Support derived scalars by traversing the scalar inheritance links. * Add protobuf as website dependency * Just don't support unions for now * Better handling of intrinsic types * Added a note about onValidate * Added a note about syntax target functions * Move a symbol * Add a readme warning. 2023-04-25 19:23:51 +03:00			`- interner`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- intrinsics`
			`- jsyaml`
[gRPC] @typespec/protobuf (#636) * gRPC: initial commit moving from demo to public repo * Added a README * remove copied changelogs * added fresh changelog.json * Some cleanup, removed synthetic models * WIP testing system * Recorded a test * Fixed bug bypassing effective type calculation. * Made 'simple' even simpler. * Added test for inferring message names from context * Supported output message name inference and refactored unreachable types. * Unleaked discriminated union tags. * Updated some documentation. * Capitalize method names, remove space between method name and input type. * Tweaked proto header * Extracted writing reservations into own function * Taught the expectation system to look for diagnostics. * Check for namespace collisions. * Fixed simple-error test * Re-recorded a simple test. * Renamed grpc -> protobuf, improved handling of many protobuf features * Implement cross-package references * Reworked a bunch of docs issues and diagnostics. * Lazy initialize scalars map * Some doc updates * Removed protoc output * Renamed tests to .tsp * Updated diagnostics and some documentation * Updated entrypoint from typespecMain to tspMain * Updated docs * Lint/spell fixes * Updated enum error messages * Improved namespace handling * Reject anonymous models in messages * Removed TODOs * Fixed test harness on windows * addressbook scenario * Several small updates * Ignored .protoc-out integration folder * Updated a few documentation entries * Import from fs rather than import fs * Increased resilience to failed scalar resolutions. * Support derived scalars by traversing the scalar inheritance links. * Add protobuf as website dependency * Just don't support unions for now * Better handling of intrinsic types * Added a note about onValidate * Added a note about syntax target functions * Move a symbol * Add a readme warning. 2023-04-25 19:23:51 +03:00			`- keyer`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- lifecyle`
Reusability: Use css in JS for playground and export a Playground component (#1146) 2022-10-19 19:55:05 +03:00			`- lzutf`
Improve Emitter/Library authoring documentation (#2725) Fixes #2728. --------- Co-authored-by: Timothee Guerin <tiguerin@microsoft.com> 2023-12-15 00:48:27 +03:00			`- mocharc`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- msbuild`
			`- MSRC`
Collection Format updates (#2197) Closes #1711. [Playground](https://cadlplayground.z22.web.core.windows.net/prs/2197/?c=aW1wb3J0ICJAdHlwZXNwZWMvaHR0cCI7DQoNCnVzaW5nIFR5cGVTcGVjLkh0dHDFGG9wIHRlc3QoQHF1ZXJ5KHtuYW1lOiAiJHNlbGVjdCIsIGZvcm1hdDogInRzdiJ9KSDGGXM6IHN0cmluZ1tdKcgLOw%3D%3D&e=%40typespec%2Fopenapi3&options=%7B%7D) 2023-07-27 01:21:45 +03:00			`- multis`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- munge`
			`- mylib`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- nanos`
Website public beta (#2418) This is a feature branch containing the progress for the website URL: https://tspwebsitepr.z22.web.core.windows.net/prs/2418/ 2024-01-19 20:42:25 +03:00			`- noformat`
Fix prismjs string template literal regex (#2719) Those regex were reporting to have some vulnerability for performance, not sure if this fixes it but I think those were errors to start with and this is the way the swift prism definition does with with `\(` instead of `${` --------- Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> 2023-12-05 20:30:13 +03:00			`- noopener`
			`- noreferrer`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- nostdlib`
Publish Visual Studio Extension (#2854) closes #527 2024-01-30 22:17:38 +03:00			`- npmjs`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- oapi`
Add support for openIdConnect auth scheme (#2811) fix [#2774](https://github.com/microsoft/typespec/issues/2774) 2024-02-06 01:38:55 +03:00			`- OIDC`
Integrate 1ds telemetry in website (#2912) 2024-03-08 20:41:55 +03:00			`- oneds`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- oneof`
			`- onig`
			`- onigasm`
			`- onwarn`
			`- openapi`
			`- openapiv`
			`- picocolors`
Docs: multipart default handling (#2667) part of https://github.com/microsoft/typespec/issues/2419 https://tspwebsitepr.z22.web.core.windows.net/prs/2667/next/standard-library/http/multipart.html --------- Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> 2023-11-21 22:37:05 +03:00			`- prismjs`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- proto`
			`- protobuf`
			`- protoc`
Publish Visual Studio Extension (#2854) closes #527 2024-01-30 22:17:38 +03:00			`- pwsh`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- regen`
Update http authentication docs with new operation level auth and scopes (#2960) PR added support for it but we need to update the docs to explain the new feature. --------- Co-authored-by: Brian Terlson <brian.terlson@microsoft.com> 2024-02-28 22:40:28 +03:00			`- respecify`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- rpaas`
			`- rushx`
			`- safeint`
Playground: Emitter config selection and improve UI (#1498) 2023-01-03 19:34:50 +03:00			`- segmentof`
[gRPC] @typespec/protobuf (#636) * gRPC: initial commit moving from demo to public repo * Added a README * remove copied changelogs * added fresh changelog.json * Some cleanup, removed synthetic models * WIP testing system * Recorded a test * Fixed bug bypassing effective type calculation. * Made 'simple' even simpler. * Added test for inferring message names from context * Supported output message name inference and refactored unreachable types. * Unleaked discriminated union tags. * Updated some documentation. * Capitalize method names, remove space between method name and input type. * Tweaked proto header * Extracted writing reservations into own function * Taught the expectation system to look for diagnostics. * Check for namespace collisions. * Fixed simple-error test * Re-recorded a simple test. * Renamed grpc -> protobuf, improved handling of many protobuf features * Implement cross-package references * Reworked a bunch of docs issues and diagnostics. * Lazy initialize scalars map * Some doc updates * Removed protoc output * Renamed tests to .tsp * Updated diagnostics and some documentation * Updated entrypoint from typespecMain to tspMain * Updated docs * Lint/spell fixes * Updated enum error messages * Improved namespace handling * Reject anonymous models in messages * Removed TODOs * Fixed test harness on windows * addressbook scenario * Several small updates * Ignored .protoc-out integration folder * Updated a few documentation entries * Import from fs rather than import fs * Increased resilience to failed scalar resolutions. * Support derived scalars by traversing the scalar inheritance links. * Add protobuf as website dependency * Just don't support unions for now * Better handling of intrinsic types * Added a note about onValidate * Added a note about syntax target functions * Move a symbol * Add a readme warning. 2023-04-25 19:23:51 +03:00			`- sfixed`
Enforce fixes for missing docs (#1860) * Add doc errors for decorators and decorator parameters. * Add decorator documentation rules. * Code review feedback. * Update logic. * Compiler docs fixes. * Doc updates. * Fix protobuf issues. * Code review feedback. * Test that build fails... * Add support for scalars. * I hate EVERYTHING about you, cSpell.... * Code review feedback. 2023-04-28 19:32:54 +03:00			`- sint`
Collection Format updates (#2197) Closes #1711. [Playground](https://cadlplayground.z22.web.core.windows.net/prs/2197/?c=aW1wb3J0ICJAdHlwZXNwZWMvaHR0cCI7DQoNCnVzaW5nIFR5cGVTcGVjLkh0dHDFGG9wIHRlc3QoQHF1ZXJ5KHtuYW1lOiAiJHNlbGVjdCIsIGZvcm1hdDogInRzdiJ9KSDGGXM6IHN0cmluZ1tdKcgLOw%3D%3D&e=%40typespec%2Fopenapi3&options=%7B%7D) 2023-07-27 01:21:45 +03:00			`- ssvs`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- strs`
Vscode publish (#2838) Extension https://marketplace.visualstudio.com/items?itemName=typespec.typespec-vscode 2024-01-30 01:01:33 +03:00			`- syncpack`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- TRYIT`
			`- TSES`
Rename `ref-doc` package to `tspd` and provide a cli that can be used by each package (#2225) Progress towards providing the ref doc generation as a usable tool by any typespec library. Detach the generation from the website, instead each package define where they want their doc and we generate it. This adds a new `tspd` package and CLI tool that is meant to be used by library authors. It will have the following functionalities - generate docs - generate TS signatures - lint library? --------- Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> 2023-08-02 01:34:18 +03:00			`- tspd`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- tspwebsitepr`
Collection Format updates (#2197) Closes #1711. [Playground](https://cadlplayground.z22.web.core.windows.net/prs/2197/?c=aW1wb3J0ICJAdHlwZXNwZWMvaHR0cCI7DQoNCnVzaW5nIFR5cGVTcGVjLkh0dHDFGG9wIHRlc3QoQHF1ZXJ5KHtuYW1lOiAiJHNlbGVjdCIsIGZvcm1hdDogInRzdiJ9KSDGGXM6IHN0cmluZ1tdKcgLOw%3D%3D&e=%40typespec%2Fopenapi3&options=%7B%7D) 2023-07-27 01:21:45 +03:00			`- tsvs`
Publish Visual Studio Extension (#2854) closes #527 2024-01-30 22:17:38 +03:00			`- typespecvs`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- Uhoh`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- uitestresults`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- unassignable`
			`- Uncapitalize`
			`- uninstantiated`
			`- unioned`
Fix: Linking example from url (#1872) 2023-05-06 02:06:30 +03:00			`- unprefixed`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- unprojected`
			`- unsourced`
			`- unversioned`
			`- vsix`
Publish Visual Studio Extension (#2854) closes #527 2024-01-30 22:17:38 +03:00			`- VSSDK`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- vswhere`
			`- westus`
Website public beta (#2418) This is a feature branch containing the progress for the website URL: https://tspwebsitepr.z22.web.core.windows.net/prs/2418/ 2024-01-19 20:42:25 +03:00			`- xlarge`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- xplat`
			`ignorePaths:`
			`- "/node_modules/"`
			`- "/dist/"`
			`- "/dist-dev/"`
Migrate website to use docusaurus (#1266) 2022-11-14 23:44:38 +03:00			`- "/.docusaurus/"`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`- "**/CHANGELOG.md"`
Migrate test framework to vitest (#2769) Get rid of mocha and upgrade to vitest which is a more modern alternative providing, watch, direct typescript compilation out of the box, expect library and more. Advantage over mocha: - Much better cli - watch mode - better diff - Better extension: - tree organization for files too (not everything flattened) - update in real time the test(no more need to refresh manually to discover where are the tests) - just a little buggy - Compiles typescript directly - provides more expectation apis(like jest) Cons over mocha: - Slower(about 2x) but that means we don't need to build the test as part of build which would speed up that part(not as much as is lost) Todo: - typespec-azure migration 2024-01-02 22:40:29 +03:00			`- "/coverage/"`
Sign VSCode and Visual Studio extensions & pipeline organization (#2913) Add steps to sign the extensions ## Reorganize pipelines This is a part of the change done here https://github.com/microsoft/typespec/pull/2869 without separating the npm publish into its own publish stage as this wasn't that easy with pure pnpm and the esrp release task isn;t supporting custom tags yet. <img width="539" alt="image" src="https://github.com/microsoft/typespec/assets/1031227/57b3ab2a-846c-4f9a-83fb-f8c8ef17434d"> 2024-02-15 22:24:06 +03:00			`- grammars/**`
Playground: Emitter config selection and improve UI (#1498) 2023-01-03 19:34:50 +03:00			`- packages/website/build/**`
Reusability: Use css in JS for playground and export a Playground component (#1146) 2022-10-19 19:55:05 +03:00			`- common/scripts/*`
Enable spell check for all files and fix (#2881) fix #2776 2024-02-09 03:54:23 +03:00			`- "**/ThirdPartyNotices.txt"`
			`- packages/compiler/test/formatter/scenarios/**`
			`- pnpm-lock.yaml`
			`- "*/.mp4"`
			`- packages/samples/test/output/**`
			`useGitignore: true`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`enableFiletypes:`
			`- cadl`
			`patterns:`
			`- name: cursortest`
			`pattern: /(.)┆(.)/g`
chore: Adjust CSpell pattern to ignore auth tokens (#1044) 2022-09-15 19:45:28 +03:00			`- name: Authorization_Basic`
			`description: Ignore Base64 authorization tokens`
Reusability: Use css in JS for playground and export a Playground component (#1146) 2022-10-19 19:55:05 +03:00			`pattern: "/Authorization: Basic\\s+\\S+/g"`
Setup spell check and fix issues in markdown, ts and changelogs (#1000) 2022-09-09 22:54:18 +03:00			`ignoreRegExpList:`
			`- cursortest`
chore: Adjust CSpell pattern to ignore auth tokens (#1044) 2022-09-15 19:45:28 +03:00			`- Authorization_Basic`