sewing_kit 0.95.4 → 0.96.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8847792f430ca9ff0b5d9e2da35b701392636af48ac0435f9e82f816e4d9b385
-  data.tar.gz: cb61d56de21e9ae5e4c937313d2acfc213e10790cb8139c5b3e432ec76759f25
+  metadata.gz: f4c9a4d05fadcda6b90c207bb14c7652c1e16725be38391f53ba66b2af982550
+  data.tar.gz: 7848dba3af77dcf21232061744a33afe61a7e6ed5a67a46ffdaf5c0ce04c7fb1
 SHA512:
-  metadata.gz: f956eb534703a3b6f1bc57013be323209fec34ff1d34377757067cf42b6364ed399b88e37fa8db81401cc63909c80efebf68077e08cfdfdd7c1c93745d648f3a
-  data.tar.gz: 7dd03739b8f4677e9e5e55834af4481027a4b23a85413bfbdb9d46f7122455956e04a95290ba71378aa056e253c5ee29f19b8f1ed11c178b9c2c0c49e33db6b4
+  metadata.gz: 820de0241ba40a9735a6aca803b2c74adda0ae2575541e5975a0ea28adb3c9c660564e50f184cb39fbb4e51828f29e00e8815acdd6a863a89b5c29a79ccaff34
+  data.tar.gz: 247dda76a13df81da377d05810508abb6d722e95809d462c4679c734173a3d1b86760ac4f75aab2bb36b78e677da776dd57b6d2af822faaa6c112e19642b64fd

data/README.md

@@ -4,12 +4,6 @@ Zero configuration, high performance front end development at organization scale
 
 `sewing_kit` facilitates legacy Rails integration using ERB tags. For a more complete modern stack with performance-as-a-feature, consider [quilt_rails](https://github.com/Shopify/quilt/tree/master/gems/quilt_rails). For details of the `sewing-kit` node package's configuration and usage, see the [sewing-kit README](/README.md).
 
-## Use `quilt_rails` for React Server-Side-Rendering
-
-For React applications with a Rails backend, the best-practice for user-experience is server-side-rendering (SSR). **For building out React applications using SSR and Sewing-Kit, see [`quilt_rails`](https://github.com/Shopify/quilt/tree/master/gems/quilt_rails)**.
-
-If you are building a conventional Rails application using `.erb` files and just want modern JavaScript / TypeScript compilation, continue reading this document.
-
 ## Quick Start
 
 Create a Rails project using `dev init` then:
@@ -54,6 +48,28 @@ The `main` bundle is imported into `erb` files using Rails helpers:
            └─- application.html.erb (must link to JS / CSS using sewing_kit_script_tag / sewing_kit_link_tag
 ```
 
+## Configuring development mode
+
+`SewingKit.configure` provides a `development_options` attribute that adjusts the behaviour of sewing-kit's development mode. See [the `dev` command's documentation](/docs/commands/dev.md) for a full list of options.
+
+### Usage
+
+```rb
+# config/initializers/sewing_kit.rb
+SewingKit.configure do |config|
+  # Disable hot module reloading
+  config.development_options[:hot] = false
+
+  # Launch development mode with extra memory (helpful if source maps are
+  # occupying more than Node's default 1.4GB heap allocation)
+  config.development_options[:heap] = 4000
+
+  # Disable source maps (very large apps may need to builds sans source maps to
+  # reduce development mode's memory usage)
+  config.development_options[:source_maps] = false
+end
+```
+
 ## Testing the front end
 
 For fast tests with consistent results, test front-end components using Jest instead of Rails integration tests.
@@ -79,7 +95,7 @@ The default behaviour is equivalent to this configuration:
 ```rb
 # config/initializers/sewing_kit.rb
 SewingKit.configure do |config|
-  config.test_manifest_mode = :return_no_asets
+  config.test_manifest_mode = :return_no_assets
 end
 ```
 

data/lib/sewing_kit/configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module SewingKit
   class Configuration
-    attr_accessor :build_options, :dev_server_sewing_kit_bin, :manifest_name,
+    attr_accessor :development_options, :build_options, :dev_server_sewing_kit_bin, :manifest_name,
       :manifest_path
     attr_reader :test_manifest_mode, :log_level
 
@@ -24,6 +24,7 @@ module SewingKit
 
     def initialize
       @build_options = nil
+      @development_options = {}
       @manifest_name = 'sewing-kit-manifest.json'
       @manifest_path = nil
       @dev_server_sewing_kit_bin = 'node_modules/.bin/sewing-kit'

data/lib/sewing_kit/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SewingKit
-  VERSION = "0.95.4"
+  VERSION = "0.96.0"
 end

data/lib/sewing_kit/webpack/dev.rb

@@ -54,7 +54,7 @@ module SewingKit
           'dev',
           '--logLevel',
           log_level,
-        ]
+        ].concat(options)
 
         if debug_mode?
           command_list.push(['--debug'])
@@ -64,7 +64,12 @@ module SewingKit
       end
 
       def sewing_kit_bin
-        bin = SewingKit.configuration.dev_server_sewing_kit_bin
+        heap_size = SewingKit.configuration.development_options[:heap]
+        heap_config = if heap_size
+          "node --max-old-space-size=#{heap_size} "
+        end
+
+        bin = "#{heap_config}#{SewingKit.configuration.dev_server_sewing_kit_bin}"
         raise NodeSewingKitNotInstalled unless File.exist?(bin)
         bin
       end
@@ -77,6 +82,15 @@ module SewingKit
         end
       end
 
+      def options
+        development_options = SewingKit.configuration.development_options
+        return [] unless development_options
+
+        development_options
+          .reject { |key| key == :heap }
+          .map { |key, value| ["--#{key}", value] }.flatten
+      end
+
       def log_level_from_rails
         case Rails.logger.level
         when 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.95.4
+  version: 0.96.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties