Skip to content

Commit

Permalink
docs(tools): update style guide with generation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
Hotell committed Jul 18, 2023
1 parent 8ac900b commit 13d9247
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion tools/STYLE-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Integration tests for the generator as a whole.

TypeScript interface that matches `schema.json`. You can generate this from the json file by running:

- `npx json-schema-to-typescript -i tools/generators/<generator-name>/schema.json -o tools/generators/<generator-name>/schema.ts`
- `npx json-schema-to-typescript -i tools/generators/<generator-name>/schema.json -o tools/generators/<generator-name>/schema.ts --additionalProperties false`

**`schema.json`**

Expand All @@ -62,6 +62,12 @@ Provides a description of the generator, available options, validation informati

Generator documentation - about + API

Run following to update TOC:

```sh
npx markdown-toc --bullets "-" -i tools/generators/<generator-name>/README.md
```

ℹ️ _NOTE: In future, this will be automatically generated._

### Bootstrap new generator
Expand Down

0 comments on commit 13d9247

Please sign in to comment.