https://github.com/koic/minifyrb
A minifier of Ruby files.
https://github.com/koic/minifyrb
minify minify-ruby ruby uglify
Last synced: about 1 year ago
JSON representation
A minifier of Ruby files.
- Host: GitHub
- URL: https://github.com/koic/minifyrb
- Owner: koic
- License: mit
- Created: 2024-07-29T02:07:30.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-02T17:04:38.000Z (over 1 year ago)
- Last Synced: 2025-04-11T12:20:22.194Z (about 1 year ago)
- Topics: minify, minify-ruby, ruby, uglify
- Language: Ruby
- Homepage:
- Size: 68.4 KB
- Stars: 19
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Minify Ruby
[](https://badge.fury.io/rb/minifyrb)
[](https://github.com/koic/minifyrb/actions/workflows/test.yml)
A minifier of Ruby files.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'minifyrb'
```
And then execute:
```console
$ bundle install
```
Or install it yourself as:
```console
$ gem install minifyrb
```
## Usage
For execution from the command line, use `minifyrb` command:
```console
$ cat path/to/example.rb
def foo
bar(arg, **options) do
baz.qux
end
end
$ minifyrb path/to/example.rb
def foo;bar(arg,**options) do baz.qux;end;end
```
You can check the command line options with `-h` or `--help`:
```console
$ minifyrb -h
Usage: minifyrb [options] [file1, file2, ...]
-v, --version Output the version number.
-o, --output Output file (default STDOUT).
```
### Rake Task
You can define a Rake task for Minify. Please write the following code in your Rakefile:
```ruby
# Rakefile
require 'minifyrb/rake_task'
Minifyrb::RakeTask.new
```
The task `rake minifyrb` will be defined:
```console
$ bundle exec rake -T
rake minifyrb # Minify Ruby files in the current directory and subdirectories
```
### Ruby API
From Ruby code, use `Minifyrb::Minifier#minify` API:
```ruby
require 'minifyrb'
source = <<~'RUBY'
def say(name)
puts "Hello, #{name}!"
end
RUBY
Minifyrb::Minifier.new(source).minify # => "def say(name)puts\"Hello, \#{name}!\";end\n"
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/koic/minifyrb.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).