Repository navigation
Test the documentation build helpers - #215
Merged
Merged
Conversation
Every suite under tests/site now names what it checks as built, and the two that repeated the README's note on when the site suites run no longer do.
The site suites check the built output as a whole, so a wrong rule in a helper showed up only as a missing file or a broken link. Unit suites now cover how a page maps to its address, how frontmatter is read, how links in a Markdown copy are rewritten, and how the head and breadcrumbs are built. Each suite is named after the module it covers.
The page actions read the documentation's address from urls.js instead of a second copy, and the sidebar test maps links with linkPath, which it already imported.
The comment named a build hook this site does not have. The module header no longer lists who imports it.
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
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.
The site suites checked the build helpers only through the built output. A wrong rule showed up as a broken link or a missing file. This PR adds unit suites for page addresses, frontmatter, Markdown copy links, the head and breadcrumbs. The page actions now read the site address from urls.js. Two comments lose claims that no longer hold.
The built pages do not change. The urls.js import adds a few string helpers to the client bundle. The PR adds no linter or type checker, since the repo has neither.
pnpm build.pnpm exec vitepress preview docs./setup/spam-protection.html.https://documentation.formspark.io/setup/spam-protection.md.