sewing_kit 0.122.1 → 0.127.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c35fc352107f7ecbb619a6009058eb25612d7d7efd4ed545799db01c7cc4f7c6
-  data.tar.gz: 50185d9023bcca21c9a7786eb4ccbe8cda808869f70233feae7aeeca41444d26
+  metadata.gz: cf1b908d92ccc28fb41b4e5a2161631455adee178681ee79146a23e76fbf17dc
+  data.tar.gz: '08f476ab5358c90db8f509f9265c281eafc0816af96a0fe70b2c189a3324fd6c'
 SHA512:
-  metadata.gz: 3da3fdace73c7260722287173e69c5c21efa9318503f02a6e56948a301e5bedb2747492003e262f6569d314ec63f4de6d07b65ac92a287c6a8aeae37c924afb4
-  data.tar.gz: 7d360097fbc3f400e21d7147c1f60d6735c6a5939073b8e7bbb721cd6aee12ce142a2c8b5c2d904120768d2746aeae859c8d0e08963b29d8149cd66a8dc461bc
+  metadata.gz: 26335f7c93bc27b3e6625acdf1f2d492e4b0d396c8164c30d5d56c96164e938a7a5421f0b6a4b8686c510b35fc8cbd81809f34e572498ea622e4ae65108ebb9e
+  data.tar.gz: 5a648ac926b7b50326f087a561b6de9266eef13d7576b32c0593d5f86695d0b7b9e258ae9aa1e52385eb732cc0c140f12b9a7ec2047d41c4ac0b4906a5d05659

data/README.md

@@ -19,6 +19,12 @@ yarn
 dev up
 ```
 
+### Run generator
+
+`rails generate sewing_kit:install`
+
+will generate a package.json file with common sewing-kit script tasks, default lint, format configuration; a sewing-kit configuration file, and other project default configurations.
+
 ### Add JavaScript
 
 sewing_kit looks for JavaScript in `app/ui/index.js`. The code in `index.js` (and any imported JS/CSS) will be built into a `main` bundle.
@@ -146,7 +152,7 @@ If sewing-kit makes a breaking change, this gem's minor version will be bumped t
 
 By moving everything into `package.json#dependencies`. This is necessary because Rails 5.2 prunes `devDependencies` during asset compilation.
 
-### How can I test a production verison of my changes?
+### How can I test a production version of my changes?
 
 Ideally, by deploying to a `staging` environment. If that is not possible, a production-like local development experience is available via:
 
@@ -155,6 +161,9 @@ NODE_ENV=production SK_SIMULATE_PRODUCTION=1 bundle exec rake assets:precompile
 NODE_ENV=production SK_SIMULATE_PRODUCTION=1 dev run
 ```
 
+If your application includes a node server (eg. uses `quilt_rails`), you can run the node server in a separate terminal window with:
+`bin/rails sewing_kit:server:start`
+
 Note:
 
 - Code changes will not be automatically recompiled in this state
@@ -176,3 +185,15 @@ SewingKit.configure do |config|
  config.log_level = :warn # may be `:inherit`, `:debug`, `:info`, `:warn`, or `:error`
 end
 ```
