https://github.com/reload/action-jsts-quality
GitHub action that yells if JS/TS formatting and linting is not up to snuff!
https://github.com/reload/action-jsts-quality
Last synced: 2 months ago
JSON representation
GitHub action that yells if JS/TS formatting and linting is not up to snuff!
- Host: GitHub
- URL: https://github.com/reload/action-jsts-quality
- Owner: reload
- Created: 2021-09-01T08:53:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T05:27:13.000Z (about 1 year ago)
- Last Synced: 2025-04-15T15:44:17.667Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 686 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# action-jsts-quality
GitHub action that yells if JS/TS formatting and linting is not up to snuff!
# Requirements
[npm >= 7](https://github.blog/2021-02-02-npm-7-is-now-generally-available/)
Install [D(A)FT](https://github.com/reload/daft):
```sh
npm install @reloaddk/daft --save-dev
```
or the minimally required packages:
```sh
npm install eslint prettier --save-dev
```
The action will make use of your installed version of the required tools.
So make sure to have them specified in your `package.json` and available from
`node_modules/.bin`
# Usage
## Root configuration
```yaml
name: JSTS Quality
on: pull_request
jobs:
quality:
name: JSTS Quality
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: JSTS Quality
uses: reload/action-jsts-quality@1.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
## Subdirectory (theme) configuration
```yaml
name: JSTS Quality
on: pull_request
jobs:
quality:
name: JSTS Quality
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'npm'
cache-dependency-path: ./web/themes/custom/custom-theme/package-lock.json
- name: Install dependencies
run: npm ci
working-directory: ./web/themes/custom/custom-theme
- name: JSTS Quality
uses: reload/action-jsts-quality@1.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
working_directory: ./web/themes/custom/custom-theme/js
```
## Change targeted files
```yaml
jobs:
quality:
name: JSTS Quality
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: JSTS Quality
uses: reload/action-jsts-quality@1.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
file_extensions: '.ts,' # Default: '.js,.jsx,.ts,.tsx,.mjs'
```
## Override eslint and prettier targets
```yaml
jobs:
quality:
name: JSTS Quality
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: JSTS Quality
uses: reload/action-jsts-quality@1.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Both of the specified targets have their origin at whatever
# 'working_directory' is set to.
working_directory: './src' # Default: ''
prettier_target: './code/**/*' # Default: './**/*'
eslint_target: './code' # Default: '.'
```