Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 2.99 KB

README.md

File metadata and controls

82 lines (56 loc) · 2.99 KB
Raw

JavaScript Mini linter

This is a Javascript Mini Linter built using OOP in Ruby.

What this linter can check

Javascript Mini Linter can scan and report common errors like:

  • Redundant indentation;
  • Extra space at the end of a line;
  • Stylistic naming of functions (CamelCase over snake_case);
  • Missing parentheses in function declaration;
  • Missing opening/closing curly braces in function declaration;

Built With

  • Ruby
  • VS code
  • Linters (RuboCop)

Getting Started

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

  • On the project GitHub page, navigate to the main page of the repository this page.
  • Under the repository name, locate and click on a green button named Code.
  • Copy the project URL as displayed.
  • If you're running Windows Operating System, open your command prompt. On Linux, Open your terminal.
  • Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.
  • Type git clone, and then paste the URL you copied in Step 3.
    $ git clone https://github.com/SarvarKh/Customized-Linter Press Enter key
  • Press Enter. Your local copy will be created.

Please Note that you must have Git installed on your PC, this can be done here.

How to run JS Mini Linter?

  1. Follow Getting Started section to download the game
  2. Open/navigate to the project directory in your terminal
  3. Type main.rb and include the file's location and its title that need to be scanned for Linter errors in your terminal. For instance from your root directory: ruby ./bin/main.rb ./samples/javascript_test_01.js.
  4. You must see Linter errors in your terminal, like shown below:

How to run RSpec test?

  1. Follow Getting Started section to download the game
  2. Open/navigate to the project directory in your terminal
  3. Run rspec in your terminal to see if the test cases passes your RSpec test You shall see number of test cases and number of failures.
  4. Open the link Introduction to RSpec if you want to learn more about RSpec.

Authors

👤 Sarvar Khalimov

🤝 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

  • Microverse

📝 License

This project is MIT licensed.