Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FlineDev/AnyLint

Lint anything by combining the power of scripts & regular expressions.
https://github.com/FlineDev/AnyLint

autocorrection lint-check regex scripts swift

Last synced: 3 months ago
JSON representation

Lint anything by combining the power of scripts & regular expressions.

Awesome Lists containing this project

README 

        


    






    

        CI

    

    

        Code Quality

    

    

        Coverage

    

    

        Version: 0.11.0

    

    

        License: MIT

    

    


    

        PayPal: Donate

    

    

        GitHub: Become a sponsor

    

    

        Patreon: Become a patron

    






  Installation

  • Getting Started

  • Configuration

  • Xcode Build Script

  • Donation

  • Issues

  • Regex Cheat Sheet

  • License




# AnyLint



Lint any project in any language using Swift and regular expressions. With built-in support for matching and non-matching examples validation & autocorrect replacement. Replaces SwiftLint custom rules & works for other languages as well! 🎉



## Installation



### Via [Homebrew](https://brew.sh):



To **install** AnyLint the first time, run these commands:



```bash

brew tap FlineDev/AnyLint https://github.com/FlineDev/AnyLint.git

brew install anylint

```



To **update** it to the latest version, run this instead:



```bash

brew upgrade anylint

```



### Via [Mint](https://github.com/yonaskolb/Mint):



To **install** AnyLint or **update** to the latest version, run this command:



```bash

mint install FlineDev/AnyLint

```



## Getting Started



To initialize AnyLint in a project, run:



```bash

anylint --init blank

```



This will create the Swift script file `lint.swift` with something like the following contents:



```swift

#!/opt/local/bin/swift-sh

import AnyLint // @FlineDev



Lint.logSummaryAndExit(arguments: CommandLine.arguments) {

    // MARK: - Variables

    let readmeFile: Regex = #"README\.md"#



    // MARK: - Checks

    // MARK: Readme

    try Lint.checkFilePaths(

        checkInfo: "Readme: Each project should have a README.md file explaining the project.",

        regex: readmeFile,

        matchingExamples: ["README.md"],

        nonMatchingExamples: ["README.markdown", "Readme.md", "ReadMe.md"],

        violateIfNoMatchesFound: true

    )



    // MARK: ReadmeTypoLicense

    try Lint.checkFileContents(

        checkInfo: "ReadmeTypoLicense: Misspelled word 'license'.",

        regex: #"([\s#]L|l)isence([\s\.,:;])"#,

        matchingExamples: [" license:", "## Lisence\n"],

        nonMatchingExamples: [" license:", "## License\n"],

        includeFilters: [readmeFile],

        autoCorrectReplacement: "$1icense$2",

        autoCorrectExamples: [

            ["before": " lisence:", "after": " license:"],

            ["before": "## Lisence\n", "after": "## License\n"],

        ]

    )

}



```



The most important thing to note is that the **first three lines are required** for AnyLint to work properly.



All the other code can be adjusted and that's actually where you configure your lint checks (a few examples are provided by default in the `blank` template). Note that the first two lines declare the file to be a Swift script using [swift-sh](https://github.com/mxcl/swift-sh). Thus, you can run any Swift code and even import Swift packages (see the [swift-sh docs](https://github.com/mxcl/swift-sh#usage)) if you need to. The third line makes sure that all violations found in the process of running the code in the completion block are reported properly and exits the script with the proper exit code at the end.



