@ionic/swiftlint-config/README.md

SwiftLint config for Ionic and Capacitor

# @ionic/swiftlint-config

Shared SwiftLint config used in Ionic and Capacitor projects. This must be used with the [`swiftlint` wrapper](https://github.com/ionic-team/swiftlint) for npm projects.

## Usage

1. Install the `swiftlint` wrapper by following [these instructions](https://github.com/ionic-team/swiftlint#usage).
1. Remove existing `.swiftlint.yml` file, if present.
1. Install the config in your project.

    ```
    npm install -D @ionic/swiftlint-config
    ```

1. Configure the swiftlint wrapper by adding a `swiftlint` key at the root of your project's `package.json`.

    ```
    "swiftlint": "@ionic/swiftlint-config",
    ```

    > Alternatively, to override options, you can create a `swiftlint.config.js` file:
    >
    > ```javascript
    > module.exports = {
    >   ...require('@ionic/swiftlint-config'),
    >
    >   // override options here
    > };
    > ```
    >
    > It might be worth creating a PR to this config repo first, though! We'd love to discuss changes. :blue_heart: