linter-ruby

In this project, I built my linter tool, to check errors in ruby grammar. I chose a bot to check simple and common errors when typing ruby code because this is normally annoying when you try to keep code clean.

Linter Instructions

• This code gives information about errors in ruby typing
• Each time you run the code, it will review the ./lib/tester.rb file, which stores an example of a bad code.
• You can modify the ./lib/tester.rb file to see how it changes the different recommendations about correct typing of your code, given in your console.

Examples Good VS Bad code

Unexpected or missed end

It checks if it is necessary to add or remove an end to close a block code.

Example of Bad code

class Test
  def test_method(arg)
    x = arg + arg
        <---- Missed end
end 

Example of Good code

class Test
  def test_method(arg)
    x = arg + arg
  end   <---- Unmissed end
end 

Unexpected or missed parentheses

It checks if it is necessary to add or remove a parenthesis in a specific line of code

Example of Bad code

def  test_method(arg))  <---- Unexpected parentheses
  x = arg + arg   
end 

Example of Good code

def  test_method(arg)  <---- Expected parentheses
  x = arg + arg   
end

Unexpected or missed square bracket

It checks if it is necessary to add or remove a square bracket in a specific line of code

Example of Bad code

arr = [2, 3, 5]  
x = arr[1  <---- Missed square bracket

Example of Good code

arr = [2, 3, 5]  
x = arr[1]  <---- Expected square bracket

Unexpected or missed curly brace

It checks if it is necessary to add or remove a curly brace in a specific line of code

Example of Bad code

test.each { |elem| elem + 2  <---- Missed curly brace

Example of Good code

test.each { |elem| elem + 2 }  <---- Unmissed curly brace

Look for double spaces

It checks if there is any double space in a specific line of code

Example of Bad code

class | Test  <---- Double space between class and Test

Example of Good code

class Test  <---- Correct space between class and Test

Look for spaces at end of the line

It checks if there is any space at the end in a specific line of code

Example of Bad code

class Test  |  <---- There is a space at the end of the code line

Example of Good code

class Test|  <---- Not space at the end of code line

Built With

• Ruby

• Rubocop linters

• Rspec test

Getting Started

• Make sure Ruby is installed on your computer

• To get your copy of our project simply clone the repository to your local machine.

• Open CMD

• Type the following command into a git-shell

  git clone https://github.com/marilirulita/linter-ruby.git
  

• Run the program from the command line, then open it in a text editor

How to run this project

Run the following command in the terminal

• Navigagte into the linter-ruby folder

  cd linter-ruby
  

• Execute the "main.rb" file typing:

  ruby ./bin/main.rb
  

• You will see error messages in your console to help you fix your code typing

  Line 17, there is a space at the end
  Line 27, there is a double space between words
  

Authors

👤 Mar y Sol Bautista

• GitHub: @marilirulita
• Linkedin: Mar y Sol Bautista
• Twiter: @marylirulita

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!