sewing_kit 0.124.0 → 0.129.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a05925e10dba45f77fcf36f23bf1f0d777ab6993f7994f3b216169dde31dd7
-  data.tar.gz: ca891a9517eaca9dbcacef5c838c626e587a1111f9a58105b12abf3e8adbcab4
+  metadata.gz: 192f93794571de06b57d5125eec9da37d1331c3dbb47a2c530e29d6f4693cb47
+  data.tar.gz: d06a650795388f99d0680e007e7402b8d964562be69610aa92032e9e24abdac1
 SHA512:
-  metadata.gz: b297f9c114a00b3925933df21d8109d04e0123b6234790c25bc136e5393543f1f8cc04d683b47f86d0999c7bf344a679fe9cb111e5add3f75e5a645d4bef3940
-  data.tar.gz: '06347349fc9a1f1c5ef451205d9c28a7005e528282540f42c43e605ee4c6112d51c881171831100551ab793e30210b4c4d9e8075fd08d67ecfc417a5be44ea73'
+  metadata.gz: 773c4e613be0301501b9d8e31b12bce81027f7aaf39aabafa87c07a5a76430498b6c39d81801f4af44b1ea48e47cf127edddca88e7c2031dc22c44ffc202fe58
+  data.tar.gz: 056bdc1ff814b70f35ffac31bcba3b7d95560002437272f8e615ae93d8e6a4bdcb49bb08b0d8db9961c99f88488ff3cd616cb991b044c125578ca41f660455de

data/README.md

@@ -2,7 +2,11 @@
 
 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).
