mirror of
https://github.com/creyD/prettier_action.git
synced 2026-04-13 20:00:30 +02:00
Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6602189cf8 | |||
| 0bf5ce065a | |||
| ac20e98371 | |||
| 607ddfdc57 | |||
|
|
9dff813935 | ||
| 058125065f | |||
|
|
8a16fc9688 | ||
| 661230a857 | |||
| 49aca57540 | |||
| eafd91e372 | |||
|
|
13fd7a03b4 | ||
| b8440d072c | |||
|
|
89919dc836 |
8
.github/ISSUE_TEMPLATE/bug_report.md
vendored
8
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -3,12 +3,12 @@ name: Bug report
|
|||||||
about: Report a problem!
|
about: Report a problem!
|
||||||
title: "[BUG]"
|
title: "[BUG]"
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ''
|
assignees: ""
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**What exactly happened?**
|
**What exactly happened?**
|
||||||
Steps to reproduce the behavior:
|
Steps to reproduce the behavior:
|
||||||
|
|
||||||
1. Go to '...'
|
1. Go to '...'
|
||||||
2. Click on '....'
|
2. Click on '....'
|
||||||
3. Scroll down to '....'
|
3. Scroll down to '....'
|
||||||
@@ -21,8 +21,8 @@ A clear and concise description of what you expected to happen.
|
|||||||
If applicable, add screenshots to help explain your problem.
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
**Where did you encounter the problem?**
|
**Where did you encounter the problem?**
|
||||||
- OS: [e.g. iOS]
|
|
||||||
- Repo: [e.g. URL to your repository]
|
- Repo: [e.g. URL to your repository]
|
||||||
- Version [e.g. 22]
|
- Version [e.g. 22]
|
||||||
|
|
||||||
<!-- If you think you can help us with that, please note it here! -->
|
<!-- If you think you can help us with that, please note it here! -->
|
||||||
|
|||||||
5
.github/ISSUE_TEMPLATE/feature_request.md
vendored
5
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -3,12 +3,11 @@ name: Feature request
|
|||||||
about: Request a feature!
|
about: Request a feature!
|
||||||
title: "[FEATURE]"
|
title: "[FEATURE]"
|
||||||
labels: enhancement
|
labels: enhancement
|
||||||
assignees: ''
|
assignees: ""
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**What would you like to change about the program?**
|
**What would you like to change about the program?**
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
A clear and concise description of what the problem is.
|
||||||
|
|
||||||
**Why do you think this is a cool idea?**
|
**Why do you think this is a cool idea?**
|
||||||
A clear and concise description of why your feature would improve the program.
|
A clear and concise description of why your feature would improve the program.
|
||||||
|
|||||||
106
README.md
106
README.md
@@ -7,7 +7,6 @@
|
|||||||
[](https://github.com/creyD/prettier_action/graphs/contributors)
|
[](https://github.com/creyD/prettier_action/graphs/contributors)
|
||||||
[](https://github.com/creyD/prettier_action/issues)
|
[](https://github.com/creyD/prettier_action/issues)
|
||||||
|
|
||||||
|
|
||||||
A GitHub action for styling files with [prettier](https://prettier.io).
|
A GitHub action for styling files with [prettier](https://prettier.io).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@@ -35,7 +34,9 @@ A GitHub action for styling files with [prettier](https://prettier.io).
|
|||||||
### Example Config
|
### Example Config
|
||||||
|
|
||||||
> Hint: if you still use the old naming convention or generally a different branch name, please replace the `main` in the following configurations.
|
> Hint: if you still use the old naming convention or generally a different branch name, please replace the `main` in the following configurations.
|
||||||
|
|
||||||
#### Example 1 (run on push in branch main)
|
#### Example 1 (run on push in branch main)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: Continuous Integration
|
name: Continuous Integration
|
||||||
|
|
||||||
@@ -44,27 +45,28 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
prettier:
|
prettier:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
# Make sure the actual branch is checked out when running on pull requests
|
# Make sure the actual branch is checked out when running on pull requests
|
||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
|
|
||||||
- name: Prettify code
|
- name: Prettify code
|
||||||
uses: creyD/prettier_action@v4.1
|
uses: creyD/prettier_action@v4.2
|
||||||
with:
|
with:
|
||||||
# This part is also where you can pass other options, for example:
|
# This part is also where you can pass other options, for example:
|
||||||
prettier_options: --write **/*.{js,md}
|
prettier_options: --write **/*.{js,md}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example 2 (using the only_changed or same_commit option on PR)
|
#### Example 2 (using the only_changed or same_commit option on PR)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: Continuous Integration
|
name: Continuous Integration
|
||||||
|
|
||||||
@@ -77,23 +79,24 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
# Make sure the actual branch is checked out when running on pull requests
|
# Make sure the actual branch is checked out when running on pull requests
|
||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
# This is important to fetch the changes to the previous commit
|
# This is important to fetch the changes to the previous commit
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Prettify code
|
- name: Prettify code
|
||||||
uses: creyD/prettier_action@v4.1
|
uses: creyD/prettier_action@v4.2
|
||||||
with:
|
with:
|
||||||
# This part is also where you can pass other options, for example:
|
# This part is also where you can pass other options, for example:
|
||||||
prettier_options: --write **/*.{js,md}
|
prettier_options: --write **/*.{js,md}
|
||||||
only_changed: True
|
only_changed: True
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example 3 (using a custom access token on PR)
|
#### Example 3 (using a custom access token on PR)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: Continuous Integration
|
name: Continuous Integration
|
||||||
|
|
||||||
@@ -106,24 +109,25 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Prettify code
|
- name: Prettify code
|
||||||
uses: creyD/prettier_action@v4.1
|
uses: creyD/prettier_action@v4.2
|
||||||
with:
|
with:
|
||||||
prettier_options: --write **/*.{js,md}
|
prettier_options: --write **/*.{js,md}
|
||||||
only_changed: True
|
only_changed: True
|
||||||
# Set your custom token
|
# Set your custom token
|
||||||
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example 4 (dry run)
|
#### Example 4 (dry run)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: Continuous Integration
|
name: Continuous Integration
|
||||||
|
|
||||||
@@ -136,19 +140,19 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Prettify code
|
- name: Prettify code
|
||||||
uses: creyD/prettier_action@v4.1
|
uses: creyD/prettier_action@v4.2
|
||||||
with:
|
with:
|
||||||
dry: True
|
dry: True
|
||||||
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
|
More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
|
||||||
|
|||||||
@@ -59,12 +59,12 @@ if [ -n "$INPUT_PRETTIER_PLUGINS" ]; then
|
|||||||
for plugin in $INPUT_PRETTIER_PLUGINS; do
|
for plugin in $INPUT_PRETTIER_PLUGINS; do
|
||||||
echo "Checking plugin: $plugin"
|
echo "Checking plugin: $plugin"
|
||||||
# check regex against @prettier/xyz
|
# check regex against @prettier/xyz
|
||||||
if ! echo "$plugin" | grep -Eq '(@prettier\/)+(plugin-[a-z\-]+)'; then
|
if ! echo "$plugin" | grep -Eq '(@prettier\/plugin-|(@[a-z\-]+\/)?prettier-plugin-){1}([a-z\-]+)'; then
|
||||||
echo "$plugin does not seem to be a valid @prettier/plugin-x plugin. Exiting."
|
echo "$plugin does not seem to be a valid @prettier/plugin-x plugin. Exiting."
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
npm install --silent --global $INPUT_PRETTIER_PLUGINS
|
npm install --silent $INPUT_PRETTIER_PLUGINS
|
||||||
fi
|
fi
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -120,8 +120,7 @@ if _git_changed; then
|
|||||||
git commit --amend --no-edit
|
git commit --amend --no-edit
|
||||||
git push origin -f
|
git push origin -f
|
||||||
else
|
else
|
||||||
if [ "$INPUT_COMMIT_DESCRIPTION" != "" ]
|
if [ "$INPUT_COMMIT_DESCRIPTION" != "" ]; then
|
||||||
then
|
|
||||||
git commit -m "$INPUT_COMMIT_MESSAGE" -m "$INPUT_COMMIT_DESCRIPTION" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
|
git commit -m "$INPUT_COMMIT_MESSAGE" -m "$INPUT_COMMIT_DESCRIPTION" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
|
||||||
else
|
else
|
||||||
git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
|
git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
|
||||||
|
|||||||
Reference in New Issue
Block a user