Ruby Capstone Project - Ruby Linter

About

The whole idea of writing code to check another code is intriguing at the same time cognitively demanding. Building Linters for Ruby, the project provides feedback about errors or warnings in code little by little. The project was built completely with Ruby following all possible best practices. Rubocop was used as a code-linter alongside Gitflow to ensure I maintain good coding standards.

The Build

The custom Ruby linter currently checks/detects for the following errors/warnings.

• check for wrong indentation
• check for trailing spaces
• check for missing/unexpected tags i.e. '( )', '[ ]', and '{ }'
• check missing/unexpected end
• check empty line error

Below are demonstrations of good and bad code for the above cases. I will use the pipe '|' symbol to indicate cursor position where necessary.

Indentation Error Check

# Good Code

class Ticket
  def initialize(venue, date)
    @venue = venue
    @date = date
  end
end

# Bad Code

class Ticket
  def initialize(venue, date)
    @venue = venue
      @date = date
  end
end

Trailing spaces

note where the cursor(|) is on the bad code

# Good Code

class Ticket
  def initialize(venue, date)
    @venue = venue
    @date = date
  end
end

# Bad Code

class Ticket
  def initialize(venue, date)  |
    @venue = venue
    @date = date
  end
end

Missing/Unexpected Tag

# Good Code

class Ticket
  def initialize(venue, date)
    @venue = venue
    @date = date
  end
end

# Bad Code

class Ticket
  def initialize(venue, date
    @venue = venue
    @date = [[date]
  end
end

Missing/unexpected end

# Good Code

class Ticket
  def initialize(venue, date)
    @venue = venue
    @date = date
  end
end

# Bad Code

class Ticket
  def initialize(venue, date)
    @venue = venue
    @date = date
  end
  end
end

Empty line error

# Good Code

class Ticket
  def initialize(venue, date)
    @venue = venue
    @date = date
  end
end

# Bad Code

class Ticket
  def initialize(venue, date)

    @venue = venue
    @date = date
  end
end

Built With

• Ruby
• RSpec for Ruby Testing

Getting Started

To get a local copy of the repository please run the following commands on your terminal:

$ cd <folder>

$ git clone https://github.com/acushlakoncept/ruby-linter.git

To check for errors on a file:

$ bin/main bug.rb

Testing

To test the code, run rspec from root of the folder using terminal. Note: bug.rb has been excluded from rubocop checks to allow RSpec testing without interfering with Gitflow actions

Rspec is used for the test, to install the gem file, run

$ bundle install 

But before that, make sure you have bundler installed on your system, else run

$ gem install bundler 

or you simply install the the following directly using

$ gem install rspec 

$ gem install colorize 

Author

👤 Uduak Essien

• Github: @acushlakoncept
• Twitter: @acushlakoncept
• Linkedin: acushlakoncept

🤝 Contributing

Contributions, issues and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Project inspired by Microverse