vite_rails 1.0.4 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09b3f9165e33562bd060ff1c5bc3cb2efb76a68d4de1bc3548a213110df6bba4'
-  data.tar.gz: 3aac713bfb90f0586c2309217b45d64bc394312ed5fb08be44391d3dcb68d459
+  metadata.gz: a7036c3650b1b44c82158220474b56e26488785cefb0a99044444708d603001a
+  data.tar.gz: 8161dbb668ff8c2308de6783e1dbff81faf60b13cd87393348070a2f8b2f9c18
 SHA512:
-  metadata.gz: '08b9ee75915396e16078094f1870211e5667cc3f9edf9502844be884a556a6c9378bbcdef8374498761643fab94c0302930d18737d98ceaae013c0da0ac9f2d6'
-  data.tar.gz: 482461f60d07e91c99084f74089d10fe07ac2db20aad1c324a45f5b6fbb1f4f815dd436993c21798c4c18e116d5bee729b83abe08e85d02757637731a242d7b0
+  metadata.gz: a5ecb6327e2009b5fcf8aa91f90989264538db013dafc4b34a361e11b60a8d69bd394d6c6e5043583ff1cfe35fe5464424e26b616304ee30089c9e5a06fa2bda
+  data.tar.gz: 04124e8f3c0063b1461185fbfb665623b0c49c6ea3712952a857eb1bb00886e420ae64335609f4879377013ef7f32506ef84400af52f9a3385c90b9b5c025193

data/CHANGELOG.md

@@ -1,3 +1,28 @@
-## Vite Rails 1.0.0
+## Vite Rails 1.0.9  (2020-01-22)
+
+- Ensure `configPath` and `publicDir` are scoped from `root`, both in Ruby and JS.
+
+## Vite Rails 1.0.8  (2020-01-21)
+
+- Change the default of `sourceCodeDir` to `app/frontend`, add instructions for folks migrating
+from a `app/javascript` structure.
+
+## Vite Rails 1.0.7  (2020-01-20)
+
+- Add `vite_client_tag` to ensure the Vite client can be loaded in apps that don't use any imports.
+
+## Vite Rails 1.0.6  (2020-01-20)
+
+- Ensure running `bin/rake assets:precompile` automatically invokes `vite:build`.
+
+## Vite Rails 1.0.5  (2020-01-20)
+
+- Automatically add `<link rel="modulepreload">` and `<link rel="stylesheet">` when using `vite_javascript_tag`, which simplifies usage.
+
+## Vite Rails 1.0.4  (2020-01-19)
+
+- Remove Vue specific examples from installation templates, to ensure they always run.
+
+## Vite Rails 1.0.0 (2020-01-18)
 
 Initial Version

data/CONTRIBUTING.md

@@ -6,7 +6,6 @@
 
 ```
 bundle install
-yarn
 ```
 
 ## Making sure your changes pass all tests

data/README.md

@@ -19,26 +19,35 @@
   </p>
 </h1>
 
+[website]: https://vite-rails.netlify.app/
+[configuration reference]: https://vite-rails.netlify.app/config/
+[features]: https://vite-rails.netlify.app/guide/introduction.html
+[guides]: https://vite-rails.netlify.app/guide/
+[config]: https://vite-rails.netlify.app/config/
 [vite_rails]: https://github.com/ElMassimo/vite_rails
 [webpacker]: https://github.com/rails/webpacker
 [vite]: http://vitejs.dev/
 [config file]: https://github.com/ElMassimo/vite_rails/blob/main/package/default.vite.json
+[example app]: https://github.com/ElMassimo/vite_rails/tree/main/examples/blog
+[heroku]: https://vite-rails-demo.herokuapp.com/
 
