Attractor Javascript Plugin
Attractor plugin for the Javascript programming language and its ecosystem
Table of Contents
- Table of Contents
- Getting Started
- Installation
- Usage
- Contributing
Getting Started
This is a plugin to help you visualize code complexity metrics for your Javascript code. If you are not familiar with Attractor, take a look at the main repo first.
Installation
Add this to your application's Gemfile:
gem 'attractor'
gem 'attractor-javascript'
And then execute:
bundle install
Usage
To create a HTML report in attractor_output/index.html
, try
bundle exec attractor report
If you'd like to specify a directory, use the file prefix option:
bundle exec attractor report --file_prefix app/models
Or shorter:
bundle exec attractor report -p app/models
Watch for file changes:
bundle exec attractor report -p app/models --watch
Serve at http://localhost:7890:
bundle exec attractor serve -p app/models
Enable rack-livereload:
bundle exec attractor serve -p app/models --watch
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Manuel Tancoigne 💻 |
Andrew Mason 📖 💻 |
Julian Rubisch 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!