This project provides some useful extensions for Arcanist.

• Multi Test Engine
• RSpec Test Engine
• Rubocop Linter
• TAP Test Engine

The easiest way to use the extensions on your own projects is by adding this repository as a git submodule, given you are using git (which you obviously should):

$ git submodule add https://github.com/mdesanti/arcanist-extensions.git .arcanist-extensions
$ git submodule update --init

Then, just list the desired extensions on the load key of your project's .arcconfig file.

{
  "project_id": "my-awesome-project",
  "conduit_uri": "https://example.org",

  "load": [
    ".arcanist-extensions/[extension_name]"
  ]
}

This extension allows you to run tests with multiple test engines. It is usefull when your project has code writen in more than one programming language, or use two different test frameworks.

Above is an example of an .arcconfig file that runs both Ruby tests - with the RSpecTestEngine - and Python tests - with the native Arcanist's PytestTestEngine:

{
  "project_id": "my-awesome-project",
  "conduit_uri": "https://example.org",

  "load": [
    ".arcanist-extensions/rspec_test_engine",
    ".arcanist-extensions/multi_test_engine"
  ],

  "unit.engine": "MultiTestEngine",
  "unit.engine.multi-test.engines": ["RSpecTestEngine", "PytestTestEngine"]
}

You may also specify a configuration for each engine. Below is an example that uses two TapTestEngines with different commands:

{
  "project_id": "my-awesome-project",
  "conduit_uri": "https://example.org",

  "load": [
    ".arcanist-extensions/rspec_test_engine",
    ".arcanist-extensions/tap_test_engine",
    ".arcanist-extensions/multi_test_engine"
  ],

  "unit.engine": "MultiTestEngine",
  "unit.engine.multi-test.engines": [
    "RSpecTestEngine",
    {
      "engine": "TapTestEngine",
      "unit.engine.tap.command": "bundle exec teaspoon -f tap"
    },
    {
      "engine": "TapTestEngine",
      "unit.engine.tap.command": "karma run spec/js/karma.conf"
    }
  ]
}

This extension allows you to run tests with RSpec (version 2 or later). To use it, just set your test engine as RSpecTestEngine:

{
  "project_id": "my-awesome-project",
  "conduit_uri": "https://example.org",

  "load": [
    ".arcanist-extensions/rspec_test_engine"
  ],

  "unit.engine": "RSpecTestEngine"
}

You can change the rspec executable path if it for some reason is not found in your $PATH variable (maybe you are using Bundler without binstubs):

{
  "project_id": "my-awesome-project",
  "conduit_uri": "https://example.org",

  "load": [
    ".arcanist-extensions/rspec_test_engine"
  ],

  "unit.engine": "RSpecTestEngine",
  "unit.engine.rspec.command": "bundle exec rspec"
}

This extension will lint your project using the awesome Rubocop library. It is important to mention that the extension won't install Rubocop, so you must do it manually. Just make sure you have the rubocop executable listed on your $PATH.

Below is an example of an .arclint file that includes the Rubocop Linter:

{
  "linters": {
    "ruby": {
      "type": "rubocop",
      "include": "/\\.(rb|rake)$/",
      "exclude": "(^db/schema\\.rb)"
    }
  }
}

If you need to customize the default style rules, just create a .rubocop.yml file on the root of your project as usual.

For more information regarding Arcanist linters configuration, access the Arcanist Lint User Guide.

This extension implements a generic TAP test engine, so Arcanist may run tests from any tool that has a TAP compatible output.

To use this extension, you must specify the command that will run your tests (just make sure that this command returns a TAP compatible output):

{
  "project_id": "my-awesome-project",
  "conduit_uri": "https://example.org",

  "load": [
    ".arcanist-extensions/tap_test_engine"
  ],

  "unit.engine": "TAPTestEngine",
  "unit.engine.tap.command": "bundle exec rake spec"
}