condenser-rails 2.0.0.rc1 → 2.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af5ea6490579f3e2d0ad960b7b105ead8d9e65841d5c3554275f77593d9dea40
-  data.tar.gz: 6b3be923f9411e60fa19c16e4e9087210d8251247066e7b560dc8c6f8406ea58
+  metadata.gz: 85d5ac4cb95e71d372827c8eda9c52db58726c6cad9c90813b4ae8a519e21b2b
+  data.tar.gz: 6801341c6b6043c0bb19fd222a9ff943a1e2dd398625e6977689385992e61bcb
 SHA512:
-  metadata.gz: c5b51b307cff02a363c48855bc66741e31b942d8c8ca70a756a1409637d12e6b4a9883fdcc459141d31bba40995cd84bda2932eb321aac8f395ccb1da329ba8d
-  data.tar.gz: 8a6c9793fc11a839dd02898ad2823b57ef051fa3eeb031efdd7bec105d368a145f35466b1d2eed826e811e4da31fc04a51c0f5955891d0cc7ea941b89f0d1edd
+  metadata.gz: 42a1e35f891b27d5e651fabe7cb1bf3f4db0952567207c0287c40f27146b42fa6804792d250ce624ba39da8bb218114ee47aa05a997c3215efd6fdea28ed54df
+  data.tar.gz: 9388b86b8aa8722374af79cbe685dacfe8f47d817eb3dad79dad172a5e367f651486a4d1751dbcd84a5d8964859562e70cd4cb4a205cbf6f9a09dc1ba11252fa

data/README.md

@@ -31,14 +31,16 @@ compiled. The `rolldown` npm package is installed into the npm path
 To configure Rolldown, replace the default exporter with a configured
 `Condenser::RolldownProcessor` instance. Registering the class, as in earlier
 versions, no longer works. Pass `minify:` yourself, since it defaults to
-`false`:
+`false`. `module_types:` loads imports by file extension, e.g.
+`import logo from 'logo.png'` as a data URL:
 
 ``` ruby
 config.assets.configure do |app, env|
   env.unregister_exporter('application/javascript', Condenser::RolldownProcessor)
   env.register_exporter('application/javascript', Condenser::RolldownProcessor.new(env.npm_path,
     minify: !Rails.env.local?,
-    aliases: { 'jquery' => app.root.join('vendor/assets/javascripts/jquery.js').to_s }
+    aliases: { 'jquery' => app.root.join('vendor/assets/javascripts/jquery.js').to_s },
+    module_types: { png: :dataurl, ttf: :base64 }
   ))
 end
 ```
