https://github.com/acushlakoncept/ruby-linter
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 warning 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.
https://github.com/acushlakoncept/ruby-linter
gem linters oop regex rspec ruby ruby-linter
Last synced: 5 months ago
JSON representation
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 warning 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.
- Host: GitHub
- URL: https://github.com/acushlakoncept/ruby-linter
- Owner: acushlakoncept
- License: mit
- Created: 2020-07-15T09:23:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-18T10:07:06.000Z (over 5 years ago)
- Last Synced: 2025-06-30T10:02:50.130Z (5 months ago)
- Topics: gem, linters, oop, regex, rspec, ruby, ruby-linter
- Language: Ruby
- Homepage:
- Size: 49.8 KB
- Stars: 11
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ruby Capstone Project - Ruby Linter
[](https://github.com/acushlakoncept/ruby-linter)
[](https://github.com/acushlakoncept/ruby-linter/issues)
[](https://github.com/acushlakoncept/ruby-linter/pulls)
# 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
~~~ruby
# 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
~~~ruby
# 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
~~~ruby
# 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
~~~ruby
# 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
~~~ruby
# 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
```
```
$ git clone https://github.com/acushlakoncept/ruby-linter.git
```
**To check for errors on a file:**
~~~bash
$ 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
~~~bash
$ bundle install
~~~
> But before that, make sure you have **bundler** installed on your system, else run
~~~bash
$ gem install bundler
~~~
> or you simply install the the following directly using
~~~bash
$ gem install rspec
~~~
~~~bash
$ gem install colorize
~~~
# Author
👤 **Uduak Essien**
- Github: [@acushlakoncept](https://github.com/acushlakoncept/)
- Twitter: [@acushlakoncept](https://twitter.com/acushlakoncept)
- Linkedin: [acushlakoncept](https://www.linkedin.com/in/acushlakoncept/)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Project inspired by [Microverse](https://www.microverse.org)