[GuideLines] update typescript docs #8985
Open
Conversation
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
to refersh some of the out-dated information
There was a problem hiding this comment.
Pull Request Overview
Refresh outdated TypeScript documentation by updating package configuration, pipeline/tracing guidance, and testing recommendations.
- Switch HTTP pipeline and tracing to use
@azure/core-rest-pipelineandcore-tracinghelpers - Replace Mocha/Karma with Vitest and introduce new
tshypackage layout config - Revise package.json keys (
main,module,browser,types,engine) and npm scope guidance
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/typescript/implementation.md | Updated pipeline & policy requirements, tracing guidance, test tooling, package layout and package.json fields |
| docs/typescript/design.md | Adjusted npm scope recommendations, API surface comments, tsconfig examples, and core package references |
Comments suppressed due to low confidence (2)
docs/typescript/implementation.md:394
- There's an extra comma after the
devDependenciesblock (},,) which is invalid JSON syntax. Remove the extra comma.
"devDependencies": { /* ... */ },,
docs/typescript/implementation.md:326
- [nitpick] The package layout example still shows the old
distanddist-esmdirectories; update this diagram to reflect the newdist/commonjs,dist/esm, anddist/browserstructure.
azure-library
Co-authored-by: Copilot <[email protected]>
deyaaeldeen
reviewed
Jul 2, 2025
docs/typescript/design.md
Outdated
| {% include requirement/MUST id="ts-namespace-serviceclient" %} pick a package name that allows the consumer to tie the namespace to the service being used. As a default, use the compressed service name at the end of the namespace. The namespace does **NOT** change when the branding of the product changes. Avoid the use of marketing names that may change. | ||
|
|
||
| {% include requirement/MUST id="ts-npm-dist-tag-beta" %} tag beta packages with the npm distribution tag `next`. If there is no generally available release of this package, it should also be tagged `latest`. | ||
| {% include requirement/MUST id="ts-npm-dist-tag-beta" %} tag beta packages with the npm distribution tag `next`. |
There was a problem hiding this comment.
I think we dropped using next, see #8884
There was a problem hiding this comment.
you are right, we now only use latest and beta
deyaaeldeen
reviewed
Jul 2, 2025
docs/typescript/implementation.md
Outdated
| │ │ ├── index.js.map | ||
| │ │ ├── ...*.js | ||
| │ │ └── ...*.js.map | ||
| | | |
There was a problem hiding this comment.
react-native was mentioned earlier so I think it should be included here.
There was a problem hiding this comment.
I didn't want to list all so used .... Will add it
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
to refersh some of the out-dated information