Slight refactoring and documentation of compression #93
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
| name: Spell Check | |
| on: | |
| pull_request: | |
| branches: [master] | |
| jobs: | |
| spellcheck: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Install dependencies and dictionary | |
| run: | | |
| npm install -g cspell jq @cspell/dict-scientific-terms-us | |
| - name: Run cspell | |
| run: | | |
| cspell --config cspell.json \ | |
| "README.md" "CITATION.cff" \ | |
| "docs/**/*" \ | |
| "src/pynxtools/**/*.py" \ | |
| "tests/**/*.py" | |
| - name: Fail on errors | |
| run: | | |
| if [[ $? -ne 0 ]]; then | |
| echo "There are spelling errors in your code. Please fix them and try again." | |
| exit 1 | |
| fi |