sassc-embedded 1.63.0 → 1.78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d7ed4c41b59c9da71323d18edaf73506cf634a2e9039fc050077a46acc0bb04
-  data.tar.gz: 63a8b3809af3bb71724361f1bb1123486fd4f30b4e503d0c2ded02c9d05016e1
+  metadata.gz: 6436923b7f104059a6be6bf037be772b3191a12478b44457dcddd6dd2913e4b2
+  data.tar.gz: 81e184f8d2f343d23c7d8228e4cb62c7aa7343cfb609ff93aa3793b3af4abb05
 SHA512:
-  metadata.gz: 1d1b9e29fb88ed4b1fa114ec9ff657b9b62f913da04a7201ceebd13e5d6c66d9228cae4076beb8319f7344372a592f78063ee9311e0c22fd47b02e8d9f61bba2
-  data.tar.gz: f28204b7ca9218f562a7fae9984dbece8afaacd36f26ee9726eac40d7e90c4076f231a4e1138e0a0be9e229581920953b60f3e74542131dc74acbac10529fb95
+  metadata.gz: '09ad73cfc4311af1d2c2219b897a3d2a4393c7ed000736187bca650c94941470445a022f1299eb9d5ddb8defc118addb647560f8c703919e0319353a9d9acd63'
+  data.tar.gz: 6891a983e30abec954405faca7b83ab3f4f2d9ecfc72f4724319c82f90f8c29eed650d73f14efc85b7003eb97747cbc3b52bb34e9ae6ec9f342c41257a4817fd

data/README.md

@@ -1,25 +1,34 @@
 # Embedded Sass Shim for SassC Ruby
 
