-
Notifications
You must be signed in to change notification settings - Fork 532
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(api-markdown-documenter): Add {@link}
tag reference validation to linter
#22224
Merged
Josmithr
merged 69 commits into
microsoft:main
from
Josmithr:api-markdown-documenter/link-linter
Aug 16, 2024
Merged
Changes from 64 commits
Commits
Show all changes
69 commits
Select commit
Hold shift + click to select a range
5efe339
improvement: Add options type for `loadModel` and fix logger pattern
Josmithr e6c54c6
test: Update test suite with invalid `@inheritDoc` tag example
Josmithr 8ea4657
test: Add loadModel unit tests
Josmithr 41fbade
refactor: Add noopLogger
Josmithr b794944
fix: API report file name
Josmithr 331131c
test: Fix incorrect test
Josmithr 6f0a8c2
refactor: Move reference resolution utilities
Josmithr f3d1256
improvement: Quote item name in error
Josmithr 599ad7d
feat: Add initial linter logic
Josmithr 6a8aabd
refactor: Update `loadModel` to take an options object
Josmithr dd64318
test: Add `loadModel` unit tests
Josmithr 32d9b3f
test: Fix API report name
Josmithr 3d39059
refactor: Update tests to use `loadModel`
Josmithr c139bd0
test: Fix test
Josmithr 563b38a
test: Add "empty model" test
Josmithr 9fa3d16
test: Simplify test logic
Josmithr 10a3175
docs: Update tense
Josmithr 960c6e1
refactor: Make `modelDirectoryPath` readonly
Josmithr 02d2621
Merge branch 'api-markdown-documenter/load-model-cleanup' of https://…
Josmithr 8a69234
Merge branch 'api-markdown-documenter/load-model-cleanup' into api-ma…
Josmithr 7fb940a
docs: `@throws` comment
Josmithr 7cc7897
test: Add invalid model tests for the linter.
Josmithr 6a77728
docs: `@throws` comments
Josmithr eacd6ab
docs: Formatting
Josmithr c14592e
improvement: Quote type in error
Josmithr e038e38
docs: Fix typo
Josmithr e233357
[WIP] Add base TSDoc node transformation infra
Josmithr 7fcfc5d
style: Formatting
Josmithr ca6c8dc
tools: Add fence
Josmithr b054333
feat: Implement `@link` validation
Josmithr 40dbb3b
docs: TODOs
Josmithr e83694f
docs: TODO
Josmithr cdf9fcb
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr ef85188
docs: Remove duplicated changelog entry
Josmithr 91d96f0
refactor: Rename modules
Josmithr fa4dc4a
test: Update test name
Josmithr 90e2e23
remove: No-op function (will be added in a future PR)
Josmithr 82bd1b2
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr 457a2aa
Merge branch 'api-markdown-documenter/inheritdoc-linting' into api-ma…
Josmithr a349263
docs: Expand `@throws` documentation
Josmithr 46748f8
docs: Add documentation
Josmithr 9dce26f
refactor: Update API to return error objects rather than throwing.
Josmithr af4498a
docs: Expand comment
Josmithr f92a668
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr 501a9c5
Merge branch 'api-markdown-documenter/inheritdoc-linting' into api-ma…
Josmithr 09a7085
refactor: Update linting pattern
Josmithr d220998
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr 60bfdae
Merge branch 'api-markdown-documenter/inheritdoc-linting' of https://…
Josmithr 4d212f8
refactor: Take API model directly
Josmithr 5597973
refactor: Less nesting
Josmithr 705e546
revert: Version change
Josmithr 291eac7
refactor: Rename param
Josmithr 8a40181
Merge branch 'api-markdown-documenter/inheritdoc-linting' of https://…
Josmithr 4be377c
Merge branch 'api-markdown-documenter/inheritdoc-linting' into api-ma…
Josmithr 3617054
fix: Imports
Josmithr 22e3ca0
test: Simplify test pattern
Josmithr 227d1a8
docs: Fix comment
Josmithr 40d519a
Squashed commit of the following:
Josmithr 5f3b3ba
test: Empty model test case
Josmithr 177b663
Merge branch 'main' into api-markdown-documenter/link-linter
Josmithr 4ee483c
remove: Malformed tag errors (will add in a separate PR)
Josmithr 91ad3d6
remove: TSDoc transformation domain
Josmithr e38a1e8
docs: Update comment
Josmithr b51f088
remove: Duplicated test
Josmithr d7b6f02
docs: Restore comment
Josmithr a2023dd
improvement: Remove unneeded assert
Josmithr 4dacb5f
Merge branch 'main' into api-markdown-documenter/link-linter
Josmithr debedd0
remove: Error param
Josmithr 6b2f9f7
docs: Add docs :)
Josmithr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Future PR