Giter Club home page Giter Club logo

beautify's Introduction

beautify

docs Build Status GitHub release

beautify embeds the js-beautify package with Crystal bindings via duktape.cr, inspired by html-minifier.

It can be used to beautify HTML, JS or CSS content.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      beautify:
        github: Daniel-Worrall/beautify
        version: ~> 0.2.0
  2. Run shards install

Beautify

require "beautify"

Beautify.js(js_content)
Beautify.html(html_content)
Beautify.css(css_content)

By default, these run on a single runtime which lazily initialise each beautify package.

Runtimes can be created as needed and called in a similar fashion.

require "beautify"

runtime = Beautify::Runtime.new

runtime.js(js_content)
runtime.html(html_content)
runtime.css(css_content)

Runtimes are not parallel safe. A mutex around runtime calls are appropriate.

Contributing

There is a provided githook that will check code formatting and specs before commiting. You can run make init or git config core.hooksPath .githooks to use this.

  1. Fork it (https://github.com/Daniel-Worrall/beautify/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

beautify's People

Contributors

daniel-worrall avatar grkek avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.