quilt_rails 1.13.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee878b6b3d7207ed8c6883791e896ccc1208d6508aae5c592487d2da900cf91
-  data.tar.gz: 38f3fbd9695b816b0a873891b3fd6b90377f541595ac3427b11677d62289e6aa
+  metadata.gz: c6dead256d2474833a254f212522b7e05b4c7a798d082a2a84b7b2003606583d
+  data.tar.gz: c77e268a3c4be95a2990087ad03400cf16c5b8ba8fcd25f36cbb095b7ce6d169
 SHA512:
-  metadata.gz: 0fb1891f8f988bb0b1b8c60c7b5b25e45c8859ba06ef855625d4656fd24f54a79ead749bad2ee0a2a15559ce097106215d5801a6eda9b3b6c55b7fdc2ee42895
-  data.tar.gz: 74d4d5a3b5ed3e96ce4d3348c67ecc89e6022c24cf631c3be192eb43b7ca4202e4d82351d0d22fd8385ddc75c3ddc82657ca54689b35a1341b44de8b3bf70aa9
+  metadata.gz: ebc9c4a21b3e5046583a3e9711c084856c2a46844806f058d26e0bc90b06bab6f9be7074b91c216d75ccfb6883fe20c01fc250744a6c2b725b63633b88046ae5
+  data.tar.gz: 4c490e4b849cd5a6e548285129eaa130c7217c4d9534b76899a274983ce298a568d5e7713d59a31bd1406e4f46e91ce34b4d4b2c089ecf424cd704d572a2b638

data/README.md

@@ -23,7 +23,7 @@ A turn-key solution for integrating Quilt client-side libraries into your Rails
 
 ## Server-side-rendering
 
-🗒 This guide is focused on internal Shopify developers with access to [`dev`](https://github.com/Shopify/dev) and [@shopify/sewing-kit](https://github.com/Shopify/sewing-kit). A similar setup can be achieved using the [manual installation](./docs/manual-installation) , and following the [react-server-webpack-plugin](../../packages/react-server-webpack-plugin/README.md) guide. Apps not running on Shopify infrastructure should [disable server-side GraphQL queries](./docs/FAQ.md) to avoid scalability issue.
+🗒 This guide is focused on internal Shopify developers with access to [`dev`](https://github.com/Shopify/dev) and [@shopify/sewing-kit](https://github.com/Shopify/sewing-kit). A similar setup can be achieved using the [manual installation](./docs/manual-installation.md) , and following the [react-server webpack plugin](../../packages/react-server/README.md#webpack-plugin) guide. Apps not running on Shopify infrastructure should [disable server-side GraphQL queries](./docs/FAQ.md) to avoid scalability issue.
 
 ### Quick start
 
@@ -36,7 +36,7 @@ When prompted, choose `rails`. This will generate a basic Rails application scaf
 
 Alternatively, you can use [`rails new .`](https://guides.rubyonrails.org/command_line.html#rails-new) to do the same.
 
-In either case, remove [`webpacker`](./docs/FAQ.md#i-run-into-webpacker-issue-while-setting-up-quilt_rails) before continuing.
+In either case, remove [`webpacker`](./docs/FAQ.md#i-run-into-webpacker-issue-while-setting-up-quilt_rails) and [these files](./docs/FAQ.md#any-other-files-i-should-remove-before-running-generator) that any create conflict before continuing.
 
 #### Add Ruby dependencies
 
@@ -46,7 +46,11 @@ This will install our ruby dependencies and update the project's gemfile.
 
 #### Generate app boilerplate
 
-`rails generate quilt_rails:install`
+`rails generate sewing_kit:install`
+
+This 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.
+
+`rails generate quilt:install`
 
 This will install Node dependencies, provide a basic React app (in TypeScript), and mount the Quilt engine in `config/routes.rb`. Basic linting and format configurations are also generated.
 
@@ -61,7 +65,7 @@ Will run the application, starting up both servers and compiling assets.
 
 ### Manual installation
 
-Follow [this guide](./docs/manual-installation) on how to do manual setup without the generator.
+Follow [this guide](./docs/manual-installation.md) on how to do manual setup without the generator.
 
 ### Advanced use
 
@@ -222,7 +226,7 @@ With SSR enabled React apps, state must be serialized on the server and deserial
 
 #### Customizing the Node server
 
-By default, sewing-kit bundles in [`@shopify/react-server-webpack-plugin`](../../packages/react-server-webpack-plugin/README.md) for `quilt_rails` applications to get apps up and running fast without needing to manually write any Node server code.
+By default, sewing-kit bundles in [`@shopify/react-server/webpack-plugin`](../../packages/react-server/README.md#webpack-plugin) for `quilt_rails` applications to get apps up and running fast without needing to manually write any Node server code.
 
 If what it provides is not sufficient, a completely custom server can be defined by adding a `server.js` or `server.ts` file to the `app/ui` folder. The simplest way to customize the server is to export the object created by [`@shopify/react-server`](../../packages/react-server/README.md#node-usage)'s `createServer` call in `server.ts` file.
 
@@ -280,12 +284,12 @@ end
 ## Performance tracking a React app
 
 To setup performance tracking with your React app with `quilt_rails`.
-Follow details guide [here](./docs/performance-tracking).
+Follow details guide [here](./docs/performance-tracking.md).
 
 ## API
 
-Find all features this gem offer in this [API doc](./docs/api).
+Find all features this gem offer in this [API doc](./docs/api.md).
 
 ## FAQ
 
-Find your [here](./docs/FAQ).
+Find your [here](./docs/FAQ.md).

data/lib/quilt_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Quilt
-  VERSION = "1.13.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quilt_rails
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mathew Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -106,12 +106,6 @@ files:
 - lib/generators/quilt/react_setup/react_setup_generator.rb
 - lib/generators/quilt/react_setup/templates/App.tsx
 - lib/generators/quilt/react_setup/templates/tsconfig.json
-- lib/generators/quilt_rails/USAGE
-- lib/generators/quilt_rails/install_generator.rb
-- lib/generators/sewing_kit/USAGE
-- lib/generators/sewing_kit/install_generator.rb
-- lib/generators/sewing_kit/templates/package.json
-- lib/generators/sewing_kit/templates/sewing-kit.config.ts
 - lib/quilt_rails.rb
 - lib/quilt_rails/configuration.rb
 - lib/quilt_rails/engine.rb

data/lib/generators/quilt_rails/USAGE

@@ -1,5 +0,0 @@
-Description:
-    This generator runs all the generators
-
-Example:
-    rails generate quilt_rails:install

data/lib/generators/quilt_rails/install_generator.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module QuiltRails
-  class InstallGenerator < Rails::Generators::Base
-    def run_all_generators
-      generate("sewing_kit:install")
-      generate("quilt:install")
-    end
-  end
-end

data/lib/generators/sewing_kit/USAGE

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

data/lib/generators/sewing_kit/install_generator.rb

@@ -1,34 +0,0 @@
-# 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")
-      copy_file(".eslintignore")
-      copy_file(".prettierignore")
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-{
-  "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/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: [
-    ],
-  };
-}