-[![build](https://github.com/ntkme/sassc-embedded-shim-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ntkme/sassc-embedded-shim-ruby/actions/workflows/build.yml)
+[![build](https://github.com/sass-contrib/sassc-embedded-shim-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/sass-contrib/sassc-embedded-shim-ruby/actions/workflows/build.yml)
 [![gem](https://badge.fury.io/rb/sassc-embedded.svg)](https://rubygems.org/gems/sassc-embedded)
 
 Use `sass-embedded` with SassC Ruby!
 
-This library shims [`sassc`](https://github.com/sass/sassc-ruby) with the [`sass-embedded`](https://github.com/ntkme/sass-embedded-host-ruby) implementation.
-
-It has been tested with:
-
-- [`sassc`](https://github.com/sass/sassc-ruby)
-- [`sassc-rails`](https://github.com/sass/sassc-rails)
-- [`sprockets`](https://github.com/rails/sprockets)
-- [`sprockets-rails`](https://github.com/rails/sprockets-rails)
+This library shims [`sassc`](https://github.com/sass/sassc-ruby) with the [`sass-embedded`](https://github.com/sass-contrib/sass-embedded-host-ruby) implementation.
+
+## Which Sass implementation should I use for my Ruby project?
+
+- [`sass-embedded`](https://github.com/sass-contrib/sass-embedded-host-ruby) is recommended for all projects. It is compatible with:
+  - [`dartsass-rails >=0.5.0`](https://github.com/rails/dartsass-rails)
+  - [`haml >=6.0.9`](https://github.com/haml/haml)
+  - [`silm >=5.2.0`](https://github.com/slim-template/slim)
+  - [`sinatra >=3.1.0`](https://github.com/sinatra/sinatra)
+  - [`tilt >=2.0.11`](https://github.com/jeremyevans/tilt)
+- [`sassc-embedded`](https://github.com/sass-contrib/sassc-embedded-shim-ruby) is recommended for existing projects still using `sassc` or `sprockets`. It is compatible with:
+  - [`dartsass-sprockets`](https://github.com/tablecheck/dartsass-sprockets)
+  - [`sassc`](https://github.com/sass/sassc-ruby)
+  - [`sassc-rails`](https://github.com/sass/sassc-rails)
+  - [`sprockets`](https://github.com/rails/sprockets)
+  - [`sprockets-rails`](https://github.com/rails/sprockets-rails)
+- [`sassc`](https://github.com/sass/sassc-ruby) [is deprecated](https://sass-lang.com/blog/libsass-is-deprecated/).
+- [`sass`](https://github.com/sass/ruby-sass) [has reached end-of-life](https://sass-lang.com/blog/ruby-sass-is-unsupported/).
 
 ## Install
 
-Add these lines to your application's Gemfile:
+Add this line to your application's Gemfile:
 
 ``` ruby
-gem 'sassc', github: 'sass/sassc-ruby', ref: 'refs/pull/233/head'
 gem 'sassc-embedded'
 ```
 
@@ -35,12 +44,6 @@ Or install it yourself as:
 gem install sassc-embedded
 ```
 
----
-
-The fork of `sassc` at https://github.com/sass/sassc-ruby/pull/233 removes the libsass extension and loads the shim when `require 'sassc'` is invoked.
-
-Alternatively, the original `sassc` gem can be used, but you must explictly call `require 'sassc-embedded'` to load the shim.
-
 ## Usage
 
 This shim utilizes `sass-embedded` to allow you to compile SCSS or SASS syntax to CSS. To compile, use a `SassC::Engine`, e.g.:
@@ -51,14 +54,77 @@ require 'sassc-embedded'
 SassC::Engine.new(sass, style: :compressed).render
 ```
 
-See [rubydoc.info/gems/sassc](https://rubydoc.info/gems/sassc) for full API documentation.
+Most of the original `sassc` options are supported with no behavior difference unless noted otherwise:
+
+- `:filename`
+- `:quiet`
+- ~~`:precision`~~ - ignored
+- ~~`:line_comments`~~ - ignored
+- `:syntax`
+- `:source_map_embed`
+- `:source_map_contents`
+- `:omit_source_map_url`
+- `:source_map_file`
+- `:importer`
+- `:functions`
+- `:style` - ~~`:nested`~~ and ~~`:compact`~~ behave as `:expanded`
+- `:load_paths`
+
+See [`sassc-ruby` source code](https://github.com/sass/sassc-ruby/blob/master/lib/sassc/engine.rb) and [`libsass` documentation](https://github.com/sass/libsass/blob/master/docs/api-context.md) for details.
+
+Additional `sass-embedded` options are supported:
+
+- `:charset`
+- `:importers`
+- `:alert_ascii`
+- `:alert_color`
+- `:fatal_deprecations`
+- `:future_deprecations`
+- `:logger`
+- `:quiet_deps`
+- `:silence_deprecations`
+- `:verbose`
+
+See [`sass-embedded` documentation](https://rubydoc.info/gems/sass-embedded/Sass#compile_string-class_method) for details.
+
+## Troubleshooting
+
+### The original `sassc` gem is still being used instead of `sassc-embedded`
+
+When launching an application via `bundle exec`, it puts `sassc-embedded` at higher priority than `sassc` in `$LOAD_PATH`. You can verify the order of `$LOAD_PATH` with the following command:
+
+``` ruby
+bundle exec ruby -e 'puts $LOAD_PATH'
+```
+
+If you see `sassc` has higher priority than `sassc-embedded`, try remove `sassc`:
 
-## Behavioral Differences from SassC Ruby
+```
+bundle remove sassc
+```
+
+If your application has a transitive dependency on `sassc` that cannot be removed, you can use one of the following workarounds.
+
+#### Workaround One
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'sassc', github: 'sass/sassc-ruby', ref: 'refs/pull/233/head'
+```
 
-1. Option `:style => :nested` and `:style => :compact` behave as `:style => :expanded`.
+And then execute:
+
+``` sh
+bundle
+```
 
-2. Option `:precision` is ignored.
+The fork of `sassc` at https://github.com/sass/sassc-ruby/pull/233 will load the shim whenever `require 'sassc'` is invoked, meaning no other code changes needed in your application.
 
-3. Option `:line_comments` is ignored.
+#### Workaround Two
 
-See [the dart-sass documentation](https://github.com/sass/dart-sass#behavioral-differences-from-ruby-sass) for other differences.
+Add this line to your application's code:
+
+``` ruby
+require 'sassc-embedded'
+```

data/lib/sassc/embedded/version.rb

@@ -2,6 +2,6 @@
 
 module SassC
   module Embedded
-    VERSION = '1.63.0'
+    VERSION = '1.78.0'
   end
 end