cssbundling-rails 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5be53848365bc063ba001b88c7e2f125b8f434dc0dff7b2bd2046cefeada38d
-  data.tar.gz: 45502e231a93390c1fea3dccc6cb345b3ea63f1e57754906dc5c344a66fed61a
+  metadata.gz: f839a506865e012ab4c918e645399aa34d8aa57fcc7376bbffbadcafb26d8ad7
+  data.tar.gz: 712fa468fdf15ec1b2823e635c51b5f26f791cdfafb51bd94eb30b7ea5d549d5
 SHA512:
-  metadata.gz: 5ce45e6fcfcf1262f4075f2e2729b0ac538e7e97a483f18547a04084e9b5444e07adb4e92f2aa88a73fe0b3b26aac5755335be7eb040dae6cc48bb0fa1487e67
-  data.tar.gz: 7474397e610d94244b003e444342623b4d148f49f9a436775f63da856043d6c120be1d6ac9d316f6f559b6813eefc6b23c880b22450f155b9902ee3c61ca653b
+  metadata.gz: c88eadeaab06974fce524d36aab035568c7a6432039957ed75b26f6305acf8c2f942f0abca7e836f52517c655468dc0ec55700fb51e8a9cf4f1511495b1185c7
+  data.tar.gz: 57fd56159909dffac0267813154caec9bf788991597e6c1f87b1482dca4863bac68ce43093b02efa23500027fb0a6bd4249cd6655b4861c30a85730ecc425009

data/README.md

