Skip to content

Latest commit

 

History

History
111 lines (64 loc) · 3.58 KB

README.md

File metadata and controls

111 lines (64 loc) · 3.58 KB
Raw

Python Linters using Ruby 🙉

This repository is about an example of how to build your own python linters from scratch using Ruby.

As you can see in this repository, the main idea is to create python linters, (linters) are the means tool to analyze the source code to detect programming errors, style flaws, bugs, suspicious code, etc. For this reason, linters are used for improving your code, add more quality, making it easy to read, reusable, and easy to maintain in working environments.

Bad Code vs Good Code

How to use it 📜

Follow the next steps to use this repository.

1.- Use your terminal and type git clone 'link' the repository:

> git clone https://github.com/DanteAlonsoHT/Create_my_own_python_linters.git

2.- Once you got the repository in your local environment succeed go-ahead to stay inside the "Create_my_own_python_linters" folder using cd in the terminal. 

> cd Create_my_own_python_linters

3.- Before running the linters, firstly make sure you have your file.py into the ./test folder, and it was named as test.py.

4.- Use the next command to run the python linters:

> ruby ./bin/python_linters.rb

Note: Nothing appears if you don't have errors in your code, but if you have programming errors, you will see something like that:

How to test the project 🔰

Once you've cloned the repository, and you are inside the main folder for the project (as you did in the 2nd step in "How to use it" part above) you can use the next command to test your project:

> rspec ./spec/testing_spec.rb

Feel free to add more test as you want if you think it would be good for your changed project, you can add test in ./spec/testing.rb.

Built With 🔨

  • Ruby
  • Visual Studio Code
  • Git & Github

Install

To get a local copy up and running follow these simple example steps.

  • Open terminal
  • Clone this project with the command git clone https://github.com/DanteAlonsoHT/Create_my_own_python_linters.git
  • Cd Create_my_own_python_linters folder
  • Run bin/python_linters.rb with Ruby in your terminal

Getting Started

  • I've included a gem to improve the ruby coding (you can see how to install it the prerequisites below).
  • I've included linters to improve and cleaning the Ruby code.

Prerequisites

1.- Install the gems required for the repostiry using:

> bundle install
  • IDE to edit and run the code (I used Visual Studio Code 🔥).

Usage

  • For anyone who wants to practice Ruby.
  • How to apply yield in Ruby.

Author

👤 Dante Alonso Hernández Tapia

🤝 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!

Acknowledgments

  • Hat tip to anyone who's code was used 🔰
  • Inspiration 💘
  • Microverse program ⚡
  • My standup team 🏹
  • My family's support 🙌

📝 License

This project is MIT licensed.