-[__Vite Rails__][vite_rails] allows you to use [Vite] to power the frontend.
+[__Vite Rails__][vite_rails] allows you to use [Vite] to power the frontend of your Rails app.
 
 [Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
 
+Check an [example app] running on [Heroku].
+
 ## Features ⚡️
 
-- 🤖 Automatic Entrypoint Detection
-- ⚡️ Hot Reload
-- ⚙️ Rake Tasks
-- 🪝 Hooks to <kbd>assets:precompile</kbd> and friends
-- And more! (detects changes, and builds automatically if Vite is not running)
+- 🤖 Automatic entrypoint detection
+- ⚡️ Blazing fast hot reload
+- 🚀 Zero-config deployments
+- 🤝 Integrated with <kbd>assets:precompile</kbd>
+- [And more!][features]
 
 ## Documentation 📖
 
-A documentation website is coming soon!
+Visit the [documentation website][website] to check out the [guides] and searchable [configuration reference].
 
 ## Installation 💿
 
@@ -57,74 +66,27 @@ bin/rake vite:install
 
 This will generate configuration files and a sample setup.
 
-## Usage 🚀
-
-Drawing inspiration from [webpacker], any files in `app/javascript/entrypoints`
-will be considered entries to your application (SPAs or pages).
-
-These files will be detected, and passed on to Vite, all configuration is done
-for you.
-
-### Imports ⤵️
-
-For convenience, a `~/` import alias is configured to `app/javascript`, allowing
-you to use absolute paths:
+Additional installation instructions are available in the [documentation website][website].
 
-```js
-import { createApp } from 'vue'
-import App from '~/App.vue'
-import '~/channels'
+## Getting Started 💻
 
-createApp(App).mount('#app')
-```
-
-### Tags 🏷
-
-`vite_typescript_tag`, `vite_javascript_tag`, and `vite_stylesheet_tag` can be
-used to output `<script>` and `<link>` tags in your Rails layouts or templates.
+Restart your Rails server, and then run <kbd>bin/vite</kbd> to start the Vite development server.
 
-```html
-<head>
-  <title>Joie</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
+Add the following your `views/layouts/application.html.erb`:
 
-  <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
-  <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
-
-  <%= vite_stylesheet_tag 'strange' %>
-  <%= vite_typescript_tag 'application' %>
-</head>
+```erb
+<%= vite_client_tag %>
+<%= vite_javascript_tag 'application' %>
 ```
 
-For other types of assets, you can use `vite_asset_path` and pass that to the appropriate tag helper.
-
-## Configuration ⚙️
-
-This is what your `config/vite.json` might look like:
-
-```json
-{
-  "all": {
-    "watchAdditionalPaths": []
-  },
-  "development": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-dev",
-    "port": 3036
-  },
-  "test": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-test"
-  }
-}
-```
+Visit any page and you should see a printed console output: `Vite ⚡️ Rails`.
 
-Check [this file][config file] to see all config options, documentation is coming soon.
+For more [guides] and a full [configuration reference], check the [documentation website][website].
 
-## Inspiration 💡
+## Special Thanks 🙏
 
 - [webpacker]
+- [vite]
 
 ## License
 

data/lib/install/javascript/entrypoints/application.js

@@ -1,3 +1,10 @@
+// To see this message, add the following to the `<head>` section in your
+// views/layouts/application.html.erb
+//
+//    <%= vite_client_tag %>
+//    <%= vite_javascript_tag 'application' %>
+console.log('Vite ⚡️ Rails')
+
 // Example: Load Rails libraries in Vite.
 //
 // import '@rails/ujs'
@@ -11,8 +18,5 @@
 // Turbolinks.start()
 // ActiveStorage.start()
 
-// Example: Import a stylesheet in app/javascript/index.css
+// Example: Import a stylesheet in app/frontend/index.css
 // import '~/index.css'
-
-console.log('Vite ⚡️ Rails')
-

data/lib/install/template.rb

@@ -6,7 +6,7 @@ copy_file "#{ __dir__ }/config/vite.json", ViteRails.config.config_path
 copy_file "#{ __dir__ }/config/vite.config.ts", Rails.root.join('vite.config.ts')
 
 say 'Creating entrypoints directory'
-directory "#{ __dir__ }/javascript/entrypoints", ViteRails.config.source_code_dir.join(ViteRails.config.entrypoints_dir)
+directory "#{ __dir__ }/javascript/entrypoints", ViteRails.config.resolved_entrypoints_dir
 
 apply "#{ __dir__ }/binstubs.rb"
 

data/lib/tasks/vite/build.rake

@@ -3,7 +3,7 @@
 $stdout.sync = true
 
 def enhance_assets_precompile
-  Rake::Task['assets:precompile'] do |task|
+  Rake::Task['assets:precompile'].enhance do |task|
     prefix = task.name.split(/#|assets:precompile/).first
 
     Rake::Task["#{ prefix }vite:build"].invoke
@@ -13,11 +13,7 @@ end
 namespace :vite do
   desc 'Compile JavaScript packs using vite for production with digests'
   task build: [:'vite:verify_install', :environment] do
-    ViteRails.with_node_env(ENV.fetch('NODE_ENV', 'production')) do
-      ViteRails.ensure_log_goes_to_stdout do
-        ViteRails.build || exit!
-      end
-    end
+    ViteRails.build_from_rake
   end
 end
 

data/lib/tasks/vite/clean.rake

@@ -5,9 +5,7 @@ $stdout.sync = true
 namespace :vite do
   desc 'Remove old compiled vites'
   task :clean, [:keep, :age] => [:'vite:verify_install', :environment] do |_, args|
-    ViteRails.ensure_log_goes_to_stdout do
-      ViteRails.clean(keep_up_to: Integer(args.keep || 2), age_in_seconds: Integer(args.age || 3600))
-    end
+    ViteRails.clean_from_rake(args)
   end
 end
 

data/lib/tasks/vite/info.rake

@@ -14,7 +14,6 @@ namespace :vite do
       $stdout.puts "vite-plugin-ruby: \n#{ `npm list vite-plugin-ruby version` }"
 
       $stdout.puts "Is bin/vite present?: #{ File.exist? 'bin/vite' }"
-      $stdout.puts "Is bin/vite-dev-server present?: #{ File.exist? 'bin/vite-dev-server' }"
       $stdout.puts "Is bin/yarn present?: #{ File.exist? 'bin/yarn' }"
     end
   end

data/lib/tasks/vite/verify_install.rake

@@ -11,10 +11,10 @@ namespace :vite do
       WARN
       exit!
     end
-    unless ViteRails.config.config_path.exist?
-      path = ViteRails.config.config_path.relative_path_from(Pathname.new(pwd)).to_s
+    config_path = Rails.root.join(ViteRails.config.config_path)
+    unless config_path.exist?
       warn <<~WARN
-        Configuration #{ path } file for vite-plugin-ruby not found.
+        Configuration #{ config_path } file for vite-plugin-ruby not found.
         Make sure vite:install has run successfully before running dependent tasks.
       WARN
       exit!

data/lib/vite_rails.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext/class/attribute_accessors'
+require 'rails'
+require 'active_support/all'
 
 require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem
@@ -13,18 +13,10 @@ class ViteRails
   # Internal: Prefix used for environment variables that modify the configuration.
   ENV_PREFIX = 'VITE_RUBY'
 
-  # Public: Additional environment variables to pass to Vite.
-  #
-  # Example:
-  #   ViteRails.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'
-  cattr_accessor(:env) { ENV.select { |key, _| key.start_with?(ENV_PREFIX) } }
-
-  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
-
   class << self
-    delegate :config, :builder, :manifest, :commands, :dev_server, to: :instance
+    delegate :config, :builder, :manifest, :commands, :dev_server, :dev_server_running?, to: :instance
     delegate :mode, to: :config
-    delegate :bootstrap, :clean, :clobber, :build, to: :commands
+    delegate :bootstrap, :clean, :clean_from_rake, :clobber, :build, :build_from_rake, to: :commands
 
     attr_writer :instance
 
@@ -45,21 +37,23 @@ class ViteRails
       false
     end
 
-    def with_node_env(env)
-      original = ENV['NODE_ENV']
-      ENV['NODE_ENV'] = env
-      yield
-    ensure
-      ENV['NODE_ENV'] = original
+    # Internal: Allows to obtain any env variables for configuration options.
+    def load_env_variables
+      ENV.select { |key, _| key.start_with?(ENV_PREFIX) }
     end
+  end
 
-    def ensure_log_goes_to_stdout
-      old_logger = ViteRails.logger
-      ViteRails.logger = ActiveSupport::Logger.new(STDOUT)
-      yield
-    ensure
-      ViteRails.logger = old_logger
-    end
+  # Public: Additional environment variables to pass to Vite.
+  #
+  # Example:
+  #   ViteRails.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'
+  cattr_accessor(:env) { load_env_variables }
+
+  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
+
+  # Public: Returns true if the Vite development server is running.
+  def dev_server_running?
+    ViteRails.run_proxy? && dev_server.running?
   end
 
   # Public: Current instance configuration for Vite.

data/lib/vite_rails/builder.rb

@@ -67,9 +67,18 @@ private
   def build_with_vite
     logger.info 'Building with Vite ⚡️'
 
-    stdout, stderr, status = Open3.capture3(vite_env,
-      "#{ which_ruby } ./bin/vite build --mode #{ config.mode }", chdir: File.expand_path(config.root))
+    command = "#{ which_ruby } ./bin/vite build --mode #{ config.mode }"
+    stdout, stderr, status = Open3.capture3(vite_env, command, chdir: File.expand_path(config.root))
 
+    log_build_result(stdout, stderr, status)
+
+    status.success?
+  end
+
+  # Internal: Outputs the build results.
+  #
+  # NOTE: By default it also outputs the manifest entries.
+  def log_build_result(stdout, stderr, status)
     if status.success?
       logger.info "Build with Vite complete: #{ config.build_output_dir }"
       logger.error(stderr.to_s) unless stderr.empty?
@@ -78,8 +87,6 @@ private
       non_empty_streams = [stdout, stderr].delete_if(&:empty?)
       logger.error "Build with Vite failed:\n#{ non_empty_streams.join("\n\n") }"
     end
-
-    status.success?
   end
 
   # Internal: Used to prefix the bin/vite executable file.

data/lib/vite_rails/commands.rb

@@ -11,6 +11,15 @@ class ViteRails::Commands
     manifest.refresh
   end
 
+  # Public: Defaults to production, and exits if the build fails.
+  def build_from_rake
+    with_node_env(ENV.fetch('NODE_ENV', 'production')) {
+      ensure_log_goes_to_stdout {
+        build || exit!
+      }
+    }
+  end
+
   # Public: Builds all assets that are managed by Vite, from the entrypoints.
   def build
     builder.build.tap { manifest.refresh }
@@ -22,6 +31,13 @@ class ViteRails::Commands
     config.build_cache_dir.rmtree if config.build_cache_dir.exist?
   end
 
+  # Public: Receives arguments from a rake task.
+  def clean_from_rake(args)
+    ensure_log_goes_to_stdout {
+      clean(keep_up_to: Integer(args.keep || 2), age_in_seconds: Integer(args.age || 3600))
+    }
+  end
+
   # Public: Cleanup old assets in the output directory.
   #
   # keep_up_to - Max amount of backups to preserve.
@@ -33,21 +49,16 @@ class ViteRails::Commands
   #   To force only 1 backup to be kept: clean(1, 0)
   #   To only keep files created within the last 10 minutes: clean(0, 600)
   def clean(keep_up_to: 2, age_in_seconds: 3600)
-    return false unless config.build_output_dir.exist? && config.manifest_path.exist?
+    return false unless may_clean?
 
-    versions.sort.reverse
+    versions
       .each_with_index
       .drop_while { |(mtime, _), index|
         max_age = [0, Time.now - Time.at(mtime)].max
         max_age < age_in_seconds || index < keep_up_to
       }
-      .each do |(_, files), _index|
-        files.each do |file|
-          next unless File.file?(file)
-
-          File.delete(file)
-          logger.info("Removed #{ file }")
-        end
+      .each do |(_, files), _|
+        clean_files(files)
       end
     true
   end
@@ -56,13 +67,42 @@ private
 
   delegate :config, :builder, :manifest, :logger, to: :@vite_rails
 
+  def may_clean?
+    config.build_output_dir.exist? && config.manifest_path.exist?
+  end
+
+  def clean_files(files)
+    files.select { |file| File.file?(file) }.each do |file|
+      File.delete(file)
+      logger.info("Removed #{ file }")
+    end
+  end
+
   def versions
     all_files = Dir.glob("#{ config.build_output_dir }/**/*")
     entries = all_files - [config.manifest_path] - current_version_files
-    entries.reject { |file| File.directory?(file) }.group_by { |file| File.mtime(file).utc.to_i }
+    entries.reject { |file| File.directory?(file) }
+      .group_by { |file| File.mtime(file).utc.to_i }
+      .sort.reverse
   end
 
   def current_version_files
     Dir.glob(manifest.refresh.values.map { |value| config.build_output_dir.join("#{ value['file'] }*") })
   end
+
+  def with_node_env(env)
+    original = ENV['NODE_ENV']
+    ENV['NODE_ENV'] = env
+    yield
+  ensure
+    ENV['NODE_ENV'] = original
+  end
+
+  def ensure_log_goes_to_stdout
+    old_logger = ViteRails.logger
+    ViteRails.logger = ActiveSupport::Logger.new(STDOUT)
+    yield
+  ensure
+    ViteRails.logger = old_logger
+  end
 end