Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

swiftlint

ionic-team79.6kMIT2.0.0

Tiny SwiftLint wrapper for npm

readme

swiftlint

Tiny SwiftLint wrapper for npm. SwiftLint must still be installed and swiftlint must be on your PATH.

Invocations of node-swiftlint on Linux/Windows print a warning and pass.

This package supports cosmiconfig like Prettier does, instead of just .swiftlint.yml.

Usage

  1. Install SwiftLint.

     brew install swiftlint
  2. Install the wrapper in your project:

     npm install -D swiftlint
  3. Add a script to your project's package.json:

     "scripts": {
       "swiftlint": "node-swiftlint",
       ...
     }
  4. Add SwiftLint configuration.

    This wrapper will use any existing .swiftlint.yml files (read cosmiconfig's README for more options), but we recommend using @ionic/swiftlint-config. See usage instructions.

  5. Lint in your project! :tada:

     npm run swiftlint