Skip to content
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
merged 69 commits into from
Aug 16, 2024
Merged
Changes from 1 commit
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 Aug 5, 2024
e6c54c6
test: Update test suite with invalid `@inheritDoc` tag example
Josmithr Aug 6, 2024
8ea4657
test: Add loadModel unit tests
Josmithr Aug 6, 2024
41fbade
refactor: Add noopLogger
Josmithr Aug 6, 2024
b794944
fix: API report file name
Josmithr Aug 6, 2024
331131c
test: Fix incorrect test
Josmithr Aug 6, 2024
6f0a8c2
refactor: Move reference resolution utilities
Josmithr Aug 6, 2024
f3d1256
improvement: Quote item name in error
Josmithr Aug 6, 2024
599ad7d
feat: Add initial linter logic
Josmithr Aug 6, 2024
6a8aabd
refactor: Update `loadModel` to take an options object
Josmithr Aug 6, 2024
dd64318
test: Add `loadModel` unit tests
Josmithr Aug 6, 2024
32d9b3f
test: Fix API report name
Josmithr Aug 6, 2024
3d39059
refactor: Update tests to use `loadModel`
Josmithr Aug 6, 2024
c139bd0
test: Fix test
Josmithr Aug 6, 2024
563b38a
test: Add "empty model" test
Josmithr Aug 6, 2024
9fa3d16
test: Simplify test logic
Josmithr Aug 6, 2024
10a3175
docs: Update tense
Josmithr Aug 6, 2024
960c6e1
refactor: Make `modelDirectoryPath` readonly
Josmithr Aug 6, 2024
02d2621
Merge branch 'api-markdown-documenter/load-model-cleanup' of https://…
Josmithr Aug 6, 2024
8a69234
Merge branch 'api-markdown-documenter/load-model-cleanup' into api-ma…
Josmithr Aug 6, 2024
7fb940a
docs: `@throws` comment
Josmithr Aug 6, 2024
7cc7897
test: Add invalid model tests for the linter.
Josmithr Aug 6, 2024
6a77728
docs: `@throws` comments
Josmithr Aug 6, 2024
eacd6ab
docs: Formatting
Josmithr Aug 6, 2024
c14592e
improvement: Quote type in error
Josmithr Aug 6, 2024
e038e38
docs: Fix typo
Josmithr Aug 6, 2024
e233357
[WIP] Add base TSDoc node transformation infra
Josmithr Aug 6, 2024
7fcfc5d
style: Formatting
Josmithr Aug 6, 2024
ca6c8dc
tools: Add fence
Josmithr Aug 6, 2024
b054333
feat: Implement `@link` validation
Josmithr Aug 7, 2024
40dbb3b
docs: TODOs
Josmithr Aug 7, 2024
e83694f
docs: TODO
Josmithr Aug 7, 2024
cdf9fcb
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr Aug 7, 2024
ef85188
docs: Remove duplicated changelog entry
Josmithr Aug 7, 2024
91d96f0
refactor: Rename modules
Josmithr Aug 7, 2024
fa4dc4a
test: Update test name
Josmithr Aug 7, 2024
90e2e23
remove: No-op function (will be added in a future PR)
Josmithr Aug 7, 2024
82bd1b2
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr Aug 7, 2024
457a2aa
Merge branch 'api-markdown-documenter/inheritdoc-linting' into api-ma…
Josmithr Aug 7, 2024
a349263
docs: Expand `@throws` documentation
Josmithr Aug 9, 2024
46748f8
docs: Add documentation
Josmithr Aug 9, 2024
9dce26f
refactor: Update API to return error objects rather than throwing.
Josmithr Aug 9, 2024
af4498a
docs: Expand comment
Josmithr Aug 9, 2024
f92a668
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr Aug 14, 2024
501a9c5
Merge branch 'api-markdown-documenter/inheritdoc-linting' into api-ma…
Josmithr Aug 14, 2024
09a7085
refactor: Update linting pattern
Josmithr Aug 14, 2024
d220998
Merge branch 'main' into api-markdown-documenter/inheritdoc-linting
Josmithr Aug 14, 2024
60bfdae
Merge branch 'api-markdown-documenter/inheritdoc-linting' of https://…
Josmithr Aug 14, 2024
4d212f8
refactor: Take API model directly
Josmithr Aug 14, 2024
5597973
refactor: Less nesting
Josmithr Aug 14, 2024
705e546
revert: Version change
Josmithr Aug 14, 2024
291eac7
refactor: Rename param
Josmithr Aug 15, 2024
8a40181
Merge branch 'api-markdown-documenter/inheritdoc-linting' of https://…
Josmithr Aug 15, 2024
4be377c
Merge branch 'api-markdown-documenter/inheritdoc-linting' into api-ma…
Josmithr Aug 15, 2024
3617054
fix: Imports
Josmithr Aug 15, 2024
22e3ca0
test: Simplify test pattern
Josmithr Aug 15, 2024
227d1a8
docs: Fix comment
Josmithr Aug 15, 2024
40d519a
Squashed commit of the following:
Josmithr Aug 15, 2024
5f3b3ba
test: Empty model test case
Josmithr Aug 15, 2024
177b663
Merge branch 'main' into api-markdown-documenter/link-linter
Josmithr Aug 15, 2024
4ee483c
remove: Malformed tag errors (will add in a separate PR)
Josmithr Aug 15, 2024
91ad3d6
remove: TSDoc transformation domain
Josmithr Aug 15, 2024
e38a1e8
docs: Update comment
Josmithr Aug 15, 2024
b51f088
remove: Duplicated test
Josmithr Aug 15, 2024
d7b6f02
docs: Restore comment
Josmithr Aug 15, 2024
a2023dd
improvement: Remove unneeded assert
Josmithr Aug 16, 2024
4dacb5f
Merge branch 'main' into api-markdown-documenter/link-linter
Josmithr Aug 16, 2024
debedd0
remove: Error param
Josmithr Aug 16, 2024
6b2f9f7
docs: Add docs :)
Josmithr Aug 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
improvement: Quote type in error
  • Loading branch information
Josmithr committed Aug 6, 2024
commit c14592e15f750f03a1030623d9a8ee84fe98628a
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export function documentationNodeToHtml(
): HastNodes {
if (context.transformations[node.type] === undefined) {
throw new Error(
`Encountered a DocumentationNode with neither a user-provided nor system-default renderer. Type: ${node.type}. Please provide a transformation for this type.`,
`Encountered a DocumentationNode with neither a user-provided nor system-default renderer. Type: "${node.type}". Please provide a transformation for this type.`,
);
}
return context.transformations[node.type](node, context);
Expand Down