sewing_kit 0.127.0 → 0.128.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1b908d92ccc28fb41b4e5a2161631455adee178681ee79146a23e76fbf17dc
-  data.tar.gz: '08f476ab5358c90db8f509f9265c281eafc0816af96a0fe70b2c189a3324fd6c'
+  metadata.gz: a461122bbd1f59afece53f1695188abeb57f7a70bf397c9871a1389a5c3dace0
+  data.tar.gz: 606ece89a71cf2748dd13bf2a1884e428d41365cbdabb9fe98dbbe2c7184e143
 SHA512:
-  metadata.gz: 26335f7c93bc27b3e6625acdf1f2d492e4b0d396c8164c30d5d56c96164e938a7a5421f0b6a4b8686c510b35fc8cbd81809f34e572498ea622e4ae65108ebb9e
-  data.tar.gz: 5a648ac926b7b50326f087a561b6de9266eef13d7576b32c0593d5f86695d0b7b9e258ae9aa1e52385eb732cc0c140f12b9a7ec2047d41c4ac0b4906a5d05659
+  metadata.gz: 9725a50c0872da10cb36d7882d446d9606177af40055bd309c7874f78de953768c201aacaf02853ce9b83f8ed6c80462e3df81552a225d5c1727e66a64e2df5a
+  data.tar.gz: 14f2b69ef3a1afc0b2cc99275933dd219767dcf9784026fd79d01d3b33c52f2a6adc36fcc2d3b88fc97dad481293f34cc9959e0400c59cf3ee71590721f468a4

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.128.0"
 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.127.0
+  version: 0.128.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -106,9 +106,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, 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)],
-  };
-}