@@ -49,7 +51,62 @@ To use it instead of Rolldown:
 ``` ruby
 config.assets.configure do |app, env|
   env.unregister_exporter('application/javascript')
-  env.register_exporter('application/javascript', Condenser::RollupProcessor)
+  env.register_exporter('application/javascript', Condenser::RollupProcessor.new(env.npm_path))
+end
+```
+
+### Tailwind CSS
+
+To compile stylesheets with [Tailwind CSS](https://tailwindcss.com) v4, turn it
+on:
+
+``` ruby
+# config/application.rb
+config.assets.tailwind = true
+```
+
+``` css
+/* app/assets/stylesheets/application.css */
+@import "tailwindcss";
+```
+
+Stylesheets that `@import "tailwindcss"` or `@reference` another one are
+compiled by `Condenser::TailwindProcessor`; others are left as they are. Like
+Rolldown, it runs in Node, and `tailwindcss`, `@tailwindcss/node` and
+`@tailwindcss/oxide` are installed into the npm path when the asset
+environment is built, if they aren't there.
+
+Tailwind scans `app/` for class names: the views, components, helpers and
+JavaScript. Add other directories with `config.assets.tailwind_sources`,
+relative to `Rails.root` or absolute, such as templates in `lib/` or in a gem
+or engine:
+
+``` ruby
+config.assets.tailwind_sources = [
+  'lib/components',
+  File.join(Gem.loaded_specs['some_engine'].full_gem_path, 'app/views')
+]
+```
+
+Each has to be an existing directory. `app/` and the `tailwind_sources` are
+watched in development, so editing a template's classes rebuilds the CSS.
+`source(...)`, `source(none)` and `@source` in the stylesheet work as in
+Tailwind; `@source` paths outside `app/` and the `tailwind_sources` need to be
+added to `config.assets.watch` to rebuild a running server's CSS.
+
+Tailwind doesn't minify its output itself: the CSS minifier
+(`config.assets.css_minifier`, Lightning CSS by default) minifies the whole
+stylesheet outside development and test.
+
+The processor is only added to the default pipeline. With a custom
+`config.assets.pipeline`, register it yourself:
+
+``` ruby
+config.assets.pipeline do |env|
+  # ...
+  env.register_preprocessor 'text/css', Condenser::TailwindProcessor.new(env.npm_path,
+    sources: [Rails.root.join('app'), Rails.root.join('lib/components')]
+  )
 end
 ```
 
@@ -119,23 +176,75 @@ const foo = <%= YAML.load_file(Rails.root.join('config/foo.yml')).to_json %>;
 config.assets.watch << 'data'
 ```
 
+**`config.assets.tailwind`**
+
+Compiles stylesheets that `@import "tailwindcss"` with Tailwind. Defaults to
+`false`. See [Tailwind CSS](#tailwind-css).
+
+**`config.assets.tailwind_sources`**
+
+More directories for Tailwind to scan for class names, besides `app/`,
+relative to `Rails.root` or absolute. Defaults to `[]`.
+
 **`config.assets.js_minifier`**
 
 The JS minifier to use to minify javascript sources. Valid options are
 `:rolldown` (the default, Rolldown minifies its own output), `:terser`, your own
-minifier, and `false` or `nil` to disable minification. `:terser` runs in Node,
-is npm-installed into the npm path when first used, and turns Rolldown's
-minifier off.
+minifier (a `Condenser::Processor` instance), and `false` or `nil` to disable
+minification. `:terser` runs in Node, is npm-installed into the npm path when
+first used, and turns Rolldown's minifier off.
 
 **`config.assets.css_minifier`**
 
 The CSS minifier to use to minify css sources. Valid options are
 `:lightning_css` (the default, which needs the `lightningcss` gem), `:sass`
-(which needs the `sass-embedded` gem), your own minifier, and `false` or `nil`
-to disable minification.
+(which needs the `sass-embedded` gem), your own minifier (a `Condenser::Processor`
+instance), and `false` or `nil` to disable minification.
 
 Assets are only minified outside the `development` and `test` environments.
 
+**`config.assets.sourcemap`**
+
+Sets condenser's `sourcemap` setting, whether a source map is written for each
+JavaScript bundle and how it's linked:
+
+| Value | Map | `//# sourceMappingURL` comment | `SourceMap` header (development server) |
+|---|---|---|---|
+| `false` (default) | no | no | no |
+| `true` | yes | yes | yes |
+| `:linked` | yes | yes | no |
+| `:headers` | yes | no | yes |
+
+It applies in every environment, so set it per environment in
+`config/environments/*.rb`. Development builds aren't minified, so maps there
+are optional.
+
+``` ruby
+# config/environments/development.rb
+config.assets.sourcemap = true
+
+# config/environments/production.rb
+config.assets.sourcemap = :headers
+```
+
+In production, precompiled assets are usually served by nginx or a CDN, not
+condenser's server, so nothing sends the `SourceMap` header. With `:headers`
+the map is on disk next to the bundle, with no link to it unless your web
+server adds the header. That's the setup for error trackers such as Sentry:
+upload the maps yourself (e.g. with `sentry-cli sourcemaps upload`). There's no
+separate hidden mode. Use `true` or `:linked` for browsers and error trackers
+to fetch the map from your server.
+
+`rake assets:precompile` writes the map next to the bundle, as
+`application-<etag>.js.map`, and adds it to the manifest's `sourcemap` field;
+`assets:clean` keeps it and `assets:clobber` removes it. The development server
+serves it at the bundle's URL plus `.map`. The map covers Rolldown's minifying
+and a `:terser` `js_minifier`. The setting is part of the asset cache key and
+etag, so changing it rebuilds the bundles.
+
+`config.assets.sourcemap` applies to any pipeline, including a custom
+`config.assets.pipeline`, since it's set on the environment.
+
 **`config.assets.compressors`**
 
 A list of compressors to compress the output with. Each file will be written along
@@ -155,7 +264,7 @@ for asset compiling.
 ``` ruby
 config.assets.configure do |app, env|
   require 'my_processor'
-  env.register_preprocessor 'application/javascript', MyProcessor
+  env.register_preprocessor 'application/javascript', MyProcessor.new
 end
 ```
 
@@ -185,6 +294,11 @@ HTTPS.
 - CSS is minified by Lightning CSS by default.
 - A custom Rolldown exporter must be an instance:
   `Condenser::RolldownProcessor.new(env.npm_path, minify: !Rails.env.local?, …)`.
+- Processors registered in `config.assets.pipeline` or `config.assets.configure`,
+  and minifiers set with `config.assets.js_minifier` or `css_minifier`, must be
+  instances of a `Condenser::Processor` subclass, e.g.
+  `env.register_preprocessor 'application/javascript', Condenser::JSAnalyzer.new`.
+  Registering a class raises an `ArgumentError`.
 - A bare `// depends_on` path that matches nothing now raises
   `Condenser::FileNotFound` (globs don't). Files relative to the app root need
   a `!`, e.g. `// depends_on !config/foo.yml`. `config/` is watched by default
@@ -195,6 +309,9 @@ HTTPS.
   its `exports` (`sass` or `style` condition), `sass` or `style` field.
 - A configured `config.assets.npm_path` is now respected instead of being
   reset to `Rails.root`.
+- Tailwind CSS v4 is built in: set `config.assets.tailwind = true`, and
+  `config.assets.tailwind_sources` for templates outside `app/`, instead of
+  building Tailwind's CSS separately.
 - Clear `tmp/cache/assets` and `public/assets` after upgrading.
 
 ## License

data/lib/condenser/rails/version.rb

@@ -2,6 +2,6 @@
 
 class Condenser
   module Rails
-    VERSION = "2.0.0.rc1"
+    VERSION = "2.0.0.rc2"
   end
 end

data/lib/condenser/railtie.rb

@@ -76,9 +76,15 @@ class Condenser::Railtie < ::Rails::Railtie
   # Used outside development and test; set to nil or false to disable
   config.assets.js_minifier  = :rolldown
   config.assets.css_minifier = :lightning_css
+  # Source maps: false, true, :linked or :headers, in every environment
+  config.assets.sourcemap    = false
   # Directories, relative to Rails.root or absolute, whose files can be
   # `depends_on`'d and rebuild assets when they change
   config.assets.watch        = ['config']
+  # Compile stylesheets that `@import "tailwindcss"` with Tailwind, scanning
+  # app/ and the tailwind_sources, relative to Rails.root or absolute
+  config.assets.tailwind         = false
+  config.assets.tailwind_sources = []
 
   config.assets.configure do |app, env|
     config.assets.path.each { |path| env.append_path(path) }
@@ -113,9 +119,11 @@ class Condenser::Railtie < ::Rails::Railtie
     lightning_css: 'Condenser::LightningCSSMinifier'
   }.freeze
 
-  def resolve_minifier(value)
+  def resolve_minifier(value, env)
     if value.is_a?(Symbol) || value.is_a?(String)
-      (MINIFIERS[value.to_sym] || "Condenser::#{value.to_s.camelize}Minifier").constantize
+      klass = (MINIFIERS[value.to_sym] || "Condenser::#{value.to_s.camelize}Minifier").constantize
+      # Node minifiers (e.g. Terser) install their package into the npm path
+      klass <= Condenser::NodeProcessor ? klass.new(env.npm_path) : klass.new
     else
       value
     end
@@ -141,7 +149,7 @@ class Condenser::Railtie < ::Rails::Railtie
 
     # Set the npm path up front so exporters and custom pipelines can use it
     npm_path = config.assets.npm_path if config.assets.npm_path && File.directory?(config.assets.npm_path)
-    env = Condenser.new(pipeline: false, logger: ::Rails.logger, base: app.root.to_s, npm_path: npm_path, listen: listen)
+    env = Condenser.new(pipeline: false, logger: ::Rails.logger, base: app.root.to_s, npm_path: npm_path, listen: listen, sourcemap: config.assets.sourcemap || false)
 
     if config.assets._pipeline
       config.assets._pipeline.call(env)
@@ -153,12 +161,18 @@ class Condenser::Railtie < ::Rails::Railtie
       rolldown_minifies = minify && js_minifier.to_s == 'rolldown'
 
       env.register_transformer  'text/scss', 'text/css', Condenser::ScssTransformer.new
-      env.register_preprocessor 'application/javascript', Condenser::JSAnalyzer
+      env.register_preprocessor 'application/javascript', Condenser::JSAnalyzer.new
+      if config.assets.tailwind
+        # The CSS minifier minifies Tailwind's output with the rest of the
+        # stylesheet, so Tailwind doesn't. The processor watches the sources.
+        sources = ['app', *config.assets.tailwind_sources].map { |path| File.expand_path(path, app.root) }
+        env.register_preprocessor 'text/css', Condenser::TailwindProcessor.new(env.npm_path, sources: sources, minify: false)
+      end
       env.register_exporter       'application/javascript', Condenser::RolldownProcessor.new(env.npm_path, minify: rolldown_minifies)
 
       if minify
-        env.register_minifier       'application/javascript', resolve_minifier(js_minifier) if js_minifier && !rolldown_minifies
-        env.register_minifier       'text/css', resolve_minifier(config.assets.css_minifier) if config.assets.css_minifier
+        env.register_minifier       'application/javascript', resolve_minifier(js_minifier, env) if js_minifier && !rolldown_minifies
+        env.register_minifier       'text/css', resolve_minifier(config.assets.css_minifier, env) if config.assets.css_minifier
       end
 
       env.register_writer Condenser::FileWriter.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: condenser-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0.rc2
 platform: ruby
 authors:
 - Jonathan Bracy
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc1
+        version: 2.0.0.rc2
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc1
+        version: 2.0.0.rc2
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'