aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/ckaznocha/intrange/README.md
blob: 9cac46220bba053f8921efa88b5215b1122ffb6b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# intrange

[![Build Status](https://github.com/ckaznocha/intrange/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ckaznocha/intrange/actions/workflows/ci.yml)
[![Release](http://img.shields.io/github/release/ckaznocha/intrange.svg)](https://github.com/ckaznocha/intrange/releases/latest)
[![GoDoc](https://godoc.org/github.com/ckaznocha/intrange?status.svg)](https://godoc.org/github.com/ckaznocha/intrange)

intrange is a program for checking for loops that could use the [Go 1.22](https://go.dev/ref/spec#Go_1.22) integer
range feature.

## Installation

```bash
go install github.com/ckaznocha/intrange/cmd/intrange@latest
```

## Usage

```bash
go vet -vettool=$(which intrange) ./...
```

## Examples

### A loop that uses the value of the loop variable

```go
package main

import "fmt"

func main() {
    for i := 0; i < 10; i++ {
        fmt.Println(i)
    }
}
```

Running `intrange` on the above code will produce the following output:

```bash
main.go:5:2: for loop can be changed to use an integer range (Go 1.22+)
```

The loop can be rewritten as:

```go
package main

import "fmt"

func main() {
    for i := range 10 {
        fmt.Println(i)
    }
}
```

### A loop that does not use the value of the loop variable

```go
package main

import "fmt"

func main() {
    for i := 0; i < 10; i++ {
        fmt.Println("Hello again!")
    }
}
```

Running `intrange` on the above code will produce the following output:

```bash
main.go:5:2: for loop can be changed to use an integer range (Go 1.22+)
```

The loop can be rewritten as:

```go
package main

import "fmt"

func main() {
    for range 10 {
        fmt.Println("Hello again!")
    }
}
```