Skip to content

Commit

Permalink
Update CHANGELOG.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
skryukov committed Nov 8, 2024
1 parent 40baff4 commit 358dea0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ and this project adheres to [Semantic Versioning].
## Added

- Add TypeScript verbatim module syntax support through `verbatim_module_syntax` config option ([@patvice])
- Add `typelizer:generate:refresh` command to clean output directory and regenerate all interfaces ([@patvice])
- Allow disabling Typelizer in Rails development with `DISABLE_TYPELIZER` environment variable to `true` ([@okuramasafumi])

## Fixes

- Do not override `Typelizer.dirs` in the railtie initializer ([@patvice])

## [0.1.5] - 2024-10-07

Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,11 +170,15 @@ See the [Configuration](#configuration) section for more options.

### Manual Generation

To manually generate TypeScript interfaces:
To manually generate TypeScript interfaces use one of the following commands:

```
$ rails typelizer:generate
```
```bash
# Generate new interfaces
rails typelizer:generate

# Clean output directory and regenerate all interfaces
rails typelizer:generate:refresh
````

### Automatic Generation in Development

Expand All @@ -186,7 +190,7 @@ Typelizer.listen = false

### Disabling Typelizer

Sometimes we want to use Typelizer only with manual generation. To disable Typelizer during development, we can set `DISABLE_TYPELIZER` environment variable to true. This doesn't affect manual generation.
Sometimes we want to use Typelizer only with manual generation. To disable Typelizer during development, we can set `DISABLE_TYPELIZER` environment variable to `true`. This doesn't affect manual generation.
## Configuration
Expand Down

0 comments on commit 358dea0

Please sign in to comment.