Skip to content

docs: fix formatting and order of contribution guide content #2793

docs: fix formatting and order of contribution guide content

docs: fix formatting and order of contribution guide content #2793

Workflow file for this run

name: Verify
on:
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.sha }}
cancel-in-progress: true
jobs:
formatting-lint:
name: Check for formatting & lint errors
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/[email protected]
with:
# Make sure the actual branch is checked out when running on pull requests
ref: ${{ github.head_ref }}
- name: Setup Node
uses: actions/[email protected]
with:
node-version-file: .nvmrc
cache: 'npm'
- name: Install Dependencies
run: npm ci
- id: files
uses: Ana06/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
- name: Filter JS/TS Files
run: |
echo "${{ steps.files.outputs.added_modified }}" | tr ' ' '\n' | grep -E '\.(js|ts|jsx|tsx)$' > changed_files.txt
if [ ! -s changed_files.txt ]; then
echo "No JS/TS files to format or lint."
exit 0
fi
- name: Run format Checks
run: |
if [ -s changed_files.txt ]; then
npx prettier --write $(cat changed_files.txt)
fi
- run: git diff --exit-code
- name: Formatting Error message
if: ${{ failure() }}
run: |
echo 'prettier formatting failure. Ensure you run `npm run format` and commit the files.'
- name: Run eslint Checks
run: |
npx eslint ${{steps.files.outputs.added_modified}} --fix
- run: git diff --exit-code
- name: Eslint Error message
if: ${{ failure() }}
run: |
echo 'Eslint failure. Ensure you run `npm run lint:fix` and commit the files.'