@@ -2,7 +2,9 @@
 
 Use [Tailwind CSS](https://tailwindcss.com), [Bootstrap](https://getbootstrap.com/), [Bulma](https://bulma.io/), [PostCSS](https://postcss.org), or [Dart Sass](https://sass-lang.com/) to bundle and process your CSS, then deliver it via the asset pipeline in Rails. This gem provides installers to get you going with the bundler of your choice in a new Rails application, and a convention to use `app/assets/builds` to hold your bundled output as artifacts that are not checked into source control (the installer adds this directory to `.gitignore` by default).
 
-You develop using this approach by running the bundler in watch mode in a terminal with `yarn build:css --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). Whenever the bundler detects changes to any of the stylesheet files in your project, it'll bundle `app/assets/stylesheets/application.[bundler].css` into `app/assets/builds/application.css`. This build output takes over from the regular asset pipeline default file. So you continue to refer to the build output in your layout using the standard asset pipeline approach with `<%= stylesheet_link_tag "application" %>`.
+You develop using this approach by running the bundler in watch mode in a terminal with `yarn build:css --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). You can also use `./bin/dev`, which will start both the Rails server and the CSS build watcher (along with a JS build watcher, if you're also using `jsbundling-rails`).
+
+Whenever the bundler detects changes to any of the stylesheet files in your project, it'll bundle `app/assets/stylesheets/application.[bundler].css` into `app/assets/builds/application.css`. This build output takes over from the regular asset pipeline default file. So you continue to refer to the build output in your layout using the standard asset pipeline approach with `<%= stylesheet_link_tag "application" %>`.
 
 When you deploy your application to production, the `css:build` task attaches to the `assets:precompile` task to ensure that all your package dependencies from `package.json` have been installed via yarn, and then runs `yarn build:css` to process your stylesheet entrypoint, as it would in development. This output is then picked up by the asset pipeline, digested, and copied into public/assets, as any other asset pipeline file.
 
@@ -26,6 +28,16 @@ You must already have node and yarn installed on your system. You will also need
 Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp --css [tailwind|bootstrap|bulma|postcss|sass]`.
 
 
+## FAQ
+
+### How do I import relative CSS files with Tailwind?
+
+If you want to use `@import` statements as part of your Tailwind application.js file, you need to [configure Tailwind to use `postcss` and then `postcss-import`](https://tailwindcss.com/docs/using-with-preprocessors#build-time-imports). But you should also consider simply referring to your other CSS files directly, instead of bundling them all into one big file. It's better for caching, and it's simpler to setup. You can refer to other CSS files by expanding the `stylesheet_link_tag` in `application.html.erb` like so: `<%= stylesheet_link_tag "application", "other", "styles", "data-turbo-track": "reload" %>`.
+
+### How do I avoid SassC::SyntaxError exceptions on existing projects?
+
+Some CSS packages use new CSS features that are not supported by the default SassC rails integration that previous versions of Rails used. If you hit such an incompatibility, it'll likely be in the form of a `SassC::SyntaxError` when running `assets:precompile`. The fix is to `bundle remove sass-rails` (or `sassc-rails`, if you were using that).
+
 ## License
 
 CSS Bundling for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cssbundling/version.rb

@@ -1,3 +1,3 @@
 module Cssbundling
-  VERSION = "0.2.2"
+  VERSION = "0.2.6"
 end

data/lib/install/bootstrap/install.rb

@@ -11,4 +11,10 @@ else
 end
 
 say "Add build:css script"
-run %(npm set-script build:css "sass ./app/assets/stylesheets/application.bootstrap.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules")
+build_script = "sass ./app/assets/stylesheets/application.bootstrap.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules"
+
+if (`npx -v`.to_f < 7.1 rescue "Missing")
+  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
+else
+  run %(npm set-script build:css "#{build_script}")
+end

data/lib/install/bulma/install.rb

@@ -4,4 +4,10 @@ copy_file "#{__dir__}/application.bulma.scss",
 run "yarn add sass bulma"
 
 say "Add build:css script"
-run %(npm set-script build:css "sass ./app/assets/stylesheets/application.bulma.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules")
+build_script = "sass ./app/assets/stylesheets/application.bulma.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules"
+
+if (`npx -v`.to_f < 7.1 rescue "Missing")
+  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
+else
+  run %(npm set-script build:css "#{build_script}")
+end

data/lib/install/dev

@@ -1,3 +1,9 @@
 #!/usr/bin/env bash
 
+if ! command -v foreman &> /dev/null
+then
+  echo "Installing foreman..."
+  gem install foreman
+fi
+
 foreman start -f Procfile.dev

data/lib/install/install.rb

@@ -46,7 +46,7 @@ else
   say "Add default Procfile.dev"
   copy_file "#{__dir__}/Procfile.dev", "Procfile.dev"
 
-  say "Ensure foreman is install"
+  say "Ensure foreman is installed"
   run "gem install foreman"
 end
 

data/lib/install/postcss/install.rb

@@ -1,7 +1,13 @@
-say "Install PostCSS w/ postcss-preset-env"
+say "Install PostCSS w/ nesting and autoprefixer"
 copy_file "#{__dir__}/postcss.config.js", "postcss.config.js"
 copy_file "#{__dir__}/application.postcss.css", "app/assets/stylesheets/application.postcss.css"
-run "yarn add postcss postcss-cli postcss-preset-env"
+run "yarn add postcss postcss-cli postcss-nesting autoprefixer"
 
 say "Add build:css script"
-run %(npm set-script build:css "postcss ./app/assets/stylesheets/application.postcss.css -o ./app/assets/builds/application.css")
+build_script = "postcss ./app/assets/stylesheets/application.postcss.css -o ./app/assets/builds/application.css"
+
+if (`npx -v`.to_f < 7.1 rescue "Missing")
+  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
+else
+  run %(npm set-script build:css "#{build_script}")
+end

data/lib/install/postcss/postcss.config.js

@@ -1,10 +1,6 @@
 module.exports = {
   plugins: [
-    require('postcss-preset-env')({ 
-      stage: 2,
-      features: {
-        'nesting-rules': true
-      }
-    })
+    require('postcss-nesting'),
+    require('autoprefixer'),
   ],
 }

data/lib/install/sass/install.rb

@@ -3,4 +3,10 @@ copy_file "#{__dir__}/application.sass.scss", "app/assets/stylesheets/applicatio
 run "yarn add sass"
 
 say "Add build:css script"
-run %(npm set-script build:css "sass ./app/assets/stylesheets/application.sass.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules")
+build_script = "sass ./app/assets/stylesheets/application.sass.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules"
+
+if (`npx -v`.to_f < 7.1 rescue "Missing")
+  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
+else
+  run %(npm set-script build:css "#{build_script}")
+end

data/lib/install/tailwind/install.rb

@@ -4,4 +4,10 @@ copy_file "#{__dir__}/application.tailwind.css", "app/assets/stylesheets/applica
 run "yarn add tailwindcss@latest postcss@latest autoprefixer@latest"
 
 say "Add build:css script"
-run %(npm set-script build:css "tailwindcss -i ./app/assets/stylesheets/application.tailwind.css -o ./app/assets/builds/application.css")
+build_script = "tailwindcss -i ./app/assets/stylesheets/application.tailwind.css -o ./app/assets/builds/application.css"
+
+if (`npx -v`.to_f < 7.1 rescue "Missing")
+  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
+else
+  run %(npm set-script build:css "#{build_script}")
+end

data/lib/tasks/cssbundling/build.rake

@@ -1,7 +1,9 @@
 namespace :css do
   desc "Build your CSS bundle"
   task :build do
-    system "yarn install && yarn build:css"
+    unless system "yarn install && yarn build:css"
+      raise "cssbundling-rails: Command css:build failed, ensure yarn is installed and `yarn build:css` runs without errors"
+    end
   end
 end
 

data/lib/tasks/cssbundling/clobber.rake

@@ -0,0 +1,6 @@
+namespace :css do
+  desc "Remove CSS builds"
+  task :clobber do
+    rm_rf Dir["app/assets/builds/[^.]*.css"], verbose: false
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cssbundling-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.6
 platform: ruby
 authors:
 - David Heinemeier Hansson
 - Dom Christie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -25,7 +25,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: 
+description:
 email: david@loudthinking.com
 executables: []
 extensions: []
@@ -54,12 +54,13 @@ files:
 - lib/install/tailwind/package.json
 - lib/install/tailwind/tailwind.config.js
 - lib/tasks/cssbundling/build.rake
+- lib/tasks/cssbundling/clobber.rake
 - lib/tasks/cssbundling/install.rake
 homepage: https://github.com/rails/cssbundling-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Bundle and process CSS with Tailwind, Bootstrap, PostCSS, Sass in Rails via
   Node.js.