Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhdez221993/rubocop
The whole idea of this project is to build my own version on a linter build in ruby to check ruby code
https://github.com/mhdez221993/rubocop
linters ruby
Last synced: 1 day ago
JSON representation
The whole idea of this project is to build my own version on a linter build in ruby to check ruby code
- Host: GitHub
- URL: https://github.com/mhdez221993/rubocop
- Owner: Mhdez221993
- Created: 2021-05-07T08:52:41.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2022-05-11T16:41:43.000Z (over 2 years ago)
- Last Synced: 2024-04-20T00:01:16.801Z (6 months ago)
- Topics: linters, ruby
- Language: Ruby
- Homepage:
- Size: 36.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rubocop
This project was built in ruby to check ruby code, it is a linters for beginners, it provides feedback about errors or warning in code little by little.
It was developed following the best practices
In this project we are looking for the following errors:
- Wrong indentation
- Trailing spaces
- New line errors
- Empty files
- Last empty line
[Go Live](https://replit.com/join/nssqxwoaye-mhdez)
## Built With
- Ruby
### Prerequisites
- Installed Ruby
To get a local copy up and running follow these simple example steps.
Go to git clone [email protected]:Mhdez221993/my_lin.git
### Install RSpec
To run the tests locally :
- To instal RSpec for testing please run the following command on your terminal:
`gem install rspec`
### Run tests
To test the code, run `rspec` from the root of the folder using the terminal.
## Instructions
1) Open your terminal:
- On Windows => Win + R
- On Linux => ctrl + alt + T
- On Mac => Control + Option + Shift + T
2) In your terminal run:
- ./bin/main.rb this will inspect all the files in the actual directory
3) you can provide a path to test a specific file in the same directory or outside by typing:
- `./bin/main.rb some_file_in_my_directory.rb`
- `./bin/main.rb ../../some_file.rb`
## Good and bad code examples
### Wrong indentation
~~~ruby
//Good Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
//Bad Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
~~~
### Trailing spaces
~~~ruby
//Good Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
//Bad Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
~~~
### New line errors
~~~ruby
//Good Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
def call_check_last_line
check_last_line unless File.zero?(file)
end
//Bad Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
def call_check_last_line
check_last_line unless File.zero?(file)
end
~~~
### Last empty line
~~~ruby
//Good Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
def call_check_last_line
check_last_line unless File.zero?(file)
end
//Bad Code
def call_check_last_line
check_last_line unless File.zero?(file)
end
def call_check_last_line
check_last_line unless File.zero?(file)
end
~~~
## Authors
👤 **Moises Hernandez Coronado**
- GitHub: [@Mhdez221993](https://github.com/Mhdez221993)
- Twitter: [@MoisesH42060050](https://twitter.com/MoisesH42060050)
- LinkedIn: [Moises Hernandez Coronado](https://www.linkedin.com/in/moises-hernandez-9bbb17145/)
## Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Mhdez221993/my_lin/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- To my coding partner who helped me through all the work
- To my Stand Up Team who kept my morale up!