-
-
Notifications
You must be signed in to change notification settings - Fork 776
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
Repo & development updates, Docs rewrite, CI improvements, and more #711
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
This PR is now ready for review. Sorry not sorry for the file count haha, that's mostly because of the vuepress changes. |
favna
changed the title
General repo & development updates
Repo & development updates, Docs rewrite, CI improvements, and more
Jan 27, 2023
Oh wow this is huge. Will review it now. Thanks! |
This was referenced Jul 9, 2023
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.
It's been nearly 4 years since I created #291 changing this repository from Vows to Jest and the Node ecosystem has definitely not been standing still so I figured "let's create another general update PR".
Migrated from Jest to Vitest.
Vitest is a new test runner powered by Vite and is much faster than Jest. Like was the motivation for Jest in Three improvements for the price of one #291 it has TypeScript support built in, adding to that, in the future we can even make the TypeScript tests even better through Type Testing
Updated from Vuepress v1 to Vuepress v2. This brings with it maaaaaaannnyy fixes, improvements, enhancements and so on. Both because I put quite a lot of effort in the rewrite, as well as because in general this updates from Vue 2 to Vue 3 and Vuepress has gone through many changes as well. Some notable things:
I am not sure how the current production website is deployed. You can reference https://v2.vuepress.vuejs.org/guide/deployment.html to learn how to deploy the new site. That said, if it's through GitHub pages then do let me know because these days it is possible to use a GH Action to deploy directly, you don't even need a
gh-pages
branch anymore then.Migrated from
yarn
tonpm
. Previously in Three improvements for the price of one #291 I made a change to preferyarn.lock
but I noticed that since then you have added scripts that usenpm
so I am making the assumption that is your package manager of choice. To ensure the repo is not in a 50/50 state of package managers I now fully switched the repo over to using npm in all references.Updated Husky to v8 and changed how it is configured to how it should've been above v4 (https://typicode.github.io/husky/#/?id=migrate-from-v4-to-v8). The old way of doing it through package.json hasn't been working since v4, so the current repo wasn't protected by husky at all.
Updated various dev dependencies. I did not update rollup because it included the breaking changes of v3.0.0 which I'm not sure if they will affect the project. Of note is that Fuse's engines are set to Node 10, whereas Rollup v3 targets Node >= 14.
Added
eslint-config-prettier
to the eslintrc file, it was a dev dep that was never loaded before.Ran prettier on the whole repo
Updated the GitHub issue templates to YAML style so issues are form-like inputs. These can be previewed on my branch: https://github.com/favna/Fuse/blob/chore/dev-migrations/.github/ISSUE_TEMPLATE/bug_report.yml
Split
tsconfig.json
into 2 files, 1 forsrc
and 1 fortest
. This is to ensure that each set can have its own dedicated config, and it's also a slight improvement for the TS language services of IDEs because they only load the ones for the files opened. A negligible difference for this repo, but it's a difference nonetheless.Add
.prettierignore
file to allow runningnpx prettier --write .
without modifying files that shouldn't be formatted with Prettier. Just something I ran into when doing point 6.Update GitHub workflows
Updated the files in
dist
by runningnpm run build
to update their code with all the changes above