+`sewing_kit` can be used in a Rails application instead of [Webpacker](https://github.com/rails/webpacker), allowing to embed bundled/compiled javascript in erb pages.
+
+For a more complete and modern stack with performance-as-a-feature, consider [quilt_rails](https://github.com/Shopify/quilt/tree/master/gems/quilt_rails).
+
+For details on configuring and usage of the `sewing-kit` node package, see the [sewing-kit README](/README.md).
 
 ## Quick Start
 

data/lib/generators/sewing_kit/install_generator.rb

@@ -4,31 +4,58 @@ module SewingKit
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('templates', __dir__)
 
-    desc "This generator creates a sewing-kit config file."
+    desc "Adds the configuration files for a sewing-kit powered front-end."
 
-    def initialize(args, *options)
-      @application_name = Rails.application.class.module_parent.to_s.underscore
-      super(args, *options)
-    end
+    class_option :skip_yarn, type: :boolean, default: false
+    class_option :javascript_path, type: :string, default: 'app/ui'
 
-    def create_package_json
-      package_json_path = "package.json"
+    # We don't specify a default here because we want to fallback dynamically
+    class_option :uses_dev, type: :boolean
 
-      copy_file(package_json_path)
-      gsub_file(package_json_path, "\${application_name}", @application_name)
-    end
+    def initialize(args, *opts)
+      super(args, *opts)
 
-    def create_sk_config
-      sk_config_path = "config/sewing-kit.config.ts"
+      @application_name = Project.app_name
+      @javascript_path = options[:javascript_path]
 
-      copy_file("sewing-kit.config.ts", sk_config_path)
-      gsub_file(sk_config_path, "\${application_name}", @application_name)
+      if Project.uses_webpacker?
+        warn("
+          WARNING: We've detected you currently have webpacker config at config/webpacker.yml.
+          You may experience conflicts between sewing-kit and webpacker's behaviour as build tools.
+          If your app was made with `rails new`, try rerunning it with `--skip-webpack-install --skip-javascript`
+        ")
+      end
     end
 
     def create_config_files
+      say("Creating JS tooling config files")
       copy_file("editorconfig", ".editorconfig")
       copy_file("eslintignore", ".eslintignore")
       copy_file("prettierignore", ".prettierignore")
+      template("package.json.erb", "package.json")
+      template("tsconfig.json.erb", "tsconfig.json")
+      template("sewing-kit.config.ts.erb", "config/sewing-kit.config.ts")
+    end
+
+    def install_js_dependencies
+      return if options.skip_yarn?
+      say("Installing javascript dependencies")
+      system("yarn add @shopify/sewing-kit")
+      system("yarn add typescript")
+    end
+
+    class Project
+      def self.app_name
+        Rails.application.class.module_parent.to_s.underscore
+      end
+
+      def self.uses_dev?
+        File.exist?('dev.yml')
+      end
+
+      def self.uses_webpacker?
+        File.exist?('config/webpacker.yml')
+      end
     end
   end
 end

data/lib/generators/sewing_kit/templates/eslintignore

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

data/lib/generators/sewing_kit/templates/{package.json → package.json.erb}

@@ -1,5 +1,5 @@
 {
-  "name": "${application_name}",
+  "name": "<%= @application_name %>",
   "private": true,
   "sideEffects": false,
   "scripts": {
@@ -16,7 +16,8 @@
       "plugin:@shopify/react",
       "plugin:@shopify/prettier",
       "plugin:@shopify/jest",
-      "plugin:@shopify/polaris"
+      "plugin:@shopify/polaris",
+      "plugin:@shopify/graphql"
     ]
   },
   "prettier": "@shopify/prettier-config",

data/lib/generators/sewing_kit/templates/prettierignore

@@ -1,7 +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.erb

@@ -0,0 +1,47 @@
+/* eslint-env node */
+import {resolve} from 'path';
+
+import {Plugins, Env} from '@shopify/sewing-kit';
+
+const ROOT_PATH = resolve(__dirname, '..');
+
+export default function sewingKitConfig(plugins: Plugins, env: Env) {
+  return {
+    name: '<%= @application_name %>',
+    plugins: [
+      plugins.paths({
+        // Determines where the root directory for front-end code is
+        app: resolve(ROOT_PATH, '<%= @javascript_path %>'),
+        // Determines where test setup should go for front-end code
+        tests: resolve(ROOT_PATH, '<%= @javascript_path %>', 'tests'),
+      }),
+
+<% unless @uses_dev %>
+      // Sets up the app to get its assets from the default webpack endpoint in development.
+      // You will need to change this to use your actual production cdn to get it working in production.
+      // NOTE: If you are using dev and shopify-cloud gem you can delete this.
+      plugins.cdn(
+        env.isDevelopment ? 'http://localhost:8080/webpack/assets/' : undefined,
+      ),
+<% end %>
+      // Sets up sewing-kit to generate type definitions for GraphQL using the given schema(s)
+      // Uncomment the following if you are using GraphQL and make sure the path points to your generated schema
+      // plugins.graphql({
+      //   schema: resolve(__dirname, '..', 'app', 'graphql', 'schema.graphql'),
+      // }),
+
+      // Sets up sass mixins to be automatically imported.
+      // Uncomment if you are using Polaris and want access to the sass mixins in your custom SCSS
+      // plugins.sass({
+      //   autoInclude: [
+      //     path.join(
+      //      __dirname,
+      //      'node_modules/@shopify/polaris/dist/styles/_public-api.scss',
+      //    ),
+      //   ],
+      // }),
+
+      // configure additional sewing-kit plugins here
+    ],
+  };
+}

data/lib/generators/sewing_kit/templates/tsconfig.json.erb

@@ -0,0 +1,11 @@
+{
+  "extends": "@shopify/typescript-configs/application.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "paths": {
+      "*": ["<%= @javascript_path %>*"]
+    }
+  },
+  "include": ["./config/*.ts", "./<%= @javascript_path %>**/*"]
+}

data/lib/sewing_kit/version.rb

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

data/lib/sewing_kit/webpack/compiler.rb

@@ -8,7 +8,7 @@ module SewingKit
         def initialize
           super(
             "nodejs is not installed.  " \
-            "Try creating a `.buildpack` file in the root of the project with following content:
+            "Try creating a `.buildpacks` file in the root of the project with following content:
 
             https://github.com/heroku/heroku-buildpack-nodejs.git
             https://github.com/heroku/heroku-buildpack-ruby.git

data/lib/sewing_kit/webpack/dev.rb

@@ -39,13 +39,13 @@ module SewingKit
 
       def handle_exit
         return if $ERROR_INFO.nil?
-        Process.kill 'SIGTERM', pid
+        Process.kill('SIGTERM', pid)
       rescue Errno::ESRCH
         nil
       end
 
       def detach
-        Process.detach pid
+        Process.detach(pid)
       end
 
       def command
@@ -54,7 +54,7 @@ module SewingKit
           heap_config,
           sewing_kit_bin,
           'dev',
-          '--logLevel',
+          '--log-level',
           log_level,
         ].compact.concat(options)
 

data/lib/sewing_kit/webpack/helper.rb

@@ -16,7 +16,7 @@ module SewingKit
 
         assets = SewingKit::Webpack::Manifest.asset_dependencies(entrypoint_name, request.user_agent)
 
-        raise UnknownAssetError, "#{entrypoint_name} was not found in manifest." if raise_unknown_error? assets
+        raise UnknownAssetError, "#{entrypoint_name} was not found in manifest." if raise_unknown_error?(assets)
         return [] unless assets && assets[extension]
 
         dependencies = assets[extension]
@@ -56,7 +56,7 @@ module SewingKit
       private
 
       def create_asset_tag(tag_type, asset, tag_options)
-        raise ArgumentError, "Invalid tag type: #{tag_type}" unless [:script, :link].include? tag_type
+        raise ArgumentError, "Invalid tag type: #{tag_type}" unless [:script, :link].include?(tag_type)
 
         options = tag_options.clone
 

data/lib/sewing_kit/webpack/manifest.rb

@@ -24,14 +24,14 @@ module SewingKit
       # Raised if the node-generated manifest cannot be read from the filesystem.
       class ManifestLoadError < StandardError
         def initialize(path, cause)
-          super "Could not load manifest from #{path} (original error #{cause})"
+          super("Could not load manifest from #{path} (original error #{cause})")
         end
       end
 
       # Raised if the node-generated manifest returns unparseable JSON.
       class ManifestParseError < StandardError
         def initialize(cause)
-          super "Could not parse manifest JSON (original error #{cause})"
+          super("Could not parse manifest JSON (original error #{cause})")
         end
       end
 

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

@@ -43,7 +43,9 @@ module SewingKit
               return normalize_metadata(result)
             end
           rescue => e
-            Rails.logger.warn "[sewing_kit] could not read manifest from #{@metadata_path}; falling back to node.  #{e}"
+            Rails.logger.warn(
+              "[sewing_kit] could not read manifest from #{@metadata_path}; falling back to node.  #{e}"
+            )
             @metadata_path = nil
           end
 
@@ -81,8 +83,8 @@ module SewingKit
 
       class OnlyUseInProductionError < StandardError
         def initialize
-          super "The SewingKit::Webpack::Manifest#manifest is intended "\
-          "for deploying assets to a CDN. Do not use it in development."
+          super("The SewingKit::Webpack::Manifest#manifest is intended "\
+          "for deploying assets to a CDN. Do not use it in development.")
         end
       end
     end

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

@@ -8,8 +8,8 @@ module SewingKit
     class Manifest
       class Production < Base
         def initialize
+          super
           @cache_by_user_agent = {}
-          @metadata = nil
           @metadata_path = nil
         end
 

data/lib/tasks/sewing_kit.rake

@@ -4,7 +4,7 @@ TEMPLATE_PATH = File.expand_path("../install/template.rb", File.dirname(__FILE__
 namespace :sewing_kit do
   desc "Install all of Shopify’s modern FED tooling"
   task :install do
-    exec "./bin/rails app:template LOCATION=#{TEMPLATE_PATH}"
+    exec "bundle exec rails generate sewing_kit:install"
   end
 
   desc "Build webpack asset bundles"
@@ -29,3 +29,11 @@ if Rake::Task.task_defined?("assets:precompile")
 else
   Rake::Task.define_task("assets:precompile" => %w(sewing_kit:build))
 end
+
+unless Rake::Task.task_defined?('assets:clean')
+  namespace :assets do
+    task :clean do
+      # This empty task is to offer the same interface than sprockets and webpacker
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.124.0
+  version: 0.129.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: 0.89.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: 0.89.1
 - !ruby/object:Gem::Dependency
   name: rubocop-git
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 description: 
 email:
 - chris.sauve@shopify.com
@@ -106,9 +120,10 @@ files:
 - 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/package.json.erb
 - lib/generators/sewing_kit/templates/prettierignore
-- lib/generators/sewing_kit/templates/sewing-kit.config.ts
+- lib/generators/sewing_kit/templates/sewing-kit.config.ts.erb
+- lib/generators/sewing_kit/templates/tsconfig.json.erb
 - lib/hacks/user_agent_parser.rb
 - lib/sewing_kit.rb
 - lib/sewing_kit/configuration.rb

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

@@ -1,11 +0,0 @@
-/* eslint-env node */
-
-import {Plugins} from '@shopify/sewing-kit';
-
-export default function sewingKitConfig(plugins: Plugins) {
-  return {
-    name: "${application_name}",
-    plugins: [
-    ],
-  };
-}