Skip to content

Commit 5c1bcfb

Browse files
committed
update readme
1 parent 51c868c commit 5c1bcfb

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

README.md

+32-28
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# Datapack Linter
2+
このGitHubActionはdatapackの変更があったファイルの構文チェックを行います。
23

3-
このGitHubActionはdatapackの構文チェックを行います。
4-
5-
This GitHubAction performs a datapack syntax check.
4+
This GitHubAction will perform a syntax check of the files that have been modified in datapack.
65

76
## 使い方 / Usage
8-
97
1. GitHubの自身のリポジトリでActionsタブへ行き`New workflow`をクリック
10-
8+
119
Go to your own repository on GitHub, go to the Actions tab and click on `New workflow`.
1210

1311
1. 下の方にあるManual workflowを選択し下記の設定ファイルをコピー&ペースト
@@ -17,33 +15,39 @@ This GitHubAction performs a datapack syntax check.
1715
1. 右上の`Start commit` -> `Commit new file`を押し準備完了
1816

1917
Press `Start commit` -> `Commit new file` in the upper right corner to get ready.
20-
```yaml
21-
name: lint-datapack
22-
on:
23-
push:
24-
pull_request:
25-
workflow_dispatch:
26-
jobs:
27-
lint:
28-
name: lint
29-
runs-on: ubuntu-latest
30-
if: "!contains(github.event.head_commit.message, '[skip ci]')"
31-
steps:
32-
- uses: actions/checkout@v2
33-
with:
34-
fetch-depth: 0
35-
- name: Test
36-
uses: ChenCMD/datapack-linter@main
37-
```
18+
```yaml
19+
name: lint-datapack
20+
on:
21+
push:
22+
pull_request:
23+
workflow_dispatch:
24+
jobs:
25+
lint:
26+
name: lint
27+
runs-on: ubuntu-latest
28+
if: "!contains(github.event.head_commit.message, '[skip ci]')"
29+
steps:
30+
- name: checkout repository
31+
uses: actions/checkout@v2
32+
with:
33+
fetch-depth: 0
34+
35+
- name: lint
36+
uses: ChenCMD/datapack-linter@v1
37+
```
3838
3939
## 校閲ルールについて / Lint Rules
40-
41-
datapack linterは[Datapack Helper Plus](https://github.com/SPGoding/vscode-datapack-helper-plus)の実装を使用しており、
42-
リポジトリルートに配置された.vscode/setting.jsonを自動的に読み込み校閲ルールに適用します。
40+
datapack linterは[Datapack Helper Plus](https://github.com/SPGoding/vscode-datapack-helper-plus)に使用されている言語サーバーを使用しており、
41+
リポジトリルートに配置された`.vscode/setting.json`を自動的に読み込み校閲ルールに適用します。
4342

4443
このファイルはVSCodeでワークスペースの設定を変更すると生成されます。
4544

46-
The datapack linter uses the [Datapack Helper Plus](https://github.com/SPGoding/vscode-datapack-helper-plus) implementation, and the
47-
Automatically read the .vscode/setting.json file placed in the repository root and apply it to the review rules.
45+
The datapack linter uses the same language server used by [Datapack Helper Plus](https://github.com/SPGoding/vscode-datapack-helper-plus),
46+
and automatically reads `.vscode/setting.json` placed in the repository root and applies it to the review rules.
4847

4948
This file is generated when you change the workspace settings in VSCode.
49+
50+
## 入力 / Inputs
51+
| 名前 / Name | 想定する値 / Expect value | 必須 / Require | 概要 / About |
52+
| :----------: | :-----------------------: | :------------: | :------------------------------------------------------------------------------------------------------------------------------: |
53+
| outputDefine | リソースパス</br>Resourcepath | x | 入力されたリソースパスに一致するdefine/declareを表示します</br>Displays the define/declare that match the input resource path. |

0 commit comments

Comments
 (0)