refactor(api-markdown-documenter): Unify "file-safe-name" helper utilities #23394
Conversation
This file contains 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
github-actions
bot
added
public api change
There was a problem hiding this comment.
Copilot reviewed 5 out of 9 changed files in this pull request and generated no comments.
Files not reviewed (4)
- tools/api-markdown-documenter/src/api-item-transforms/ApiItemTransformUtilities.ts: Evaluated as low risk
- tools/api-markdown-documenter/src/ApiItemUtilitiesModule.ts: Evaluated as low risk
- tools/api-markdown-documenter/src/api-item-transforms/helpers/Helpers.ts: Evaluated as low risk
- tools/api-markdown-documenter/src/api-item-transforms/configuration/DocumentationSuite.ts: Evaluated as low risk
Josmithr
commented
Dec 20, 2024
| * Accounts for method overloads by adding a suffix such as "myMethod_2". | ||
| * Converts invalid filename characters to underscores. | ||
| */ | ||
| function getFileSafeNameForName(apiItemName: string): string { |
There was a problem hiding this comment.
Code that was previously using this helper directly were (incorrectly) not getting the qualified naming for cases like overloads.
alexvy86
approved these changes
Dec 20, 2024
tools/api-markdown-documenter/src/utilities/ApiItemUtilities.ts
Outdated
Show resolved
Hide resolved
tools/api-markdown-documenter/src/utilities/ApiItemUtilities.ts
Outdated
Show resolved
Hide resolved
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Josmithr
deleted the
api-markdown-documenter/qualified-name-helper-cleanup
branch
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.
Refactors a small collection of utility functions aimed at generating consistent, unique, and file-name-safe identifiers for API items (used for naming files, heading IDs, etc.). Unifies all of the exported functions aimed at providing this functionality into a single one, which also now captures package-name policy (previously duplicated in a few places).
Breaking change: publicly exposed function is now called
getFileSafeNameForApiItem