chore(repo): add prettier infrastructure #1047
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
rwaskiewicz
commented
Jan 5, 2024
| }, | ||
| "dependencies": { | ||
| "@docusaurus/core": "^3.0.1", | ||
| "@docusaurus/remark-plugin-npm2yarn": "^3.0.1", | ||
| "@ionic/prettier-config": "^4.0.0", |
There was a problem hiding this comment.
Just moving these to devDependencies here
rwaskiewicz
requested review from
christian-bromann,
alicewriteswrongs and
jaredcbaum
and removed request for
a team
jaredcbaum
approved these changes
Jan 5, 2024
this commit adds prettier infrastructure to the project. prettier was previously a dependency of the project, but was not being used. similar to other stencil projects, this commit uses ionic's prettier configuration for consistent formatting. three npm scripts have been added for prettier: 1. `prettier.base` to serve as a single source of truth for common settings, such as directories to format 2. `prettier.dry-run` to act as a non-mutating prettier run. used in ci 3. `prettier` to format and write changes back to disk to start, we shall only format configuration scripts (JavaScript + TypeScript). at the time of this writing, there are: - two previous major iterations of the docs (v2, v3) - nine minor iterations for stencil v4 - the `next` section of the documentation (slated for stencil v4.10.0) at this time, i would prefer to minimize churn related to formatting these 12 directories (2 + 9 + 1). perhaps shortly after the release of stencil v5 (where the v4 documentation is collapsed into one directory) will we consider either formatting all major version directories, or just the v5 directory. prettier and the ionic prettier configuration dependencies have been moved to `dev-dependencies`, as they are not needed in the production build of the site. a ci workflow (`main.yml`) has been added to kick off a dry-run of prettier. should any files not be properly formatted, the workflow shall fail. the intent is to block landing code on this check in github.
tanner-reits
approved these changes
Jan 16, 2024
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.
this commit adds prettier infrastructure to the project. prettier was
previously a dependency of the project, but was not being used. similar
to other stencil projects, this commit uses ionic's prettier
configuration for consistent formatting.
three npm scripts have been added for prettier:
prettier.baseto serve as a single source of truth for commonsettings, such as directories to format
prettier.dry-runto act as a non-mutating prettier run. used in ciprettierto format and write changes back to diskto start, we shall only format configuration scripts (JavaScript +
TypeScript). at the time of this writing, there are:
nextsection of the documentation (slated for stencil v4.10.0)at this time, i would prefer to minimize churn related to formatting
these 12 directories (2 + 9 + 1). perhaps shortly after the release of
stencil v5 (where the v4 documentation is collapsed into one directory)
will we consider either formatting all major version directories, or
just the v5 directory.
prettier and the ionic prettier configuration dependencies have been
moved to
dev-dependencies, as they are not needed in the productionbuild of the site.
a ci workflow (
main.yml) has been added to kick off a dry-run ofprettier. should any files not be properly formatted, the workflow shall
fail. the intent is to block landing code on this check in github.
the second commit runs the formatter.