Skip to content

Commit c750f6d

Browse files
committed
Add development notes to readme
1 parent 0f0152f commit c750f6d

3 files changed

Lines changed: 15 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
/node_modules/
22
/coverage/
33
/src/generated/
4+
/_work/

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,16 @@ jobs:
144144

145145
> [!Note]
146146
> This procedure only works reasonably well if `patch-validator` is only called once in the workflow file.
147+
148+
## Development
149+
150+
This project uses automatic linting, formatting, and tests.
151+
152+
Before setting up the dependencies with `npm ci`, an installation of Java is required for `antlr4ng-cli`.
153+
The correct versions are best installed with [`antlr4-tools`](https://github.com/antlr/antlr4-tools).
154+
In brief, run the following commands within a Python 3 installation/environment.
155+
156+
```bash
157+
pip install antlr4-tools
158+
antlr4
159+
```

tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@
1515
"skipLibCheck": true,
1616
"newLine": "lf"
1717
},
18-
"exclude": ["./dist", "./node_modules", "./__tests__", "./coverage"]
18+
"exclude": ["./dist", "./node_modules", "./__tests__", "./coverage", "./_work"]
1919
}

0 commit comments

Comments
 (0)