+
+### How do I run sewing-kit in debug mode?
+
+You can launch sewing-kit in debug mode by setting the `SK_DEBUG` environment flag.
+
+```bash
+$ SK_DEBUG=1 dev run
+```
+
+This runs your rails app with the sewing-kit development server in debug mode. This is useful for when you want to debug sewing-kit from a rails app.
+
+Tip: Install the [Node.js V8 --inspector Manager (NiM)](https://chrome.google.com/webstore/detail/nodejs-v8-inspector-manag/gnhhdgbaldcilmgcpfddgdbkhjohddkj?hl=en) Chrome extension. This will launch a chrome debugger automatically for you.

data/lib/generators/sewing_kit/USAGE

@@ -0,0 +1,5 @@
+Description:
+    This generator creates a sewing-kit config file.
+
+Example:
+    rails generate sewing_kit:install

data/lib/generators/sewing_kit/install_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SewingKit
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    class_option :skip_yarn, type: :boolean, default: false
+
+    desc "This generator creates a sewing-kit config file."
+
+    def initialize(args, *options)
+      @application_name = Rails.application.class.module_parent.to_s.underscore
+      super(args, *options)
+    end
+
+    def create_package_json
+      package_json_path = "package.json"
+
+      copy_file(package_json_path)
+      gsub_file(package_json_path, "\${application_name}", @application_name)
+    end
+
+    def install_js_dependencies
+      return if options.skip_yarn?
+
+      say "Installing react and types dependencies"
+      system("yarn add @shopify/sewing-kit")
+    end
+
+    def create_sk_config
+      sk_config_path = "config/sewing-kit.config.ts"
+
+      copy_file("sewing-kit.config.ts", sk_config_path)
+      gsub_file(sk_config_path, "\${application_name}", @application_name)
+    end
+
+    def create_config_files
+      copy_file("editorconfig", ".editorconfig")
+      copy_file("eslintignore", ".eslintignore")
+      copy_file("prettierignore", ".prettierignore")
+    end
+  end
+end

data/lib/generators/sewing_kit/templates/editorconfig

@@ -0,0 +1,15 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Markdown syntax specifies that trailing whitespaces can be meaningful,
+# so let’s not trim those. e.g. 2 trailing spaces = linebreak (<br />)
+# See https://daringfireball.net/projects/markdown/syntax#p
+[*.md]
+trim_trailing_whitespace = false

data/lib/generators/sewing_kit/templates/eslintignore

@@ -0,0 +1,4 @@
+node_modules
+build
+**/schema.graphql
+**/*.graphql.d.ts

data/lib/generators/sewing_kit/templates/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "${application_name}",
+  "private": true,
+  "sideEffects": false,
+  "scripts": {
+    "dev": "sewing-kit dev",
+    "check": "sewing-kit check",
+    "lint": "sewing-kit lint",
+    "type-check": "sewing-kit type-check",
+    "nuke": "sewing-kit nuke",
+    "test": "sewing-kit test"
+  },
+  "eslintConfig": {
+    "extends": [
+      "plugin:@shopify/typescript",
+      "plugin:@shopify/react",
+      "plugin:@shopify/prettier",
+      "plugin:@shopify/jest",
+      "plugin:@shopify/polaris",
+      "plugin:@shopify/graphql"
+    ]
+  },
+  "prettier": "@shopify/prettier-config",
+  "stylelint": {
+    "extends": [
+      "@shopify/stylelint-plugin/prettier"
+    ]
+  },
+  "resolutions": {
+    "babel-plugin-dynamic-import-node": "2.3.0"
+  }
+}

data/lib/generators/sewing_kit/templates/prettierignore

@@ -0,0 +1,10 @@
+package.json
+.runix
+.sewing-kit
+.dev
+node_modules
+tmp
+public
+*.svg
+*.graphql.d.ts
+build

data/lib/generators/sewing_kit/templates/sewing-kit.config.ts

@@ -0,0 +1,11 @@
+/* eslint-env node */
+
+import {Plugins, Env} from '@shopify/sewing-kit';
+
+export default function sewingKitConfig(plugins: Plugins, env: Env) {
+  return {
+    name: '${application_name}',
+    // remove cdn plugin when using dev
+    plugins: [plugins.cdn(env.isDevelopment ? 'http://localhost:8080/webpack/assets/' : undefined)],
+  };
+}

data/lib/sewing_kit/railtie.rb

@@ -1,18 +1,11 @@
 # frozen_string_literal: true
 require 'rails'
 require 'rails/railtie'
-begin
-  # Force assets:precompile to be defined before sewing_kit's railtie tries to
-  # extend it.
-  require "sprockets/railtie" if defined? Rails
-# rubocop:disable Lint/HandleExceptions
-rescue
-  #
-end
-# rubocop:enable Lint/HandleExceptions
+
 require 'sewing_kit/webpack/compiler'
 require 'sewing_kit/webpack/helper'
 require 'sewing_kit/webpack/dev'
+require 'sewing_kit/webpack/server'
 
 module SewingKit
   class Railtie < ::Rails::Railtie

data/lib/sewing_kit/version.rb

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

data/lib/sewing_kit/webpack/server.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SewingKit
+  module Webpack
+    class Server
+      class DefaultEntrypointMissing < StandardError
+        def initialize
+          super(
+            "Default entrypoint build/server/main.js is missing."
+          )
+        end
+      end
+
+      def start
+        raise DefaultEntrypointMissing unless File.exist?(default_entrypoint)
+
+        result = Kernel.system(
+          {},
+          *command,
+          chdir: Rails.root.to_s,
+          out: $stdout,
+          err: $stderr
+        )
+
+        unless result
+          puts "sewing_kit:server:start failed"
+          exit(1)
+        end
+
+        result
+      end
+
+      private
+
+      def command
+        command_list = [
+          'node',
+          default_entrypoint,
+        ].compact
+
+        command_list.join(' ')
+      end
+
+      def default_entrypoint
+        'build/server/main.js'
+      end
+    end
+  end
+end

data/lib/tasks/sewing_kit.rake

@@ -12,10 +12,20 @@ namespace :sewing_kit do
     compiler = SewingKit::Webpack::Compiler.new
     compiler.compile
   end
+
+  namespace :server do
+    desc "Starts the production server"
+    task start: :environment do
+      server = SewingKit::Webpack::Server.new
+      server.start
+    end
+  end
 end
 
-if Rake::Task.task_defined?('assets:precompile')
-  Rake::Task['assets:precompile'].enhance do
+if Rake::Task.task_defined?("assets:precompile")
+  Rake::Task["assets:precompile"].enhance do
     Rake::Task['sewing_kit:build'].invoke
   end
+else
+  Rake::Task.define_task("assets:precompile" => %w(sewing_kit:build))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.122.1
+  version: 0.127.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -102,6 +102,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/generators/sewing_kit/USAGE
+- lib/generators/sewing_kit/install_generator.rb
+- lib/generators/sewing_kit/templates/editorconfig
+- lib/generators/sewing_kit/templates/eslintignore
+- lib/generators/sewing_kit/templates/package.json
+- lib/generators/sewing_kit/templates/prettierignore
+- lib/generators/sewing_kit/templates/sewing-kit.config.ts
 - lib/hacks/user_agent_parser.rb
 - lib/sewing_kit.rb
 - lib/sewing_kit/configuration.rb
@@ -116,6 +123,7 @@ files:
 - lib/sewing_kit/webpack/manifest/development.rb
 - lib/sewing_kit/webpack/manifest/production.rb
 - lib/sewing_kit/webpack/manifest/test_with_no_assets.rb
+- lib/sewing_kit/webpack/server.rb
 - lib/sewing_kit/webpack/webpack.rb
 - lib/tasks/sewing_kit.rake
 homepage: https://github.com/Shopify/sewing-kit/tree/master/gems/sewing_kit