chore(format): add prettier to project #284
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
rwaskiewicz
force-pushed
the
rwaskiewicz/prettier
branch
2 times, most recently
from
dcadcc7
to
cbecc88
Compare
this commit reworks the pre-existing prettier infrastructure in the project in an attempt to add continuous integration (ci) checks for formatting to the project. prettier and ionic's prettier configuration are added as a top level dependencies to the project, such that lerna can format all projects with a 'prettier' script in the future. by using ionic's prettier configuration, we can converge upon previously agreed upon formatting config. ci is updated to run prettier in parallel with other jobs, allowing us to 'fail-fast' in the event of a formatting error. there is potential room in the future to refactor ci jobs/steps by adding this parallelism, but that was not done here in order to limit the scope of this commit. this commit only handles the angular output target. this allows for incremental improvement/proof-of-concept to get the idea out to the teams managing this project for feedback sooner than later
format the contents of the angular output target using the configuration added in the previous commit.
rwaskiewicz
force-pushed
the
rwaskiewicz/prettier
branch
from
56e50e5
to
9f68774
Compare
rwaskiewicz
commented
Aug 19, 2022
| "@stencil/core": "^2.9.0", | ||
| "@types/jest": "^26.0.9", | ||
| "jest": "^26.3.0", | ||
| "lerna": "^4.0.0", | ||
| "lerna-changelog": "^1.0.1", | ||
| "np": "^6.0.2", | ||
| "prettier": "^2.0.5", | ||
| "prettier": "2.7.1", |
There was a problem hiding this comment.
Locking this as Prettier doesn't necessarily follow semver
rwaskiewicz
commented
Aug 19, 2022
| "rimraf": "^2.6.3", | ||
| "rollup": "^2.23.1", | ||
| "semver": "^5.5.0", |
There was a problem hiding this comment.
This moved as a result of adding new dependencies via npm's CLI - might as well keep it 🤷
liamdebeasi
reviewed
Aug 19, 2022
rwaskiewicz
commented
Aug 19, 2022
| if (componentCorePackage !== undefined) { | ||
| const dirPath = includeImportCustomElements ? `/${customElementsDir || 'components'}` : ''; | ||
| importLocation = `${normalizePath(componentCorePackage)}${dirPath}`; | ||
| export const createComponentDefinition = |
There was a problem hiding this comment.
These changes are a little more palatable if you "ignore whitespace" in GH's diff view
liamdebeasi
approved these changes
Aug 19, 2022
tanner-reits
approved these changes
Aug 19, 2022
rwaskiewicz
commented
Aug 19, 2022
| @@ -20,6 +20,9 @@ | |||
| "watch": "tsc --watch", | |||
| "rollup": "rollup -c", | |||
| "version": "npm run build", | |||
| "prettier": "npm run prettier.base -- --write", | |||
| "prettier.base": "prettier \"./({anguler-output-target,src,test}/**/*.{ts,tsx,js,jsx})|*.{ts,tsx,js,jsx}\"", | |||
There was a problem hiding this comment.
Oops - I need to change this - should be 'angular-component-lib'
13 tasks
rwaskiewicz
added a commit
that referenced
this pull request
Sep 7, 2022
this commit adds formatting infrastructure to the project for the react, svelte and vue output targets. it also formats each of the output targets mentioned above. this commit is a successor to 19d9f38 (#284), which added formatting infrastructure to the angular output target. the examples are intentionally not included in this commit it an effort to limit scope
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.
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally for affected output targetsnpm test) were run locally and passedPull request type
Please check the type of change your PR introduces:
What is the current behavior?
Issue URL: #285
What is the new behavior?
this commit reworks the pre-existing prettier infrastructure in the
project in an attempt to add continuous integration (ci) checks for
formatting to the project.
prettier and ionic's prettier configuration are added as a top level
dependencies to the project, such that lerna can format all projects
with a 'prettier' script in the future. by using ionic's prettier
configuration, we can converge upon previously agreed upon formatting
config.
ci is updated to run prettier in parallel with other jobs, allowing us
to 'fail-fast' in the event of a formatting error. there is potential
room in the future to refactor ci jobs/steps by adding this parallelism,
but that was not done here in order to limit the scope of this commit.
this commit only handles the angular output target. this allows for
incremental improvement/proof-of-concept to get the idea out to the
teams managing this project for feedback sooner than later
format the contents of the angular output target using the configuration
added in the previous commit.
Does this introduce a breaking change?
Other information
Looking for feedback/thoughts here from folks more familiar with Lerna setups and whatnot.