Check Prettier Formatting #599
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
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-prettier-formatting-task.md | |
| name: Check Prettier Formatting | |
| # See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows | |
| on: | |
| create: | |
| push: | |
| paths: | |
| - ".github/workflows/check-prettier-formatting-task.ya?ml" | |
| - "Taskfile.ya?ml" | |
| - "**/.npmrc" | |
| - "**/.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" | |
| - "**/.npmrc" | |
| - "**/.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 | |
| permissions: {} | |
| 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 | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: package.json | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| 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 |