Linting, Formatting, and Auto Correction - powerhome/playbook-swift GitHub Wiki

In addition to the default linting rules, Playbook Swift enforces a indentation width of 2 spaces.

  • SwiftLint, within the .swiftlint.yml file, enforces the indentation_width: 2 rule
    • View all enforced rules via swiftlint rules in your Terminal
  • SwiftFormat, within the .swiftformat file, only allows the indent rule and sets it to --indent 2
    • To run SwiftFormat manually, use the plugin:
      • Right click PlaybookSwift in the Project Navigator
      • Click SwiftFormatPlugin
        SwiftFormatPlugin
      • Click Run
        Run

These rules will also be enforced before you commit via pre-commit.

  • After installing pre-commit via brew install pre-commit && pre-commit install, the first time you try to commit, it will take some time to install the hooks:

    pre-commit First Time

  • pre-commit will check for several rules and auto-corrects any violations. You will have to commit again if it finds an error. In the example below, one file did not have proper indentation which SwiftFormat detected and corrected:

    SwiftFormatFailure

⚠️ **GitHub.com Fallback** ⚠️