Document Prettier in README #2104
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
…esomeImports.js to .prettierignore, and create an npm command to simplify formatting checks
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
karl-cardenas-coding
requested changes
Jan 24, 2024
README.md
Outdated
| In this case, issue the following command to format all files manually. | ||
|
|
||
| ``` | ||
| npm run format |
There was a problem hiding this comment.
Can we use the Makefile instead? That's a pattern we started a long time ago.
There was a problem hiding this comment.
I've added the Make command. Could you please document this pattern so that it's explicit for anyone who wants to introduce changes to the docbase? I would also be happy to document it if you have a minute to explain the patterns expectations to me 🙌🏻
README.md
Outdated
| commit changes, Prettier formats the staged files automatically. Then, once you create a pull request, it verifies that | ||
| all files comply with our Prettier configuration. | ||
|
|
||
| **Note:** The build fails if the Code Formatting check doesn't pass. |
There was a problem hiding this comment.
Because this is for the README. We could use GitHub markdown alerts.
yuliiiah
added
backport-version-4-0
karl-cardenas-coding
approved these changes
Jan 25, 2024
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Jan 25, 2024
* chore: Document Prettier, add src/components/IconMapper/dynamicFontAwesomeImports.js to .prettierignore, and create an npm command to simplify formatting checks * chore: Update Prettier docs and add format-check to Makefile * chore: Add docs/api-content/**/*.json to .prettierignore --------- Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 5b03006)
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Jan 25, 2024
* chore: Document Prettier, add src/components/IconMapper/dynamicFontAwesomeImports.js to .prettierignore, and create an npm command to simplify formatting checks * chore: Update Prettier docs and add format-check to Makefile * chore: Add docs/api-content/**/*.json to .prettierignore --------- Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 5b03006)
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Jan 25, 2024
* chore: Document Prettier, add src/components/IconMapper/dynamicFontAwesomeImports.js to .prettierignore, and create an npm command to simplify formatting checks * chore: Update Prettier docs and add format-check to Makefile * chore: Add docs/api-content/**/*.json to .prettierignore --------- Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 5b03006)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Jan 25, 2024
* chore: Document Prettier, add src/components/IconMapper/dynamicFontAwesomeImports.js to .prettierignore, and create an npm command to simplify formatting checks * chore: Update Prettier docs and add format-check to Makefile * chore: Add docs/api-content/**/*.json to .prettierignore --------- Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 5b03006) Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Jan 25, 2024
* chore: Document Prettier, add src/components/IconMapper/dynamicFontAwesomeImports.js to .prettierignore, and create an npm command to simplify formatting checks * chore: Update Prettier docs and add format-check to Makefile * chore: Add docs/api-content/**/*.json to .prettierignore --------- Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 5b03006) Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Jan 25, 2024
* chore: Document Prettier, add src/components/IconMapper/dynamicFontAwesomeImports.js to .prettierignore, and create an npm command to simplify formatting checks * chore: Update Prettier docs and add format-check to Makefile * chore: Add docs/api-content/**/*.json to .prettierignore --------- Co-authored-by: Karl Cardenas <karl@spectrocloud.com> (cherry picked from commit 5b03006) Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
2 tasks
|
🎉 This PR is included in version 4.2.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 4.2.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
2 tasks
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.
Describe the Change
This PR:
npm run format-check.Review Changes
💻 Add Preview URL
🎫 Jira Ticket