Giter VIP home page Giter VIP logo

swift-linter's Introduction

swift-linter

Installation

What you want to get is to make this module to be available for arcanist. There are a couple of ways to achieve it depending on your requirements.

Prerequisites

Right now swiftlint should be installed beforehand. On OS X you can do it through homebrew brew install swiftlint.

You also have to configure your rules in .swiftlint.yml (documentation)

Project-specific installation

You can add this repository as a git submodule and in this case .arcconfig should look like:

{
  "load": ["path/to/submodule"]
  // ...
}

Global installation

arcanist can load modules from an absolute path. But there is one more trick - it also searches for modules in a directory up one level from itself.

It means that you can clone this repository to the same directory where arcanist and libphutil are located. In the end it should look like this:

> ls
arcanist
swift-linter
libphutil

In this case you .arcconfig should look like

{
  "load": ["swift-linter"]
  // ...
}

Another approach is to clone swift-linter to a fixed location and use absolute path like:

cd ~/.dev-tools
git clone https://github.com/vhbit/swift-linter
{
  "load": ["~/.dev-tools/swift-linter"]
  // ...
}

Both ways of global installation are actually almost equally as in most cases you'd like to have a bootstrapping script for all tools.

Setup

Once installed, linter can be used and configured just as any other arcanist linter

Here is a simplest .arclint:

{
    "linters": {
        "swift": {
            "type": "swift-lint",
            "include": "(^Source/.*\\.swift$)"
        },
        // ...
    }
}

swift-linter's People

Contributors

vhbit avatar

Forkers

pebble

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.