-
Notifications
You must be signed in to change notification settings - Fork 3
Formatting and linting improvements. #887
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
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
75d79a8
Add black for code formatting. Remove some linting exclusions. Fix er…
mfjarvis be56dff
Fix path.
mfjarvis f3cb023
Don't install quality_checks package.
mfjarvis 3f33ab6
Fix commands.
mfjarvis 1af8559
Update pre-commit script.
mfjarvis e0bc615
Add lint-staged to lint and format staged files only.
mfjarvis 64ed0df
Add husky to manage commit hooks.
mfjarvis da51d71
Add prettier for MD / YAML / JSON formatting.
mfjarvis c3d53ed
Resolve some Sonar warnings.
mfjarvis ba44dcb
Add .prettierignore and run prettier on all supported files.
mfjarvis 998eef0
Revert auto formatting of jsc files.
mfjarvis e783bec
Fix lint error.
mfjarvis 412a96d
Merge branch 'master' into VED-000-formatting-and-linting
mfjarvis 2e04749
Format Terraform.
mfjarvis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,24 @@ | ||
| ## Summary | ||
| * Routine Change | ||
| * :exclamation: Breaking Change | ||
| * :robot: Operational or Infrastructure Change | ||
| * :sparkles: New Feature | ||
| * :warning: Potential issues that might be caused by this change | ||
|
|
||
| Add any other relevant notes or explanations here. **Remove this line if you have nothing to add.** | ||
| - Routine Change | ||
| - :exclamation: Breaking Change | ||
| - :robot: Operational or Infrastructure Change | ||
| - :sparkles: New Feature | ||
| - :warning: Potential issues that might be caused by this change | ||
|
|
||
| Add any other relevant notes or explanations here. **Remove this line if you have nothing to add.** | ||
|
|
||
| ## Reviews Required | ||
| * [x] Dev | ||
| * [ ] Test | ||
| * [ ] Tech Author | ||
| * [ ] Product Owner | ||
|
|
||
| - [x] Dev | ||
| - [ ] Test | ||
| - [ ] Tech Author | ||
| - [ ] Product Owner | ||
|
|
||
| ## Review Checklist | ||
|
|
||
| :information_source: This section is to be filled in by the **reviewer**. | ||
|
|
||
| * [ ] I have reviewed the changes in this PR and they fill all or part of the acceptance criteria of the ticket, and the code is in a mergeable state. | ||
| * [ ] If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work. | ||
| * [ ] I have ensured the changelog has been updated by the submitter, if necessary. | ||
| - [ ] I have reviewed the changes in this PR and they fill all or part of the acceptance criteria of the ticket, and the code is in a mergeable state. | ||
| - [ ] If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work. | ||
| - [ ] I have ensured the changelog has been updated by the submitter, if necessary. |
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| npx lint-staged |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # This is a template, not a valid YAML file | ||
| /manifest_template.yml | ||
|
|
||
| # We hit compile errors in Apigee if these are auto formatted | ||
| # TODO - investigate | ||
| /proxies/live/apiproxy/resources/jsc/ | ||
| /proxies/sandbox/apiproxy/resources/jsc/ |
This file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,39 @@ | ||
| # Contribution Guidelines | ||
|
|
||
| ## Raising an Issue | ||
|
|
||
| If you raise an issue against this repository, please include as much information as possible to reproduce any bugs, | ||
| or specific locations in the case of content errors. | ||
|
|
||
| ## Contributing code | ||
|
|
||
| To contribute code, please fork the repository and raise a pull request. | ||
|
|
||
| Ideally pull requests should be fairly granular and aim to solve one problem each. It would also be helpful if they | ||
| linked to an issue. If the maintainers cannot understand why a pull request was raised, it will be rejected, | ||
| so please explain why the changes need to be made (unless it is self-evident). | ||
|
|
||
| ### Merge responsibility | ||
| * It is the responsibility of the reviewer to merge branches they have approved. | ||
| * It is the responsibility of the author of the merge to ensure their merge is in a mergeable state. | ||
| * It is the responsibility of the maintainers to ensure the merge process is unambiguous and automated where possible. | ||
|
|
||
| - It is the responsibility of the reviewer to merge branches they have approved. | ||
| - It is the responsibility of the author of the merge to ensure their merge is in a mergeable state. | ||
| - It is the responsibility of the maintainers to ensure the merge process is unambiguous and automated where possible. | ||
|
|
||
| ### Branch naming | ||
|
|
||
| Branch names should be of the format: | ||
|
|
||
| `apm-nnn-short-issue-description` | ||
|
|
||
| Multiple branches are permitted for the same ticket. | ||
|
|
||
| ### Commit messages | ||
|
|
||
| Commit messages should be formatted as follows: | ||
|
|
||
| ``` | ||
| APM-NNN Summary of changes | ||
|
|
||
| Longer description of changes if explaining rationale is necessary, | ||
| limited to 80 columns and spanning as many lines as you need. | ||
| ``` | ||
|
|
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we also wanna run the same prettier checks and tf fmt check that we have for pre-commits in the pipeline in case someone does not have them switched on locally?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah good shout. Will create a small follow up PR for this and some README changes