Miniparser/README.md
Connor C 8b1feef896 Small readme update to test webhook
Signed-off-by: Connor C <ceo@pixelridgesoftworks.com>
2023-10-06 16:13:12 -06:00

1.4 KiB

Miniparser

Miniparser is a Ruby gem that takes code as input (HTML, JavaScript, or CSS), determines the code language, validates it, and then minifies it. It returns whether the code is valid or not, and if valid, provides the minified code.

Installation

Add this line to your application's Gemfile:

gem 'Miniparser'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install Miniparser

Usage

Miniparser provides two main methods to process either a file or a string containing HTML, JavaScript, or CSS code.

Processing a File

You can process a file by calling the type_file method and passing the file path as an argument:

result = Miniparser::Processor.type_file('path/to/yourfile.html')

Processing a String

You can process a string containing code by calling the type_string method:

result = Miniparser::Processor.type_string('<html><head></head><body></body></html>')

Both methods return a hash containing the validation status, any errors, and the minified code if the input was valid:

{
  valid: true or false,
  errors: "Error message if any",
  minified_code: "Minified code if valid"
}

Contributing

Bug reports and pull requests are welcome. Please adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.