Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sass-contrib/sassc-embedded-shim-ruby
:gem: A Ruby shim for SassC that will communicate with Embedded Dart Sass using the Embedded Sass protocol
https://github.com/sass-contrib/sassc-embedded-shim-ruby
dart-sass rails ruby sass sass-embedded sassc sassc-rails scss sprockets sprockets-rails
Last synced: 6 days ago
JSON representation
:gem: A Ruby shim for SassC that will communicate with Embedded Dart Sass using the Embedded Sass protocol
- Host: GitHub
- URL: https://github.com/sass-contrib/sassc-embedded-shim-ruby
- Owner: sass-contrib
- License: mit
- Created: 2022-03-21T00:13:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-27T07:09:16.000Z (about 1 month ago)
- Last Synced: 2024-12-23T07:06:20.616Z (13 days ago)
- Topics: dart-sass, rails, ruby, sass, sass-embedded, sassc, sassc-rails, scss, sprockets, sprockets-rails
- Language: Ruby
- Homepage: https://rubygems.org/gems/sassc-embedded
- Size: 287 KB
- Stars: 19
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Embedded Sass Shim for SassC Ruby
[](https://github.com/sass-contrib/sassc-embedded-shim-ruby/actions/workflows/build.yml)
[](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/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) [has reached end-of-life](https://github.com/sass/sassc-ruby/blob/HEAD/README.md#sassc-has-reached-end-of-life).
- [`sass`](https://github.com/sass/ruby-sass) [has reached end-of-life](https://sass-lang.com/blog/ruby-sass-is-unsupported/).
## Install
Add this line to your application's Gemfile:
``` ruby
gem 'sassc-embedded'
```
And then execute:
``` sh
bundle
```
Or install it yourself as:
``` sh
gem install sassc-embedded
```
## 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.:
``` ruby
require 'sassc-embedded'
SassC::Engine.new(sass, style: :compressed).render
```
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`:
```
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'
```
And then execute:
``` sh
bundle
```
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.
#### Workaround Two
Add this line to your application's code:
``` ruby
require 'sassc-embedded'
```