TypeScript Rollout Tier 5 - Navbar #347
Merged
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
Rewrites the navbar components in the `src/components/navbar` folder in TypeScript. In `NavbarItem.vue`, - Introduces a new type `NavbarItemParent` which represents a super type of `Navbar`. I decided not to import `Navbar.vue` in this file to avoid a potential circular dependency. - In the `closeMenuRecursive` method, temporarily stores `current.$parent` in a local variable `parent` so that repeated assertions are unnecessary In `Navbar.vue`, makes the types of the following props specific: - `type` → `VueClassAttribute` defined in `src/utils/config.ts` - `wrapperClass` → `StyleValue` provided by `vue` Replaces JSDoc-style comments with ordinary comments so that `@microsoft/api-extractor` won't pick them up for documentation.
Rewrites the specs for the navbar components in the `src/components/navbar` in TypeScript. In `NavBarItem.spec.js→ts`, mocks the `closeMenu` method of the `stubNavBar` component instead of that of `wrapper.vm.$parent` to avoid nasty type casting. Applies the `vitest` package: - Imports the spec building blocks from the `vitest` package - Replaces `jest` with `vi` provided by the `vitest` package In the `__snapshots__` subfolder, replaces the spec snapshots produced by Jest with those by Vitest: - `NavBar.spec.js.snap` → `NavBar.spec.ts.snap` - `NavBarBurger.spec.js.snap` → `NavBarBurger.spec.ts.snap` - `NavBarItem.spec.js.snap` → `NavBarItem.spec.ts.snap` - `NavbarDropdown.spec.js.snap` → `NavbarDropdown.spec.ts.snap`
`rollup.config.mjs` removes "navbar" from `JS_COMPONENTS`.
Rewrites the documentation for the navbar components in the `src/pages/components/navbar` in TypeScript. All the changes are straightforward. Here is a TypeScript migration tip: - Explicitly import and register components so that they are type checked. No type-checking is performed for globally registered components.
wesdevpro
approved these changes
Jan 4, 2025
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.
Related issues:
Proposed Changes
navbarand related docspackages/buefy-next/rollup.config.mjsmay cause a conflict after merging other PRs in this tier.