vue_live 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36416cce2f0fa79e7f3e54dd7df7a2584204205987165f7657a8c2923d74439
-  data.tar.gz: 3ecb4015f175900cebe5382a6fcf84d5be55b41c297ef68a2dc2ea8677f5e25d
+  metadata.gz: b902545c0af7baa4c630504595275d9ce2ffdc811efc963590a214575515f78a
+  data.tar.gz: df805dffdf463a0125b370f62e31c5997006b280127255ece72bf08c0bf6b60f
 SHA512:
-  metadata.gz: a2dfa9d0e4d14fb4da4d0ffb60058f277c7b2b8a750bc6e8aba0c7e58fd57926472038baf56164785ec307550417984b2a9ff824737ec3c23948846d7fc8388d
-  data.tar.gz: 25f9c5af0cfedd4622bf51f0aa39f44ad9c8e4cb7b3c9d65f76db4ed5c38f02ec74f6beceee94407d8cf75a7630bbe0c9004bd0d873b12378cc2cd34f023767a
+  metadata.gz: 1b1945dc95bc59d2474622152d4a031b026396c2b1c97639bfa725db542989e31abcd2515693db3679ed4b4fe33407af5c55bdece59b4e3bf2a3eea8e996b789
+  data.tar.gz: fe52d0057fc840aa7e748b7178eea2aee2cbdb4b25e469fbc4a40ad97ff5a7e5732b62bc07e60a905a980145f3057c9ad412a53af81c1b9d9d3477d7715905b8

data/CHANGELOG.md

@@ -12,7 +12,7 @@
 * Framework-agnostic helpers, Sinatra extension, Rails Railtie (middleware, helpers with CSP
   nonces, `config.vue_live`, `config/vue_live.yml`, generator, rake tasks, importmap-rails pin).
 * Precompiler writing static `.vue.js` modules and a manifest.
-* `vue-live` CLI: `init`, `compile`, `clobber`, `check`, `node-setup`, `info`.
+* `vue_live` CLI: `init`, `compile`, `clobber`, `check`, `node-setup`, `info`.
 * Development live reload over Server-Sent Events (`<prefix>/-/events`, `<prefix>/-/reload.js`),
   included automatically by `vue_live_mount_tag`.
 * Persistent Node worker for the Node backend (a few ms per compile after start-up).
@@ -23,6 +23,6 @@
 * `rake test:setup` installs the Node packages and Chromium the optional tests need; those tests
   auto-detect them instead of requiring environment variables.
 * RuboCop configuration and CI job.
