@ionic/swiftlint-config

SwiftLint config for Ionic and Capacitor

Usage no npm install needed!

<script type="module">
  import ionicSwiftlintConfig from 'https://cdn.skypack.dev/@ionic/swiftlint-config';
</script>

README

@ionic/swiftlint-config

Shared SwiftLint config used in Ionic and Capacitor projects. This must be used with the swiftlint wrapper for npm projects.

Usage

  1. Install the swiftlint wrapper by following these instructions.

  2. Remove existing .swiftlint.yml file, if present.

  3. Install the config in your project.

    npm install -D @ionic/swiftlint-config
    
  4. 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:

    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: