forked from arduino/compile-sketches
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add infrastructure to check for Prettier formatting compliance
A task and GitHub Actions workflow are provided here for formatting the project's files using the Prettier code formatter tool. On every push and pull request that affects relevant files, the GitHub Actions workflow will check whether the formatting of supported files is compliant with the Prettier style.
- Loading branch information
Showing
6 changed files
with
296 additions
and
2 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,257 @@ | ||
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-prettier-formatting-task.md | ||
| name: Check Prettier Formatting | ||
|
|
||
| env: | ||
| # See: https://github.com/actions/setup-node/#readme | ||
| NODE_VERSION: 16.x | ||
|
|
||
| # See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows | ||
| on: | ||
| create: | ||
| push: | ||
| paths: | ||
| - ".github/workflows/check-prettier-formatting-task.ya?ml" | ||
| - "Taskfile.ya?ml" | ||
| - "**/.prettierignore" | ||
| - "**/.prettierrc*" | ||
| # CSS | ||
| - "**.css" | ||
| - "**.wxss" | ||
| # PostCSS | ||
| - "**.pcss" | ||
| - "**.postcss" | ||
| # Less | ||
| - "**.less" | ||
| # SCSS | ||
| - "**.scss" | ||
| # GraphQL | ||
| - "**.graphqls?" | ||
| - "**.gql" | ||
| # handlebars | ||
| - "**.handlebars" | ||
| - "**.hbs" | ||
| # HTML | ||
| - "**.mjml" | ||
| - "**.html?" | ||
| - "**.html.hl" | ||
| - "**.st" | ||
| - "**.xht" | ||
| - "**.xhtml" | ||
| # Vue | ||
| - "**.vue" | ||
| # JavaScript | ||
| - "**.flow" | ||
| - "**._?jsb?" | ||
| - "**.bones" | ||
| - "**.cjs" | ||
| - "**.es6?" | ||
| - "**.frag" | ||
| - "**.gs" | ||
| - "**.jake" | ||
| - "**.jscad" | ||
| - "**.jsfl" | ||
| - "**.js[ms]" | ||
| - "**.[mn]js" | ||
| - "**.pac" | ||
| - "**.wxs" | ||
| - "**.[xs]s?js" | ||
| - "**.xsjslib" | ||
| # JSX | ||
| - "**.jsx" | ||
| # TypeScript | ||
| - "**.ts" | ||
| # TSX | ||
| - "**.tsx" | ||
| # JSON | ||
| - "**/.eslintrc" | ||
| - "**.json" | ||
| - "**.avsc" | ||
| - "**.geojson" | ||
| - "**.gltf" | ||
| - "**.har" | ||
| - "**.ice" | ||
| - "**.JSON-tmLanguage" | ||
| - "**.mcmeta" | ||
| - "**.tfstate" | ||
| - "**.topojson" | ||
| - "**.webapp" | ||
| - "**.webmanifest" | ||
| - "**.yyp?" | ||
| # JSONC | ||
| - "**/.babelrc" | ||
| - "**/.jscsrc" | ||
| - "**/.js[hl]intrc" | ||
| - "**.jsonc" | ||
| - "**.sublime-*" | ||
| # JSON5 | ||
| - "**.json5" | ||
| # Markdown | ||
| - "**.mdx?" | ||
| - "**.markdown" | ||
| - "**.mk?down" | ||
| - "**.mdwn" | ||
| - "**.mkdn?" | ||
| - "**.ronn" | ||
| - "**.workbook" | ||
| # YAML | ||
| - "**/.clang-format" | ||
| - "**/.clang-tidy" | ||
| - "**/.gemrc" | ||
| - "**/glide.lock" | ||
| - "**.ya?ml*" | ||
| - "**.mir" | ||
| - "**.reek" | ||
| - "**.rviz" | ||
| - "**.sublime-syntax" | ||
| - "**.syntax" | ||
| pull_request: | ||
| paths: | ||
| - ".github/workflows/check-prettier-formatting-task.ya?ml" | ||
| - "Taskfile.ya?ml" | ||
| - "**/.prettierignore" | ||
| - "**/.prettierrc*" | ||
| # CSS | ||
| - "**.css" | ||
| - "**.wxss" | ||
| # PostCSS | ||
| - "**.pcss" | ||
| - "**.postcss" | ||
| # Less | ||
| - "**.less" | ||
| # SCSS | ||
| - "**.scss" | ||
| # GraphQL | ||
| - "**.graphqls?" | ||
| - "**.gql" | ||
| # handlebars | ||
| - "**.handlebars" | ||
| - "**.hbs" | ||
| # HTML | ||
| - "**.mjml" | ||
| - "**.html?" | ||
| - "**.html.hl" | ||
| - "**.st" | ||
| - "**.xht" | ||
| - "**.xhtml" | ||
| # Vue | ||
| - "**.vue" | ||
| # JavaScript | ||
| - "**.flow" | ||
| - "**._?jsb?" | ||
| - "**.bones" | ||
| - "**.cjs" | ||
| - "**.es6?" | ||
| - "**.frag" | ||
| - "**.gs" | ||
| - "**.jake" | ||
| - "**.jscad" | ||
| - "**.jsfl" | ||
| - "**.js[ms]" | ||
| - "**.[mn]js" | ||
| - "**.pac" | ||
| - "**.wxs" | ||
| - "**.[xs]s?js" | ||
| - "**.xsjslib" | ||
| # JSX | ||
| - "**.jsx" | ||
| # TypeScript | ||
| - "**.ts" | ||
| # TSX | ||
| - "**.tsx" | ||
| # JSON | ||
| - "**/.eslintrc" | ||
| - "**.json" | ||
| - "**.avsc" | ||
| - "**.geojson" | ||
| - "**.gltf" | ||
| - "**.har" | ||
| - "**.ice" | ||
| - "**.JSON-tmLanguage" | ||
| - "**.mcmeta" | ||
| - "**.tfstate" | ||
| - "**.topojson" | ||
| - "**.webapp" | ||
| - "**.webmanifest" | ||
| - "**.yyp?" | ||
| # JSONC | ||
| - "**/.babelrc" | ||
| - "**/.jscsrc" | ||
| - "**/.js[hl]intrc" | ||
| - "**.jsonc" | ||
| - "**.sublime-*" | ||
| # JSON5 | ||
| - "**.json5" | ||
| # Markdown | ||
| - "**.mdx?" | ||
| - "**.markdown" | ||
| - "**.mk?down" | ||
| - "**.mdwn" | ||
| - "**.mkdn?" | ||
| - "**.ronn" | ||
| - "**.workbook" | ||
| # YAML | ||
| - "**/.clang-format" | ||
| - "**/.clang-tidy" | ||
| - "**/.gemrc" | ||
| - "**/glide.lock" | ||
| - "**.ya?ml*" | ||
| - "**.mir" | ||
| - "**.reek" | ||
| - "**.rviz" | ||
| - "**.sublime-syntax" | ||
| - "**.syntax" | ||
| schedule: | ||
| # Run periodically to catch breakage caused by external changes. | ||
| - cron: "0 4 * * WED" | ||
| workflow_dispatch: | ||
| repository_dispatch: | ||
|
|
||
| jobs: | ||
| run-determination: | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| result: ${{ steps.determination.outputs.result }} | ||
| steps: | ||
| - name: Determine if the rest of the workflow should run | ||
| id: determination | ||
| run: | | ||
| RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" | ||
| # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. | ||
| if [[ | ||
| "${{ github.event_name }}" != "create" || | ||
| "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX | ||
| ]]; then | ||
| # Run the other jobs. | ||
| RESULT="true" | ||
| else | ||
| # There is no need to run the other jobs. | ||
| RESULT="false" | ||
| fi | ||
| echo "result=$RESULT" >> $GITHUB_OUTPUT | ||
| check: | ||
| needs: run-determination | ||
| if: needs.run-determination.outputs.result == 'true' | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: ${{ env.NODE_VERSION }} | ||
|
|
||
| - name: Install Task | ||
| uses: arduino/setup-task@v1 | ||
| with: | ||
| repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
| version: 3.x | ||
|
|
||
| - name: Format with Prettier | ||
| run: task general:format-prettier | ||
|
|
||
| - name: Check formatting | ||
| run: git diff --color --exit-code |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| .licenses/ | ||
| .pytest_cache/ | ||
| __pycache__/ | ||
| node_modules/ |
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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