sewing_kit 0.27.1 → 0.27.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da99c11ba4fecb1a48b27b007a345bde04c51506
-  data.tar.gz: 4c3d3cd7fb181aab782fc0c89e5f8a103e51efd7
+  metadata.gz: 82b56d2fde25a89c489676d3726d426d70de12bb
+  data.tar.gz: 45fb02c608830031960c3ae278f26048fe146412
 SHA512:
-  metadata.gz: 6d1a62785eb69e5ffc8a6f78ab513f09369dd491464aa1334644699f827cb4e684cbeb8423ccc9ecb02e6dbb58cf3b29275c9a14db6c877c2586b057394bff85
-  data.tar.gz: 8ca779ed88cb21203a797ee6c14d587090499db5906242801a0d5ee6ebbfad3751a2105be7952b632001772697039d6cc1ec748547b0e932dc622bd02df693d1
+  metadata.gz: 75023c4bf3810f14c5269b5e73e00cb73d2bf8262c71301ac54024408dae172333b2d71aec38bd70b43f5231fe076fb324add22206583b6a96b1cf53ccf0e99a
+  data.tar.gz: 5ff0c63902bae55d5ff14dbf59962d1bac7964ea5f2a163772a7b996779f7a0befa3b853fc502b018a479ca21118d6ae00e2e4523e412653222f546c8f3a88f9

data/README.md

@@ -82,8 +82,19 @@ A typical Polaris app will use React to render views and components.  The follow
                     └── Home.js
 ```
 
+## Transitioning from sprockets-commoner
+It is currently not recommended to use `sprockets-commoner` and `sewing_kit` in the same project.
+Minimally, it is required that the project does not have its own `babel-*` libraries that `sewing-kit` currently has as [dependencies](https://github.com/Shopify/sewing-kit/blob/master/package.json#L97~L102).
+
+## Build Pipeline Gotchas
+While sewing-kit is a dev dependency, it is needed for production builds. This means that the production build will break if the environment variable `YARN_INSTALL` is set to true, because it will prevent `devDependencies` from being installed.
+
+To work around this in Buildkite, set `YARN_PRODUCTION=false` in the Environment Variables section of Pipeline Settings:
+
+![image](https://user-images.githubusercontent.com/2354121/36445473-64f6c4a2-164c-11e8-90fd-4e1b7835d7a2.png)
+
 ## React Boilerplate
-* Create a React app in `app/ui/App.js` ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/ui/App.js#L11))
+* Create a React app in `app/ui/App.js` ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/ui/App.jsx))
 * In an `erb` view, add a placeholder for React content ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/views/home/index.html.erb#L4))
 * In `index.js`, render a React component into the placeholder element ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/ui/index.js))
 * Use `sewing_kit_script_tag`/`sewing_kit_link_tag` helpers to link erb/js ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/views/layouts/application.html.erb#L8))

data/lib/sewing_kit/version.rb

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

data/lib/sewing_kit/webpack/manifest.rb

@@ -25,6 +25,29 @@ module SewingKit
         end
       end
 
+      class NodeSewingKitManifestMissing < StandardError
+        def initialize(mode, node_error_message)
+          env_message = if 'production' == mode
+            "\nIf this is a container build:\n" \
+            "  - Verify that sewing_kit compilation succeeded before deployment\n" \
+            "  - Verify that public/bundles/sewing-kit.manifest.json was uploaded\n" \
+            "  - Verify that public/bundles/sewing-kit.manifest.json exists in the container\n" \
+          else
+            "\nPossible next steps:\n" \
+            " - If the server is still starting up, wait for a 'Compiled with latest changes' message" \
+            " then refresh your browser\n" \
+            " - Check the development console for compilation errors\n" \
+            " - Restart your development server\n"
+          end
+
+          super(
+            "Could not fetch the sewing-kit manifest 🙀  " \
+            "#{env_message}\n" \
+            "Original error #{node_error_message}"
+          )
+        end
+      end
+
       # Raised if the node-generated manifest cannot be read from the filesystem.
       class ManifestLoadError < StandardError
         def initialize(path, cause)

data/lib/sewing_kit/webpack/manifest/base.rb

@@ -22,11 +22,13 @@ module SewingKit
 
         def load_metadata_from_node
           begin
-            stdout, * = Open3.capture3('node_modules/.bin/sewing-kit', 'manifest', "--mode=#{mode}")
+            stdout, stderr, status = Open3.capture3('node_modules/.bin/sewing-kit', 'manifest', "--mode=#{mode}")
           rescue => e
             raise NodeSewingKitNotRunnable.new(mode, e)
           end
 
+          raise NodeSewingKitManifestMissing.new(mode, stderr) unless status.success?
+
           begin
             JSON.parse(stdout)
           rescue => e

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.27.1
+  version: 0.27.2
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties