sewing_kit 0.122.1 → 0.123.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c35fc352107f7ecbb619a6009058eb25612d7d7efd4ed545799db01c7cc4f7c6
-  data.tar.gz: 50185d9023bcca21c9a7786eb4ccbe8cda808869f70233feae7aeeca41444d26
+  metadata.gz: ad8a311afdf9ea5efa60527866ac02247e3c91189a636aa78c9dde602f304e0f
+  data.tar.gz: 65e3897e31a73ae2ec5b3756672a35ccfda44df1d3cffa22a7473193aaf40b3a
 SHA512:
-  metadata.gz: 3da3fdace73c7260722287173e69c5c21efa9318503f02a6e56948a301e5bedb2747492003e262f6569d314ec63f4de6d07b65ac92a287c6a8aeae37c924afb4
-  data.tar.gz: 7d360097fbc3f400e21d7147c1f60d6735c6a5939073b8e7bbb721cd6aee12ce142a2c8b5c2d904120768d2746aeae859c8d0e08963b29d8149cd66a8dc461bc
+  metadata.gz: 9c0706c23cb462eb4240def360fcfc0d2afd158f3b3db2846290ddcbea176ea94b00ec3a9cbf2471c372ea8cef7668a625bb55fca2f0e8429c8514ee59cc2d65
+  data.tar.gz: d255523fbb50e830708ac1dfaec86aede73ab3b815e0653627cf51488c16f25a234effceea37b177dd9cb28d46a30fa4bff5c7c4160820c7d610eff2796d1ea4

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:
 
@@ -176,3 +182,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,34 @@
+# frozen_string_literal: true
+
+module SewingKit
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    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 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,2 @@
+node_modules
+build

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

@@ -0,0 +1,31 @@
+{
+  "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"
+    ]
+  },
+  "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,7 @@
+package.json
+.sewing-kit
+.dev
+node_modules
+tmp
+public
+*.svg

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

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

data/lib/sewing_kit/railtie.rb

@@ -1,15 +1,7 @@
 # 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'

data/lib/sewing_kit/version.rb

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

data/lib/tasks/sewing_kit.rake

@@ -14,8 +14,10 @@ namespace :sewing_kit do
   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.123.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-06-08 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