Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Don't run typelizer in dev mode at boot time (#13559)

Damian Legawiec5e63c5dc449e
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 28cf977686..f30e66fc41 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -195,7 +195,9 @@ Tests use [Vitest](https://vitest.dev/) with [MSW](https://mswjs.io/) for API mo
TypeScript types in `packages/sdk/src/types/generated/` are auto-generated from the Rails API serializers using [typelizer](https://github.com/skryukov/typelizer). To regenerate after changing serializers:
```bash
-cd backend/engines
+cd backend/engines/api
+mise install --yes # to install Ruby if you don't have it already
+bundle install # to install dependencies
bundle exec rake typelizer:generate
```
diff --git a/backend/engines/api/config/initializers/typelizer.rb b/backend/engines/api/config/initializers/typelizer.rb
index 635cdff88a..afab3c1485 100644
--- a/backend/engines/api/config/initializers/typelizer.rb
+++ b/backend/engines/api/config/initializers/typelizer.rb
@@ -1,3 +1,7 @@
+# Disable automatic type generation on boot — types are generated manually
+# via `bundle exec rake typelizer:generate`. Set ENABLE_TYPELIZER=1 to enable.
+ENV["DISABLE_TYPELIZER"] ||= "true" unless ENV["ENABLE_TYPELIZER"]
+
Typelizer.configure do |config|
api_root = Spree::Api::Engine.root
@@ -16,4 +20,6 @@ Typelizer.configure do |config|
.sub(/Serializer\z/, '')
name
}
+
+ config.listen = false # https://github.com/skryukov/typelizer?tab=readme-ov-file#automatic-generation-in-development
end
diff --git a/docs/developer/contributing/developing-spree.mdx b/docs/developer/contributing/developing-spree.mdx
index cde7d23c1f..fd594dbddb 100644
--- a/docs/developer/contributing/developing-spree.mdx
+++ b/docs/developer/contributing/developing-spree.mdx
@@ -200,7 +200,9 @@ Tests use [Vitest](https://vitest.dev/) with [MSW](https://mswjs.io/) for API mo
TypeScript types in `packages/sdk/src/types/generated/` are auto-generated from the Rails API serializers using [typelizer](https://github.com/skryukov/typelizer). To regenerate after changing serializers:
```bash
- cd backend/engines
+ cd backend/engines/api
+ mise install --yes # to install Ruby if you don't have it already
+ bundle install # to install dependencies
bundle exec rake typelizer:generate
```