Skip to content

svs14/guard-julia

Repository files navigation

Guard::Julia

Gem Version Build Status Dependency Status Code Climate Coverage Status Inline docs

Julia guard automatically launches respective tests when Julia files are modified.

The codebase's architecture is largely derived from guard-minitest.

Installation

Ruby must be installed, then run:

$ gem install bundler
$ cd /your/julia/project/dir
$ bundle init

Add this line to your project's newly created Gemfile:

gem 'guard-julia'

And then execute:

$ bundle

Usage

Please read Guard usage documentation.

To create the Guardfile run:

$ bundle exec guard init julia

Then run guard itself:

$ bundle exec guard

Options

all_on_start: true # Run all tests on startup
julia_file_path: 'julia' # File path to Julia executable
all_tests_file: 'test/runtests.jl' # File to run all tests
cli: ['--code-coverage'] # CLI arguments to Julia
env: {} # Environment variables

You can pass any of these options in the Guardfile like so:

guard :julia, cli: ['--code-coverage', '-p 1'] do
  # ...
end

Contributing

  1. Fork it ( http://github.com/svs14/guard-julia/fork )
  2. Get all dependencies (bundle)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Make sure tests pass (bundle exec rake test)
  6. Follow RuboCop's advice (bundle exec rubocop)
  7. Push to the branch (git push origin my-new-feature)
  8. Create new Pull Request

About

Guard plugin for Julia development.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages