Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohamedsabry0/rulint
Basic Ruby conventional rules linter. Using Ruby. From scratch using regex with OOP structure and unit testing.
https://github.com/mohamedsabry0/rulint
rspec ruby
Last synced: 21 days ago
JSON representation
Basic Ruby conventional rules linter. Using Ruby. From scratch using regex with OOP structure and unit testing.
- Host: GitHub
- URL: https://github.com/mohamedsabry0/rulint
- Owner: mohamedSabry0
- Created: 2020-08-12T16:40:40.000Z (over 4 years ago)
- Default Branch: development
- Last Pushed: 2020-08-27T14:26:52.000Z (over 4 years ago)
- Last Synced: 2024-12-28T06:59:25.240Z (about 1 month ago)
- Topics: rspec, ruby
- Language: Ruby
- Homepage: https://repl.it/@mohammadSabri/ruLint
- Size: 61.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ruLint
simple ruby linter with basic functionalities that will look only
for naming conventions for variables, classes and modules
## Introduction Video
[Loom Link](https://www.loom.com/share/c976b700082e426993e9bafcb9fe7f1f)
[](https://github.com/mohamedSabry0/ruLint)
[](https://github.com/umohamedSabry0/ruLint/issues)
[](https://github.com/mohamedSabry0/ruLint/pulls)
[](/LICENSE)
## Getting Started
### The Followed Style Guide
- [Guide](https://rubystyle.guide/#camelcase-classes)
- Please refer to this guide for any concerns about the followed rules for this linter
### Live Demo
- [Demo](https://repl.it/@mohammadSabri/ruLint)
- to run online type `bin/ruLint` in the interactive shell
- to run tests online type `rspec` in the interactive shell
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Text Editor (VSCode is suggested.)
- [Ruby](https://ruby-doc.org/downloads/)
### Setup
- Install [git](https://git-scm.com/downloads)
- Open Terminal
- Change directory to folder to download repository
- Use `cd `
- Run `git clone https://github.com/mohamedSabry0/ruLint.git`
- Install [Ruby](https://ruby-doc.org/downloads/)
- `cd ruLint`
#### Testing
- Install `gem install rspec`
- Initialize `rspec --init`
- create a new file on the project's root directory `touch example.rb`
- copy all the code provided in [Example Input File section](#example-input-file) and make sure to include all the lines
- paste that code in the `example.rb` and save
- Run `rspec`
**Note: without the mentioned file all the tests will fail**
### Use Instruction
#### using the example
- copy the code example provided below in [Example Input File section](#example-input-file) and add it to a new ruby file in a directory
- in terminal `cd` to that `dir` then apply the following steps:
- run `bin/ruLint` command
**or**
- give it file paths as arguments to run on specific ones e.g:
`bin/ruLint file1 dir/file2.rb`
#### a bit shorter running command
- if you have the following directory in your PATH
`/usr/local/bin/`
- you can run this in your terminal from the project directory
`ln -s $PWD/bin/ruLint /usr/local/bin/`
- then simply use command `ruLint` instead of `bin/ruLint`
### Example Input File
```
# rubocop:disable all
class bad_example
end
class bad; end
class Bad_Example
end
class GoodExample
var = 1
sec += 1
end
class Mu_Foo; end
class BADNAME
end
class badname; end
class GoodName; end
module bad_example
end
module bad; end
module Bad_Example
end
module GoodExample
var = 1
sec += 1
end
module Mu_Foo; end
module BADNAME
end
module badname; end
module GoodName; end
```
### Example Output
```
naming_warning @(example.rb, line#2):
'bad_example' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#5):
'bad' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#7):
'Bad_Example' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#15):
'Mu_Foo' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#20):
'badname' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#23):
'bad_example' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#26):
'bad' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#28):
'Bad_Example' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#36):
'Mu_Foo' is not a good class/module name. Follow CamelCase naming convention
naming_warning @(example.rb, line#41):
'badname' is not a good class/module name. Follow CamelCase naming convention
```
## Built With
- Ruby
### Author
👤 **Mohamed Sabry**
- Github: [@mohamedSabry0](https://github.com/mohamedSabry0)
- Twitter: [@mohsmh0](https://twitter.com/mohsmh0)
- Linkedin: [Mohamed Sabry](https://www.linkedin.com/in/mohamed-sabry-1322b1105/)
## 🤝 Contributing
Contributions, issues and feature requests are welcome! Start by:
- Forking the project
- Cloning the project to your local machine
- `cd` into the project directory
- Run `git checkout -b your-branch-name`
- Make your contributions
- Push your branch up to your forked repository
- Open a Pull Request with a detailed description to the development branch of the original project for a review
## Show your support
Give a ⭐️ if you like this project!