Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noesya/purgecss_sprockets
Use PurgeCSS in Rails asset pipeline.
https://github.com/noesya/purgecss_sprockets
Last synced: about 2 months ago
JSON representation
Use PurgeCSS in Rails asset pipeline.
- Host: GitHub
- URL: https://github.com/noesya/purgecss_sprockets
- Owner: noesya
- License: mit
- Created: 2021-11-18T14:40:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-26T09:08:31.000Z (almost 3 years ago)
- Last Synced: 2024-11-09T22:33:34.468Z (2 months ago)
- Language: Ruby
- Size: 13.7 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PurgeCSS Sprockets
Reduce CSS file size by removing unused selectors with PurgeCSS in Rails asset pipeline.
## Installation
### Ruby Gem
Add this line to your application's Gemfile:
```ruby
gem 'purgecss_sprockets'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install purgecss_sprockets
### JS library
Install PurgeCSS in your Rails application if you don't have it:
$ yarn add purgecss
Run the config file generator:
$ rails g purgecss_sprockets:install
## Usage
This gem is intended to be used as a post processor step in your asset pipeline:
$ bundle exec rake assets:precompile
You can temporarily disable the processor or re-configure how PurgeCSS is called in an initializer:
`config/initializers/purgecss_sprockets.rb`:
```ruby
PurgecssSprockets.disabled = true # default: false
PurgecssSprockets.purgecss_cmd = "node node_modules/purgecss/bin/purgecss.js"
```
You can exclude some entrypoints by filling the `exclude_files` in the initializer:
```ruby
PurgecssSprockets.exclude_files = %w(
app/assets/stylesheets/admin.sass
)
```
You can configure PurgeCSS with the generated `purgecss.config.js`.
## Debug
- In an initializer, disable the PurgecssSprockets' post-processor.
- Run `rails assets:clobber assets:precompile`
- Open a Rails console and run this:
```ruby
json = JSON.parse(`node node_modules/purgecss/bin/purgecss.js --css public/assets/[your-digested-css-file].css --config purgecss.config.js --rejected`)[0]
```
- You can now check which selectors are rejected by PurgeCSS in `json['rejected']`.
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/noesya/purgecss_sprockets. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/noesya/purgecss_sprockets/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the PurgeCSS Sprockets project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/noesya/purgecss_sprockets/blob/main/CODE_OF_CONDUCT.md).