feat(scripts): allow Prettier to format more files (YAML, Markdown) #103
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
We're not going to change the default globs in liferay-portal yet (or possibly ever?) because the Java Source Formatter currently handles these types. However, we can make it easier for non-liferay-portal projects like liferay-learn: https://github.com/liferay/liferay-learn that use liferay-npm-scripts to run Prettier over a broader range of files. It's a simple matter of expanding the list of allowed globs. Test plan: In order to actually test this I had these two PRs applied: - #101 - #102 Then, with this npmscripts.config.js at the top level of the monorepo: module.exports = { check: ['**/*.{md,ts,yml}'], fix: ['**/*.{md,ts,yml}'], } I created some bad files and ran `projects/npm-tools/packages/npm-scripts/bin/liferay-npm-scripts.js check` and saw these errors: x.md: BAD x.ts: BAD x.yml: BAD and then ran `check` and saw them get fixed. Then, for good measure, in a liferay-learn clone, I added "yml" and "md" to the globs in the npmscripts.config.js and repeated the test after a: npm install cp -R path/to/npm-scripts node_modules/@liferay/ ie. npm run format:check see: site/homepage/x.md: BAD site/homepage/x.yml: BAD Prettier checked 21 files, 2 files have problems Then: npm run format and see the errors fixed: Prettier checked 21 files, fixed 2 files Closes: #92
|
cc @rdai10 |
wincent
commented
Oct 1, 2020
Comment on lines
+28
to
+29
| '.md', | ||
| '.markdown', |
There was a problem hiding this comment.
In Frontend Infra repos we just use .md but there are some .markdown in liferay-portal.
wincent
commented
Oct 1, 2020
Comment on lines
+33
to
+34
| '.yml', | ||
| '.yaml', |
There was a problem hiding this comment.
Likewise, we would use .yml, but I hear there are some .yaml out there too.
|
As I said here, I don't think these Windows failures are legit. Will retry them again later. |
Seeing Windows fail strangely on these two PRs: - https://github.com/liferay/liferay-frontend-projects/pull/101/checks?check_run_id=1197440869 - https://github.com/liferay/liferay-frontend-projects/pull/103/checks?check_run_id=1197441199 But not on a nearby run: - https://github.com/liferay/liferay-frontend-projects/pull/102/checks?check_run_id=1194622874 I've retried a yesterday and today with no success, so in this commit I just want to see if invalidating the cache does the trick.
|
See test PR showing what these changes look like when applied to liferay-learn: https://github.com/jrhoun/liferay-learn/pull/690 |
|
As this is basically a "config" change, I'm going to merge it. If anybody needs any follow-ups I will, er, follow-up.
|
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.
We're not going to change the default globs in liferay-portal yet (or possibly ever?) because the Java Source Formatter currently handles these types.
However, we can make it easier for non-liferay-portal projects like liferay-learn that use liferay-npm-scripts to run Prettier over a broader range of files. It's a simple matter of expanding the list of allowed globs.
Test plan:
In order to actually test this I had these two PRs applied:
Then, with this npmscripts.config.js at the top level of the monorepo:
I created some bad files and ran
projects/npm-tools/packages/npm-scripts/bin/liferay-npm-scripts.js checkand saw these errors:and then ran
checkand saw them get fixed.Then, for good measure, in a liferay-learn clone, I added "yml" and "md" to the globs in the npmscripts.config.js and repeated the test after a:
ie.
see:
Then:
and see the errors fixed:
Closes: #92