https://github.com/permafrost-dev/eslint-docker-ga
Run ESLint on your source code from a workflow
https://github.com/permafrost-dev/eslint-docker-ga
Last synced: 12 months ago
JSON representation
Run ESLint on your source code from a workflow
- Host: GitHub
- URL: https://github.com/permafrost-dev/eslint-docker-ga
- Owner: permafrost-dev
- License: mit
- Created: 2021-12-26T08:41:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T04:41:05.000Z (over 2 years ago)
- Last Synced: 2025-03-14T06:47:06.566Z (over 1 year ago)
- Language: JavaScript
- Size: 115 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# eslint-docker-ga
Run ESLint on your source code from GitHub workflows
Sample Github workflow (this assumes there is a `.eslintrc.js` file in your repository):
```yaml
name: Check & fix styling (eslint)
on:
push:
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- name: Run ESLint
uses: permafrost-dev/eslint-docker-ga@main
with:
args: --fix ./src/**/*
- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Fix styling
```
Use a preset configuration by either NOT specifying the `--config` option in `args`, or by specifying `--typescript` to use the TypeScript configuration.
```yaml
name: Check & fix styling (eslint)
on:
push:
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- name: Run ESLint
uses: permafrost-dev/eslint-docker-ga@main
with:
args: --typescript --fix ./src/**/*
- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Fix styling
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Patrick Organ](https://github.com/patinthehat)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.