Having this configuration file, you can now run `anylint` to run your lint checks. By default, if any check fails, the entire command fails and reports the violation reason. To learn more about how to configure your own checks, see the [Configuration](#configuration) section below.



If you want to create and run multiple configuration files or if you want a different name or location for the default config file, you can pass the `--path` option, which can be used multiple times as well like this:



Initializes the configuration files at the given locations:

```bash

anylint --init blank --path Sources/lint.swift --path Tests/lint.swift

```



Runs the lint checks for both configuration files:

```bash

anylint --path Sources/lint.swift --path Tests/lint.swift

```



There are also several flags you can pass to `anylint`:



1. `-s` / `--strict`: Fails on warnings as well. (By default, the command only fails on errors.)

1. `-x` / `--xcode`: Prints warnings & errors in a format to be reported right within Xcodes left sidebar.

1. `-l` / `--validate`: Runs only validations for `matchingExamples`, `nonMatchingExamples` and `autoCorrectExamples`.

1. `-u` / `--unvalidated`: Runs the checks without validating their correctness. Only use for faster subsequent runs after a validated run succeeded.

1. `-m` / `--measure`: Prints the time it took to execute each check for performance optimizations.

1. `-v` / `--version`: Prints the current tool version. (Does not run any lint checks.)

1. `-d` / `--debug`: Logs much more detailed information about what AnyLint is doing for debugging purposes.



## Configuration



AnyLint provides three different kinds of lint checks:



1. `checkFileContents`: Matches the contents of a text file to a given regex.

2. `checkFilePaths`: Matches the file paths of the current directory to a given regex.

3. `customCheck`: Allows to write custom Swift code to do other kinds of checks.



Several examples of lint checks can be found in the [`lint.swift` file of this very project](https://github.com/FlineDev/AnyLint/blob/main/lint.swift).



### Basic Types



Independent from the method used, there are a few types specified in the AnyLint package you should know of.



#### Regex



Many parameters in the above mentioned lint check methods are of `Regex` type. A `Regex` can be initialized in several ways:



1. Using a **String**:

  ```swift

  let regex = Regex(#"(foo|bar)[0-9]+"#) // => /(foo|bar)[0-9]+/

  let regexWithOptions = Regex(#"(foo|bar)[0-9]+"#, options: [.ignoreCase, .dotMatchesLineSeparators, .anchorsMatchLines]) // => /(foo|bar)[0-9]+/im

  ```

2. Using a **String Literal**:

  ```swift

  let regex: Regex = #"(foo|bar)[0-9]+"#  // => /(foo|bar)[0-9]+/

  let regexWithOptions: Regex = #"(foo|bar)[0-9]+\im"#  // => /(foo|bar)[0-9]+/im

  ```

3. Using a **Dictionary Literal**: (use for [named capture groups](https://www.regular-expressions.info/named.html))

  ```swift

  let regex: Regex = ["key": #"foo|bar"#, "num": "[0-9]+"] // => /(?foo|bar)(?[0-9]+)/

  let regexWithOptions: Regex = ["key": #"foo|bar"#, "num": "[0-9]+", #"\"#: "im"] // => /(?foo|bar)(?[0-9]+)/im

  ```



Note that we recommend using [raw strings](https://www.hackingwithswift.com/articles/162/how-to-use-raw-strings-in-swift) (`#"foo"#` instead of `"foo"`) for all regexes to get rid of double escaping backslashes (e.g. `\\s` becomes `\s`). This also allows for testing regexes in online regex editors like [Rubular](https://rubular.com/) first and then copy & pasting from them without any additional escaping (except for `{` & `}`, replace with `\{` & `\}`).



Regex Options



Specifying Regex options in literals is done via the `\` separator as shown in the examples above. The available options are:



1.  `i` for `.ignoreCase`: Any specified characters will both match uppercase and lowercase variants.

2. `m` for `.dotMatchesLineSeparators`: All appearances of `.` in regexes will also match newlines (which are not matched against by default).



The `.anchorsMatchLines` option is always activated on literal usage as we strongly recommend it. It ensures that `^` can be used to match the start of a line and `$` for the end of a line. By default they would match the start & end of the _entire string_. If that's actually what you want, you can still use `\A` and `\z` for that. This makes the default literal Regex behavior more in line with sites like [Rubular](https://rubular.com/).



#### CheckInfo



A `CheckInfo` contains the basic information about a lint check. It consists of:



1. `id`: The identifier of your lint check. For example: `EmptyTodo`

2. `hint`: The hint explaining the cause of the violation or the steps to fix it.

3. `severity`: The severity of violations. One of `error`, `warning`, `info`. Default: `error`



While there is an initializer available, we recommend using a String Literal instead like so:



```swift

// accepted structure: (@): 

let checkInfo: CheckInfo = "ReadmePath: The README file should be named exactly `README.md`."

let checkInfoCustomSeverity: CheckInfo = "ReadmePath@warning: The README file should be named exactly `README.md`."

```



#### AutoCorrection



An `AutoCorrection` contains an example `before` and `after` string to validate that a given autocorrection rule behaves correctly.



It can be initialized in two ways, either with the default initializer:



```swift

let example: AutoCorrection = AutoCorrection(before: "Lisence", after: "License")

```



Or using a Dictionary literal:



```swift

let example: AutoCorrection = ["before": "Lisence", "after": "License"]

```



### Check File Contents



AnyLint has rich support for checking the contents of a file using a regex. The design follows the approach "make simple things simple and hard things possible". Thus, let's explain the `checkFileContents` method with a simple and a complex example.



In its simplest form, the method just requires a `checkInfo` and a `regex`:



```swift

// MARK: EmptyTodo

try Lint.checkFileContents(

    checkInfo: "EmptyTodo: TODO comments should not be empty.",

    regex: #"// TODO: *\n"#

)

```



But we *strongly recommend* to always provide also:



1. `matchingExamples`: Array of strings expected to match the given string for `regex` validation.

2. `nonMatchingExamples`: Array of strings not matching the given string for `regex` validation.

3. `includeFilters`: Array of `Regex` objects to include to the file paths to check.



The first two will be used on each run of AnyLint to check if the provided `regex` actually works as expected. If any of the `matchingExamples` doesn't match or if any of the `nonMatchingExamples` _does_ match, the entire AnyLint command will fail early. This a built-in validation step to help preventing a lot of issues and increasing your confidence on the lint checks.



The third one is recommended because it increases the performance of the linter. Only files at paths matching at least one of the provided regexes will be checked. If not provided, all files within the current directory will be read recursively for each check, which is inefficient.



Here's the *recommended minimum example*:



```swift

// MARK: - Variables

let swiftSourceFiles: Regex = #"Sources/.*\.swift"#

let swiftTestFiles: Regex = #"Tests/.*\.swift"#



// MARK: - Checks

// MARK: empty_todo

try Lint.checkFileContents(

    checkInfo: "EmptyTodo: TODO comments should not be empty.",

    regex: #"// TODO: *\n"#,

    matchingExamples: ["// TODO:\n"],

    nonMatchingExamples: ["// TODO: not yet implemented\n"],

    includeFilters: [swiftSourceFiles, swiftTestFiles]

)

```



There's 5 more parameters you can optionally set if needed:



1. `excludeFilters`: Array of `Regex` objects to exclude from the file paths to check.

1. `violationLocation`: Specifies the position of the violation marker violations should be reported. Can be the `lower` or `upper` end of a `fullMatch` or `captureGroup(index:)`.  

1. `autoCorrectReplacement`: Replacement string which can reference any capture groups in the `regex`.

1. `autoCorrectExamples`: Example structs with `before` and `after` for autocorrection validation.

1. `repeatIfAutoCorrected`: Repeat check if at least one auto-correction was applied in last run. Defaults to `false`.



The `excludeFilters` can be used alternatively to the `includeFilters` or alongside them. If used alongside, exclusion will take precedence over inclusion.



If `autoCorrectReplacement` is provided, AnyLint will automatically replace matches of `regex` with the given replacement string. Capture groups are supported, both in numbered style (`([a-z]+)(\d+)` => `$1$2`) and named group style (`(?[a-z])(?\d+)` => `$alpha$num`). When provided, we strongly recommend to also provide `autoCorrectExamples` for validation. Like for `matchingExamples` / `nonMatchingExamples` the entire command will fail early if one of the examples doesn't correct from the `before` string to the expected `after` string.



> *Caution:* When using the `autoCorrectReplacement` parameter, be sure to double-check that your regex doesn't match too much content. Additionally, we strongly recommend to commit your changes regularly to have some backup.



Here's a *full example using all parameters* at once:



```swift

// MARK: - Variables

let swiftSourceFiles: Regex = #"Sources/.*\.swift"#

let swiftTestFiles: Regex = #"Tests/.*\.swift"#



// MARK: - Checks

// MARK: empty_method_body

try Lint.checkFileContents(

    checkInfo: "EmptyMethodBody: Don't use whitespaces for the body of empty methods.",

    regex: [

      "declaration": #"func [^\(\s]+\([^{]*\)"#,

      "spacing": #"\s*"#,

      "body": #"\{\s+\}"#

    ],

    violationLocation: .init(range: .fullMatch, bound: .upper),

    matchingExamples: [

        "func foo2bar()  { }",

        "func foo2bar(x: Int, y: Int)  { }",

        "func foo2bar(\n    x: Int,\n    y: Int\n) {\n    \n}",

    ],

    nonMatchingExamples: [

      "func foo2bar() {}",

      "func foo2bar(x: Int, y: Int) {}"

    ],

    includeFilters: [swiftSourceFiles],

    excludeFilters: [swiftTestFiles],

    autoCorrectReplacement: "$declaration {}",

    autoCorrectExamples: [

        ["before": "func foo2bar()  { }", "after": "func foo2bar() {}"],

        ["before": "func foo2bar(x: Int, y: Int)  { }", "after": "func foo2bar(x: Int, y: Int) {}"],

        ["before": "func foo2bar()\n{\n    \n}", "after": "func foo2bar() {}"],

    ]

)

```



Note that when `autoCorrectReplacement` produces a replacement string that exactly matches the matched string of `regex`, then no violation will be reported. This enables us to provide more generic `regex` patterns that also match the correct string without actually reporting a violation for the correct one. For example, using the regex ` if\s*\(([^)]+)\)\s*\{` to check whitespaces around braces after `if` statement would report a violation for all of the following examples:



```Java

if(x == 5) { /* some code */ }

if (x == 5){ /* some code */ }

if(x == 5){ /* some code */ }

if (x == 5) { /* some code */ }

```



The problem is that the last example actually is our expected formatting and should not violate. By providing an `autoCorrectReplacement` of ` if ($1) {`, we can fix that as the replacement would be equal to the matched string, so no violation would be reported for the last example and all the others would be auto-corrected – just what we want. 🎉



(The alternative would be to split the check to two separate ones, one fore checking the prefix and one the suffix whitespacing – not so beautiful as this blows up our `lint.swift` configuration file very quickly.)



#### Skip file content checks



While the `includeFilters` and `excludeFilters` arguments in the config file can be used to skip checks on specified files, sometimes it's necessary to make **exceptions** and specify that within the files themselves. For example this can become handy when there's a check which works 99% of the time, but there might be the 1% of cases where the check is reporting **false positives**.



For such cases, there are **2 ways to skip checks** within the files themselves:



1. `AnyLint.skipHere: `: Will skip the specified check(s) on the same line and the next line.



  ```swift

  var x: Int = 5 // AnyLint.skipHere: MinVarNameLength



  // or



  // AnyLint.skipHere: MinVarNameLength

  var x: Int = 5

  ```



2. `AnyLint.skipInFile: `: Will skip `All` or specificed check(s) in the entire file.



  ```swift

  // AnyLint.skipInFile: MinVarNameLength



  var x: Int = 5

  var y: Int = 5

  ```

  or



  ```swift

  // AnyLint.skipInFile: All



  var x: Int = 5

  var y: Int = 5

  ```



It is also possible to skip multiple checks at once in a line like so:



```swift

// AnyLint.skipHere: MinVarNameLength, LineLength, ColonWhitespaces

```



### Check File Paths



The `checkFilePaths` method has all the same parameters like the `checkFileContents` method, so please read the above section to learn more about them. There's only one difference and one additional parameter:



1. `autoCorrectReplacement`: Here, this will safely move the file using the path replacement.

2. `violateIfNoMatchesFound`: Will report a violation if _no_ matches are found if `true`. Default: `false`



As this method is about file paths and not file contents, the `autoCorrectReplacement` actually also fixes the paths, which corresponds to moving files from the `before` state to the `after` state. Note that moving/renaming files here is done safely, which means that if a file already exists at the resulting path, the command will fail.



By default, `checkFilePaths` will fail if the given `regex` matches a file. If you want to check for the _existence_ of a file though, you can set `violateIfNoMatchesFound` to `true` instead, then the method will fail if it does _not_ match any file.



### Custom Checks



AnyLint allows you to do any kind of lint checks (thus its name) as it gives you the full power of the Swift programming language and it's packages [ecosystem](https://swiftpm.co/). The `customCheck` method needs to be used to profit from this flexibility. And it's actually the simplest of the three methods, consisting of only two parameters:



1. `checkInfo`: Provides some general information on the lint check.

2. `customClosure`: Your custom logic which produces an array of `Violation` objects.



Note that the `Violation` type just holds some additional information on the file, matched string, location in the file and applied autocorrection and that all these fields are optional. It is a simple struct used by the AnyLint reporter for more detailed output, no logic attached. The only required field is the `CheckInfo` object which caused the violation.



If you want to use regexes in your custom code, you can learn more about how you can match strings with a `Regex` object on [the HandySwift docs](https://github.com/FlineDev/HandySwift#regex) (the project, the class was taken from) or read the [code documentation comments](https://github.com/FlineDev/AnyLint/blob/main/Sources/Utility/Regex.swift).



When using the `customCheck`, you might want to also include some Swift packages for [easier file handling](https://github.com/JohnSundell/Files) or [running shell commands](https://github.com/JohnSundell/ShellOut). You can do so by adding them at the top of the file like so:



```swift

#!/opt/local/bin/swift-sh

import AnyLint // @FlineDev

import ShellOut // @JohnSundell



Lint.logSummaryAndExit(arguments: CommandLine.arguments) {

    // MARK: - Variables

    let projectName: String = "AnyLint"



    // MARK: - Checks

    // MARK: LinuxMainUpToDate

    try Lint.customCheck(checkInfo: "LinuxMainUpToDate: The tests in Tests/LinuxMain.swift should be up-to-date.") { checkInfo in

        var violations: [Violation] = []



        let linuxMainFilePath = "Tests/LinuxMain.swift"

        let linuxMainContentsBeforeRegeneration = try! String(contentsOfFile: linuxMainFilePath)



        let sourceryDirPath = ".sourcery"

        try! shellOut(to: "sourcery", arguments: ["--sources", "Tests/\(projectName)Tests", "--templates", "\(sourceryDirPath)/LinuxMain.stencil", "--output", sourceryDirPath])



        let generatedLinuxMainFilePath = "\(sourceryDirPath)/LinuxMain.generated.swift"

        let linuxMainContentsAfterRegeneration = try! String(contentsOfFile: generatedLinuxMainFilePath)



        // move generated file to LinuxMain path to update its contents

        try! shellOut(to: "mv", arguments: [generatedLinuxMainFilePath, linuxMainFilePath])



        if linuxMainContentsBeforeRegeneration != linuxMainContentsAfterRegeneration {

            violations.append(

                Violation(

                    checkInfo: checkInfo,

                    filePath: linuxMainFilePath,

                    appliedAutoCorrection: AutoCorrection(

                        before: linuxMainContentsBeforeRegeneration,

                        after: linuxMainContentsAfterRegeneration

                    )

                )

            )

        }



        return violations

    }

}



```



## Xcode Build Script



If you are using AnyLint for a project in Xcode, you can configure a build script to run it on each build. In order to do this select your target, choose the `Build Phases` tab and click the + button on the top left corner of that pane. Select `New Run Script Phase` and copy the following into the text box below the `Shell: /bin/sh` of your new run script phase:



```bash

export PATH="$PATH:/opt/homebrew/bin"



if which anylint > /dev/null; then

    anylint -x

else

    echo "warning: AnyLint not installed, see from https://github.com/FlineDev/AnyLint"

fi

```



Next, make sure the AnyLint script runs before the steps `Compiling Sources` by moving it per drag & drop, for example right after `Dependencies`. You probably also want to rename it to somethng like `AnyLint`.



> **_Note_**: There's a [known bug](https://github.com/mxcl/swift-sh/issues/113) when the build script is used in non-macOS platforms targets.



## Regex Cheat Sheet



Refer to the Regex quick reference on [rubular.com](https://rubular.com/) which all apply for Swift as well:



    




In Swift, there are some **differences to regexes in Ruby** (which rubular.com is based on) – take care when copying regexes:



1. In Ruby, forward slashes (`/`) must be escaped (`\/`), that's not necessary in Swift.

2. In Swift, curly braces (`{` & `}`) must be escaped (`\{` & `\}`), that's not necessary in Ruby.



Here are some **advanced Regex features** you might want to use or learn more about:



1. Back references can be used within regexes to match previous capture groups.



   For example, you can make sure that the PR number and link match in `PR: [#100](https://github.com/FlineDev/AnyLint/pull/100)` by using a capture group (`(\d+)`) and a back reference (`\1`) like in: `\[#(\d+)\]\(https://[^)]+/pull/\1\)`.



   [Learn more](https://www.regular-expressions.info/backref.html)



2. Negative & positive lookaheads & lookbehinds allow you to specify patterns with some limitations that will be excluded from the matched range. They are specified with `(?=PATTERN)` (positive lookahead), `(?!PATTERN)` (negative lookahead), `(?<=PATTERN)` (positive lookbehind) or `(?