Giter VIP home page Giter VIP logo

syntax_tree-erb's Introduction

SyntaxTree::ERB

Build Status

Syntax Tree support for ERB.

Currently handles

  • ERB
    • Tags with and without output
    • Tags inside strings
    • if, elsif, else and unless statements
    • blocks
    • comments
    • Formatting of the ruby-code is done by syntax_tree
  • HTML
    • Tags with attributes
    • Tags with and without closing tags
    • Comments
  • Vue
    • Attributes, events and slots using :, @ and # respectively
  • Text output

Unhandled cases

  • Please add to this pinned issue (davidwessman#28) or create a separate issue if you encounter formatting or parsing errors.

Installation

Add this line to your application's Gemfile:

gem "w_syntax_tree-erb", "~> 0.10", require: false

I added the w_ prefix to avoid conflicts if there will ever be an official syntax_tree-erb gem.

Usage

bundle exec stree --plugins=erb "./**/*.html.erb"

From code:

require "syntax_tree/erb"

pp SyntaxTree::ERB.parse(source) # print out the AST
puts SyntaxTree::ERB.format(source) # format the AST

List all parsing errors

In order to get a list of all parsing errors (which needs to be fixed before the formatting works), this script can be used:

#!/bin/ruby

require "syntax_tree/erb"

failures = []

Dir
  .glob("./app/**/*.html.erb")
  .each do |file|
    puts("Processing #{file}")
    begin
      source = SyntaxTree::ERB.read(file)
      SyntaxTree::ERB.parse(source)
      SyntaxTree::ERB.format(source)
    rescue => exception
      failures << { file: file, message: exception.message }
    end
  end

puts failures

Development

Setup linting:

npm run prepare

Install dependencies and run tests:

bundle
bundle exec rake

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/davidwessman/syntax_tree-erb.

License

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

syntax_tree-erb's People

Contributors

davidwessman avatar dependabot[bot] avatar github-actions[bot] avatar kddnewton 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.