sewing_kit 0.127.0 → 0.130.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1b908d92ccc28fb41b4e5a2161631455adee178681ee79146a23e76fbf17dc
-  data.tar.gz: '08f476ab5358c90db8f509f9265c281eafc0816af96a0fe70b2c189a3324fd6c'
+  metadata.gz: 0fdcc87f6ded6c59b84ea7be01819dc8ffa127cff77907535db27a3b1129b734
+  data.tar.gz: e8ed84b2243a54ce366f86529911695c6fb94339f2315b3289052b5a1d5ed392
 SHA512:
-  metadata.gz: 26335f7c93bc27b3e6625acdf1f2d492e4b0d396c8164c30d5d56c96164e938a7a5421f0b6a4b8686c510b35fc8cbd81809f34e572498ea622e4ae65108ebb9e
-  data.tar.gz: 5a648ac926b7b50326f087a561b6de9266eef13d7576b32c0593d5f86695d0b7b9e258ae9aa1e52385eb732cc0c140f12b9a7ec2047d41c4ac0b4906a5d05659
+  metadata.gz: 962c94d0fbceadae0b190b957b832e5f92a0994a3e47f15671bfe98ff460e076eabaa4556c82929cf5e04df660aa849bc60decb570090c351456564e1cb80d3c
+  data.tar.gz: 720383ee164b982057f814e599467af8ab387ea1e1bbf8b463f578afaaf427316b23e986f5e38ac83e9eaa9306fa05e3e86217fffae54dc4a00c30aea33aeded

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
 
@@ -99,13 +103,13 @@ end
 
 For fast tests with consistent results, test front-end components using Jest instead of Rails integration tests.
 
-Use [`sewing-kit test`](https://github.com/Shopify/sewing-kit/blob/master/docs/commands/test.md#L3) to run all `.test.tsx` files in the `app/ui` directory. [Jest](https://jestjs.io) is used as a test runner, with customization available via [its sewing-kit plugin](https://github.com/Shopify/sewing-kit/blob/master/docs/plugins/jest.md).
+Use [`sewing-kit test`](https://github.com/Shopify/sewing-kit/blob/main/docs/commands/test.md#L3) to run all `.test.tsx` files in the `app/ui` directory. [Jest](https://jestjs.io) is used as a test runner, with customization available via [its sewing-kit plugin](https://github.com/Shopify/sewing-kit/blob/main/docs/plugins/jest.md).
 
 ### Customizing the test environment
 
 Often you will want to hook up custom polyfills, global mocks, or other logic that needs to run either before the initialization of the test environment, or once for each test suite.
 
-By default, sewing-kit will look for such test setup files under `/app/ui/tests`. Check out the [documentation](https://github.com/Shopify/sewing-kit/blob/master/docs/plugins/jest.md#smart-defaults) for more details.
+By default, sewing-kit will look for such test setup files under `/app/ui/tests`. Check out the [documentation](https://github.com/Shopify/sewing-kit/blob/main/docs/plugins/jest.md#smart-defaults) for more details.
 
 ### Rails tests
 

data/lib/generators/sewing_kit/install_generator.rb

@@ -3,40 +3,59 @@
 module SewingKit
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('templates', __dir__)
+
+    desc "Adds the configuration files for a sewing-kit powered front-end."
+
     class_option :skip_yarn, type: :boolean, default: false
+    class_option :javascript_path, type: :string, default: 'app/ui'
 
-    desc "This generator creates a sewing-kit config file."
+    # We don't specify a default here because we want to fallback dynamically
+    class_option :uses_dev, type: :boolean
 
-    def initialize(args, *options)
-      @application_name = Rails.application.class.module_parent.to_s.underscore
-      super(args, *options)
-    end
+    def initialize(args, *opts)
+      super(args, *opts)
 
-    def create_package_json
-      package_json_path = "package.json"
+      @application_name = Project.app_name
+      @javascript_path = options[:javascript_path]
 
-      copy_file(package_json_path)
-      gsub_file(package_json_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 react and types dependencies"
+      say("Installing javascript dependencies")
       system("yarn add @shopify/sewing-kit")
+      system("yarn add typescript")
     end
 
-    def create_sk_config
-      sk_config_path = "config/sewing-kit.config.ts"
+    class Project
+      def self.app_name
+        Rails.application.class.module_parent.to_s.underscore
+      end
 
-      copy_file("sewing-kit.config.ts", sk_config_path)
-      gsub_file(sk_config_path, "\${application_name}", @application_name)
-    end
+      def self.uses_dev?
+        File.exist?('dev.yml')
+      end
 
-    def create_config_files
-      copy_file("editorconfig", ".editorconfig")
-      copy_file("eslintignore", ".eslintignore")
-      copy_file("prettierignore", ".prettierignore")
+      def self.uses_webpacker?
+        File.exist?('config/webpacker.yml')
+      end
     end
   end
 end

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": {

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.127.0"
+  VERSION = "0.130.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

@@ -29,6 +29,7 @@ module SewingKit
             'NODE_ENV' => 'development',
             'BLUEBIRD_DEBUG' => '0',
             'BLUEBIRD_LONG_STACK_TRACES' => '0',
+            'FORCE_COLOR' => 'true',
           },
           command,
           chdir: Rails.root.to_s,
@@ -39,13 +40,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 +55,7 @@ module SewingKit
           heap_config,
           sewing_kit_bin,
           'dev',
-          '--logLevel',
+          '--log-level',
           log_level,
         ].compact.concat(options)
 

data/lib/sewing_kit/webpack/helper.rb

@@ -10,22 +10,19 @@ module SewingKit
 
       Asset = Struct.new(:path, :integrity)
 
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def sewing_kit_assets(entrypoint_name, extension: 'js')
         return '' unless entrypoint_name.present?
 
         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]
-        dependencies.unshift(dll_asset) if serve_development_assets? && extension == 'js'
         dependencies.map do |raw_asset|
           Asset.new(raw_asset['path'], raw_asset['integrity'])
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       def sewing_kit_link_tag(*assets)
         options = assets.extract_options!
@@ -56,7 +53,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
 
@@ -82,10 +79,6 @@ module SewingKit
       def raise_unknown_error?(assets)
         assets.nil? && serve_development_assets?
       end
-
-      def dll_asset
-        Asset.new('/webpack/assets/dll/vendor.js')
-      end
     end
   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/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/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.127.0
+  version: 0.130.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2022-04-01 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
@@ -126,11 +141,11 @@ files:
 - 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
+homepage: https://github.com/Shopify/sewing-kit/tree/main/gems/sewing_kit
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/Shopify/sewing-kit/blob/master/gems/sewing_kit/CHANGELOG.md
+  changelog_uri: https://github.com/Shopify/sewing-kit/blob/main/gems/sewing_kit/CHANGELOG.md
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -147,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Shopify's modern front-end tooling, nicely packaged for Rails

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

@@ -1,11 +0,0 @@
-/* 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)],
-  };
-}