-* TypeScript on Node.js < 22.13: `rake test:setup` and `vue-live node-setup` install sucrase when
-  Node cannot strip types itself, `VUE_LIVE_TS_TRANSPILER` pins a transpiler, `vue-live check`
+* TypeScript on Node.js < 22.13: `rake test:setup` and `vue_live node-setup` install sucrase when
+  Node cannot strip types itself, `VUE_LIVE_TS_TRANSPILER` pins a transpiler, `vue_live check`
   warns about the gap, and CI covers Node 20 (#3).

data/README.md

@@ -1,6 +1,6 @@
 # vue_live
 
-[![CI](https://github.com/danielpclark/vue-live/actions/workflows/ci.yml/badge.svg)](https://github.com/danielpclark/vue-live/actions/workflows/ci.yml)
+[![CI](https://github.com/danielpclark/vue_live/actions/workflows/ci.yml/badge.svg)](https://github.com/danielpclark/vue_live/actions/workflows/ci.yml)
 
 **Serve Vue single-file components straight from Ruby, in production, with no build step.**
 
@@ -68,7 +68,7 @@ without tying itself to Rails or to any asset pipeline.
 # Gemfile
 gem 'vue_live'
 # Until the first release is on RubyGems:
-# gem 'vue_live', github: 'danielpclark/vue-live'
+# gem 'vue_live', github: 'danielpclark/vue_live'
 ```
 
 Requires Ruby 3.0+.  Node.js is **not** required unless you opt into the
@@ -147,7 +147,7 @@ end
 `set :vue_live` has to come first.  `config/vue_live.yml` is read as well, if present.
 Classic-style apps (`require 'sinatra'`) call `register VueLive::Sinatra` at the top level.
 
-`vue-live init` scaffolds `config/vue_live.yml` and `app/vue/HelloVueLive.vue` in any project.
+`vue_live init` scaffolds `config/vue_live.yml` and `app/vue/HelloVueLive.vue` in any project.
 
 ## Quick start: plain Rack
 
@@ -303,8 +303,8 @@ compile instead.
 Enable the Node backend with:
 
 ```sh
-vue-live node-setup                 # npm/yarn add @vue/compiler-sfc vue
-vue-live node-setup --with sass     # plus preprocessors you use
+vue_live node-setup                 # npm/yarn add @vue/compiler-sfc vue
+vue_live node-setup --with sass     # plus preprocessors you use
 bin/rails vue_live:node_setup       # the same, under Rails
 ```
 
@@ -314,10 +314,10 @@ installed its package manager detection is reused, so projects already built wit
 nothing extra.
 
 **TypeScript.**  Node.js 22.13+ strips types itself.  On older Node.js a transpiler package is
-needed; `vue-live node-setup` adds [sucrase](https://github.com/alangpierce/sucrase) automatically
+needed; `vue_live node-setup` adds [sucrase](https://github.com/alangpierce/sucrase) automatically
 in that case (pure JavaScript, keeps line numbers so source maps stay exact).
 `VUE_LIVE_TS_TRANSPILER=node|sucrase|esbuild|typescript|babel` pins one when several are
-installed, and `vue-live check` warns when a Node.js that cannot strip types has no transpiler.
+installed, and `vue_live check` warns when a Node.js that cannot strip types has no transpiler.
 
 ## Development: live reload, errors, source maps
 
@@ -347,7 +347,7 @@ installed, and `vue-live check` warns when a Node.js that cannot strip types has
 * Responses carry an `ETag`; URLs from `vue_live_path` include `?v=<digest>` and are served with
   `Cache-Control: public, max-age=31536000, immutable` in production.
 * In production a component that fails to compile is a 500 with the details in the log.
-* `vue-live compile` / `bin/rails vue_live:precompile` writes every component as a static
+* `vue_live compile` / `bin/rails vue_live:precompile` writes every component as a static
   `.vue.js` file plus `manifest.json` to `public/vue`, for a CDN or `nginx`.  When the manifest
   exists in production, `vue_live_path` reads URLs from it, so a web server or CDN in front of
   `public/` serves the files and the app never compiles them.  Without one, the middleware still
@@ -362,7 +362,7 @@ installed, and `vue-live check` warns when a Node.js that cannot strip types has
 | Precompile | Run `bin/rails vue_live:precompile` in your build (Dockerfile, CI, or `hook_assets_precompile: true`). | CDNs, `nginx` serving `public/`, zero compile cost at runtime |
 
 In production the CDN URL switches to `vue.esm-browser.prod.js` automatically, and
-`vue-live check` / `bin/rails vue_live:check` verifies that every component compiles before you ship.
+`vue_live check` / `bin/rails vue_live:check` verifies that every component compiles before you ship.
 
 ## Browser support and trade-offs
 
@@ -408,7 +408,7 @@ the current environment's section), then Ruby (`VueLive.configure` or `config.vu
 | `import_map` | `{}` | extra import-map entries |
 | `extensions` | `.vue .js .mjs .css .json` + images/fonts | files the middleware will serve from `source_path` |
 | `node_bin` | `node` | Node executable |
-| `precompile_path` | `public/vue` | output of `vue-live compile` |
+| `precompile_path` | `public/vue` | output of `vue_live compile` |
 | `use_manifest` | auto | read `public/vue/manifest.json` for URLs (auto: in production when it exists) |
 | `middleware` | `true` | mount automatically (Railtie / Sinatra); set `false` to `use` it yourself |
 | `importmap_pin` | `true` | pin `vue` into importmap-rails |
@@ -429,10 +429,10 @@ Environment variables:
 
 ## Command line and rake tasks
 
-The gem ships a `vue-live` executable for any project and the same operations as rake tasks
+The gem ships a `vue_live` executable for any project and the same operations as rake tasks
 under Rails:
 
-| `vue-live` | Rails | Does |
+| `vue_live` | Rails | Does |
 | --- | --- | --- |
 | `init [--force] [--node]` | `bin/rails generate vue_live:install [--node] [--skip-example]` | create `config/vue_live.yml` and `app/vue/HelloVueLive.vue` |
 | `compile [--out DIR]` | `bin/rails vue_live:precompile` | write static `.vue.js` modules + `manifest.json` |

data/lib/vue_live/cli.rb

@@ -4,14 +4,14 @@ require 'fileutils'
 require_relative '../vue_live'
 
 module VueLive
-  # The `vue-live` executable.
+  # The `vue_live` executable.
   class CLI
     TEMPLATE_DIR = File.expand_path('templates', __dir__)
 
     USAGE = <<~TEXT.freeze
-      vue-live #{VueLive::VERSION}
+      vue_live #{VueLive::VERSION}
 
-      Usage: vue-live <command> [options]
+      Usage: vue_live <command> [options]
 
       Commands:
         init         Create config/vue_live.yml and app/vue/ with an example component

data/lib/vue_live/compiler/node/compile.js

@@ -32,7 +32,7 @@ try {
   sfc = require(entry)
   sfcDir = path.dirname(entry)
 } catch (e) {
-  const err = { errors: ['@vue/compiler-sfc is not installed in ' + root + ' (run `vue-live node-setup`)'] }
+  const err = { errors: ['@vue/compiler-sfc is not installed in ' + root + ' (run `vue_live node-setup`)'] }
   process.stdout.write(JSON.stringify(err) + '\n')
   process.exit(1)
 }
@@ -274,7 +274,7 @@ function stripTypes(code, filename, lang) {
   if (real) throw real
   throw new Error(
     '<script lang="ts"> needs a TypeScript transpiler and none is available (Node.js ' + process.version +
-    ' has no built-in one; that needs >= 22.13). Install one in the project: `vue-live node-setup --with sucrase` ' +
+    ' has no built-in one; that needs >= 22.13). Install one in the project: `vue_live node-setup --with sucrase`' +
     '(or esbuild, @babel/core + @babel/plugin-transform-typescript, typescript < 7); for this gem\'s own tests run `rake test:setup`.'
   )
 }

data/lib/vue_live/compiler.rb

@@ -40,7 +40,7 @@ module VueLive
         else
           raise UnsupportedFeature.new(
             "uses #{descriptor.advanced_features.join(', ')}, which the pure Ruby compiler cannot handle. " \
-            'Install Node.js and @vue/compiler-sfc (`vue-live node-setup`) to enable the Node backend, ' \
+            'Install Node.js and @vue/compiler-sfc (`vue_live node-setup`) to enable the Node backend,' \
             'or rewrite the component with a plain <script> / <style> block.',
             file: descriptor.filename
           )

data/lib/vue_live/configuration.rb

@@ -46,7 +46,7 @@ module VueLive
     attr_accessor :node_bin
     # Allowed file extensions under +source_path+.
     attr_accessor :extensions
-    # Output directory for +vue-live compile+ (precompiled, static ES modules).
+    # Output directory for +vue_live compile+ (precompiled, static ES modules).
     attr_accessor :precompile_path
     # Use public/vue/manifest.json for URLs instead of the live middleware.  nil = auto
     # (true in production when the manifest exists).

data/lib/vue_live/node_tools.rb

@@ -88,18 +88,18 @@ module VueLive
       true
     end
 
-    # Human-readable status for `vue-live check`.
+    # Human-readable status for `vue_live check`.
     def problems(config = VueLive.config)
       problems = []
       problems << "component directory does not exist: #{config.source_dir}" unless File.directory?(config.source_dir)
       if %i[node].include?(config.compiler.to_sym)
         problems << 'Node.js was not found in PATH (required by compiler: node)' unless node_version(config)
-        problems << '@vue/compiler-sfc is not installed (run `vue-live node-setup`)' unless compiler_sfc_version(config.root)
+        problems << '@vue/compiler-sfc is not installed (run `vue_live node-setup`)' unless compiler_sfc_version(config.root)
       end
       if %i[node auto].include?(config.compiler.to_sym) && node_version(config) && !node_strips_types?(config) &&
          installed_ts_transpilers(config.root).empty?
         problems << "Node.js #{node_version(config)} cannot strip TypeScript and no transpiler is installed; " \
-                    '<script lang="ts"> components will fail (run `vue-live node-setup --with sucrase`)'
+                    '<script lang="ts"> components will fail (run `vue_live node-setup --with sucrase`)'
       end
       problems
     end

data/lib/vue_live/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VueLive
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vue_live
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel P. Clark
@@ -222,7 +222,7 @@ description: |-
 email:
 - 6ftdan@gmail.com
 executables:
-- vue-live
+- vue_live
 extensions: []
 extra_rdoc_files: []
 files:
@@ -230,7 +230,7 @@ files:
 - LICENSE-APACHE
 - LICENSE-MIT
 - README.md
-- exe/vue-live
+- exe/vue_live
 - lib/generators/vue_live/install/install_generator.rb
 - lib/vue_live.rb
 - lib/vue_live/assets/reload.js
@@ -262,14 +262,14 @@ files:
 - lib/vue_live/templates/HelloVueLive.vue
 - lib/vue_live/templates/vue_live.yml
 - lib/vue_live/version.rb
-homepage: https://github.com/danielpclark/vue-live
+homepage: https://github.com/danielpclark/vue_live
 licenses:
 - MIT
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/danielpclark/vue-live
-  changelog_uri: https://github.com/danielpclark/vue-live/blob/main/CHANGELOG.md
-  bug_tracker_uri: https://github.com/danielpclark/vue-live/issues
+  source_code_uri: https://github.com/danielpclark/vue_live
+  changelog_uri: https://github.com/danielpclark/vue_live/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/danielpclark/vue_live/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: