cable_ready 5.0.0.pre10 → 5.0.0.rc2

data/lib/install/importmap.rb

@@ -42,7 +42,7 @@ backup(importmap_path) do
 
   if !importmap.include?("pin \"cable_ready\"")
     append_file(importmap_path, <<~RUBY, verbose: false)
-      pin "cable_ready", to: "cable_ready.min.js", preload: true
+      pin "cable_ready", to: "cable_ready.js", preload: true
     RUBY
     say "✅ pin CableReady"
   end

data/lib/install/shakapacker.rb

@@ -8,10 +8,14 @@ return if pack_path_missing?
 lines = package_json.readlines
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
   add_package "@hotwired/stimulus@^3.2"
+else
+  say "⏩ @hotwired/stimulus npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus-webpack-helpers["']: ["']\^1.0.1["']/ }
   add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
+else
+  say "⏩ @hotwired/stimulus-webpack-helpers npm package is already present. Skipping."
 end
 
 step_path = "/app/javascript/controllers/"

data/lib/install/vite.rb

@@ -8,10 +8,14 @@ return if pack_path_missing?
 lines = package_json.readlines
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
   add_package "@hotwired/stimulus@^3.2"
+else
+  say "⏩ @hotwired/stimulus npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']stimulus-vite-helpers["']: ["']\^3["']/ }
   add_package "stimulus-vite-helpers@^3"
+else
+  say "⏩ @stimulus-vite-helpers npm package is already present. Skipping."
 end
 
 step_path = "/app/javascript/controllers/"

data/lib/install/webpacker.rb

@@ -8,26 +8,38 @@ return if pack_path_missing?
 lines = package_json.readlines
 if !lines.index { |line| line =~ /^\s*["']webpack["']: ["']\^4.46.0["']/ }
   add_package "webpack@^4.46.0"
+else
+  say "⏩ webpack npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']webpack-cli["']: ["']\^3.3.12["']/ }
   add_package "webpack-cli@^3.3.12"
+else
+  say "⏩ webpack-cli npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@rails\/webpacker["']: ["']\^5.4.3["']/ }
   add_package "@rails/webpacker@^5.4.3"
+else
+  say "⏩ @rails/webpacker npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
   add_package "@hotwired/stimulus@^3.2"
+else
+  say "⏩ @hotwired/stimulus npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus-webpack-helpers["']: ["']\^1.0.1["']/ }
   add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
+else
+  say "⏩ @hotwired/stimulus-webpack-helpers npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']webpack-dev-server["']: ["']\^3.11.3["']/ }
   add_dev_package "webpack-dev-server@^3.11.3"
+else
+  say "⏩ @webpack-dev-server is already present. Skipping."
 end
 
 step_path = "/app/javascript/controllers/"

data/lib/tasks/cable_ready/cable_ready.rake

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-include Rails.application.routes.url_helpers
-
 CR_STEPS = {
   "action_cable" => "Action Cable",
-  "webpacker" => "CableReady using Webpacker",
-  "shakapacker" => "CableReady using Shakapacker",
+  "webpacker" => "Install CableReady using Webpacker",
+  "shakapacker" => "Install CableReady using Shakapacker",
   "npm_packages" => "Install CableReady npm package",
   "importmap" => "Install CableReady using importmaps",
   "esbuild" => "Install CableReady using esbuild",
@@ -13,11 +11,11 @@ CR_STEPS = {
   "initializers" => "Generate and configure initializer",
   "development" => "development environment configuration",
   "spring" => "Disable spring gem. Spring has been removed from Rails 7",
-  "mrujs" => "Swap out UJS for mrujs",
+  "mrujs" => "Swap out Rails UJS for mrujs",
   "broadcaster" => "Make CableReady::Broadcaster available to channels, controllers, jobs and models",
   "updatable" => "Include CableReady::Updatable in Active Record model classes",
-  "vite" => "CableReady using Vite",
-  "compression" => "Compress WebSockets traffic with gzip"
+  "vite" => "Install CableReady using Vite",
+  "compression" => "Compress WebSocket traffic with gzip"
 }
 
 CR_BUNDLERS = {
@@ -219,7 +217,7 @@ namespace :cable_ready do
     end
 
     desc <<~DESC
-      Re-run specific CableReady install steps
+      Run specific CableReady install steps
 
       #{CR_STEPS.sort.map { |step, description| "#{step.ljust(20)} #{description}" }.join("\n")}
     DESC

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cable_ready",
-  "version": "5.0.0-pre10",
+  "version": "5.0.0-rc2",
   "description": "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.",
   "keywords": [
     "ruby",
@@ -35,13 +35,14 @@
     "javascript/*"
   ],
   "scripts": {
-    "lint": "yarn run prettier-standard:check",
-    "format": "yarn run prettier-standard:format",
-    "prettier-standard:check": "yarn run prettier-standard --check ./javascript/**/*.js rollup.config.js",
-    "prettier-standard:format": "yarn run prettier-standard ./javascript/**/*.js rollup.config.js",
+    "lint": "yarn run format --check",
+    "format": "yarn run prettier-standard ./javascript/**/*.js rollup.config.mjs",
     "build": "yarn rollup -c",
     "watch": "yarn rollup -wc",
-    "test": "web-test-runner javascript/test/**/*.test.js"
+    "test": "web-test-runner javascript/test/**/*.test.js",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs && cp ./docs/_redirects ./docs/.vitepress/dist",
+    "docs:preview": "vitepress preview docs"
   },
   "dependencies": {
     "morphdom": "2.6.1"
@@ -53,9 +54,12 @@
     "@rollup/plugin-terser": "^0.4.0",
     "@web/dev-server-esbuild": "^0.3.3",
     "@web/dev-server-rollup": "^0.3.21",
-    "@web/test-runner": "^0.15.0",
+    "@web/test-runner": "^0.15.1",
     "prettier-standard": "^16.4.1",
-    "rollup": "^3.15.0",
-    "sinon": "^15.0.1"
+    "rollup": "^3.19.1",
+    "sinon": "^15.0.2",
+    "vite": "^4.1.4",
+    "vitepress": "^1.0.0-alpha.56",
+    "vitepress-plugin-search": "^1.0.4-alpha.19"
   }
 }

data/rollup.config.mjs

@@ -14,13 +14,6 @@ const pretty = () => {
   })
 }
 
-const minify = () => {
-  return terser({
-    mangle: true,
-    compress: true
-  })
-}
-
 const esConfig = {
   format: 'es',
   inlineDynamicImports: true
@@ -43,22 +36,10 @@ const output = distFolders
       file: `${distFolder}/${baseName}.js`,
       plugins: [pretty()]
     },
-    {
-      ...esConfig,
-      file: `${distFolder}/${baseName}.min.js`,
-      sourcemap: true,
-      plugins: [minify()]
-    },
     {
       ...umdConfig,
       file: `${distFolder}/${baseName}.umd.js`,
       plugins: [pretty()]
-    },
-    {
-      ...umdConfig,
-      file: `${distFolder}/${baseName}.umd.min.js`,
-      sourcemap: true,
-      plugins: [minify()]
     }
   ])
   .flat()