Set of Arcanist classes for working with applications written in CoffeeScript
PHP
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lint
.gitignore
LICENSE.txt
README.md
__phutil_library_init__.php
__phutil_library_map__.php
license.json

README.md

arcanist-coffee-lib

Set of Arcanist classes for working with applications written in CoffeeScript.

General usage

Typically, you will want to clone this repository next to your project and your own Arcanist library, then load it in your .arcconfig:

...
"load": [
  "arcanist-coffee-lib",
  "your-library"
],
...

Then you can construct and configure the classes, e.g. in your lint engine:

<?php
final class SampleLintEngine extends ArcanistLintEngine {
  public function buildLinters() {
    $paths = $this->getPaths();

    // Remove any paths that don't exist before we add paths to linters. We want
    // to do this for linters that operate on file contents because the
    // generated list of paths will include deleted paths when a file is removed.
    // Also remove directories, as the linters expect files
    foreach ($paths as $key => $path) {
      if (!$this->pathExists($path) || is_dir($path)) {
        unset($paths[$key]);
      }
    }

    // skip external libraries
    $paths = preg_grep('@/vendor/@', $paths, PREG_GREP_INVERT);

    $linters = array();

    // linters for specific file types
    $linters['COFFEESCRIPT'] = new ArcanistCoffeeLintLinter();
    $linters['COFFEESCRIPT']->setPaths(preg_grep('@\.coffee$@', $paths));

    $linters['JSON'] = new ArcanistJsonlintLinter();
    $linters['JSON']->setPaths(preg_grep('@\.json$@', $paths));

    return $linters;
  }
}
?>

CoffeeLint linter

CoffeeLint linter is configurable by supplying a JSON file as described on CoffeeLint homepage. The file can be then pointed to in your .arcconfig with (paths are relative to .arcconfig location):

"lint.coffeelint.config": "coffeelint.json"

License

Copyright 2015 Evidence Prime, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.