From 358dea01a4813a0ac4951fb08876933d06395c0d Mon Sep 17 00:00:00 2001 From: Svyatoslav Kryukov Date: Fri, 8 Nov 2024 09:27:03 +0300 Subject: [PATCH] Update CHANGELOG.md and README.md --- CHANGELOG.md | 6 ++++++ README.md | 14 +++++++++----- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ffa524..e5a6ee8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index c86a366..3b610e6 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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