Skip to content

Commit 32dea6f

Browse files
committed
extend guide
Add info about `version`, ${base-path}, relative-path-mode, deprecated linters.
1 parent 9f78722 commit 32dea6f

File tree

1 file changed

+141
-27
lines changed

1 file changed

+141
-27
lines changed

docs/src/docs/product/migration-guide.mdx

Lines changed: 141 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -760,6 +760,37 @@ linters:
760760

761761
</details>
762762

763+
#### `linters-settings.gocritic.settings.ruleguard.rules`
764+
765+
The special variable `${configDir}` has been replaced with `${base-path}`.
766+
767+
<details>
768+
<summary>v1</summary>
769+
770+
```yaml
771+
linters-settings:
772+
gocritic:
773+
settings:
774+
ruleguard:
775+
rules: '${configDir}/ruleguard/rules-*.go'
776+
```
777+
778+
</details>
779+
780+
<details>
781+
<summary>v2</summary>
782+
783+
```yaml
784+
linters:
785+
settings:
786+
gocritic:
787+
settings:
788+
ruleguard:
789+
rules: '${base-path}/ruleguard/rules-*.go'
790+
```
791+
792+
</details>
793+
763794
#### `linters-settings.govet.check-shadowing`
764795

765796
This option has been deprecated since v1.57.0 and has been removed.
@@ -1225,7 +1256,7 @@ This property is `true` by default.
12251256

12261257
#### `output.sort-order`
12271258

1228-
This property has new default: `['linter', 'file']` instead of `['file']`.
1259+
This property has a new default value `['linter', 'file']` instead of `['file']`.
12291260

12301261
#### `output.sort-results`
12311262

@@ -1263,6 +1294,10 @@ issues:
12631294

12641295
This property value set to match Linux container CPU quota by default and fallback on the number of logical CPUs in the machine.
12651296

1297+
#### `run.relative-path-mode`
1298+
1299+
This property has a new default value of `cfg` instead of `wd`.
1300+
12661301
#### `run.show-stats`
12671302

12681303
This property has been deprecated since v1.57.0 and replaced by `output.show-stats`.
@@ -1488,6 +1523,109 @@ linters:
14881523

14891524
</details>
14901525

1526+
### `linters.enable[].<formatter_name>`
1527+
1528+
`gci`, `gofmt`, `gofumpt`, `goimports` have been moved to the `formatters` section.
1529+
1530+
<details>
1531+
<summary>v1</summary>
1532+
1533+
```yaml
1534+
linters:
1535+
enable:
1536+
- gci
1537+
- gofmt
1538+
- gofumpt
1539+
- goimports
1540+
```
1541+
1542+
</details>
1543+
1544+
<details>
1545+
<summary>v2</summary>
1546+
1547+
```yaml
1548+
formatters:
1549+
enable:
1550+
- gci
1551+
- gofmt
1552+
- gofumpt
1553+
- goimports
1554+
```
1555+
1556+
</details>
1557+
1558+
### `linters.enable[].{stylecheck,gosimple,staticcheck}`
1559+
1560+
The linters `stylecheck`, `gosimple`, and `staticcheck` has been merged inside the `staticcheck`.
1561+
1562+
<details>
1563+
<summary>v1</summary>
1564+
1565+
```yaml
1566+
linters:
1567+
enable:
1568+
- gosimple
1569+
- staticcheck
1570+
- stylecheck
1571+
```
1572+
1573+
</details>
1574+
1575+
<details>
1576+
<summary>v2</summary>
1577+
1578+
```yaml
1579+
linters:
1580+
enable:
1581+
- staticcheck
1582+
```
1583+
1584+
</details>
1585+
1586+
### `linters.enable[].typecheck`
1587+
1588+
This linter is an internal and enabled by default.
1589+
1590+
<details>
1591+
<summary>v1</summary>
1592+
1593+
```yaml
1594+
linters:
1595+
enable:
1596+
- typecheck
1597+
```
1598+
1599+
</details>
1600+
1601+
<details>
1602+
<summary>v2</summary>
1603+
1604+
```yaml
1605+
# typecheck is always enabled
1606+
```
1607+
1608+
</details>
1609+
1610+
### `linters.enable[].<deprecated_linter>`
1611+
1612+
The following deprecated linters have been removed:
1613+
1614+
- `deadcode`
1615+
- `execinquery`
1616+
- `exhaustivestruct`
1617+
- `exportloopref`
1618+
- `golint`
1619+
- `gomnd`
1620+
- `ifshort`
1621+
- `interfacer`
1622+
- `maligned`
1623+
- `nosnakecase`
1624+
- `scopelint`
1625+
- `structcheck`
1626+
- `tenv`
1627+
- `varcheck`
1628+
14911629
#### `linters.fast`
14921630

14931631
This property has been removed.
@@ -1722,30 +1860,6 @@ linters:
17221860

17231861
</details>
17241862

1725-
### `stylecheck`, `gosimple`, `staticcheck`
1726-
1727-
The three linters `stylecheck`, `gosimple`, and `staticcheck` has been merged inside `staticcheck`.
1863+
### `version`
17281864

1729-
<details>
1730-
<summary>v1</summary>
1731-
1732-
```yaml
1733-
linters:
1734-
enable:
1735-
- gosimple
1736-
- staticcheck
1737-
- stylecheck
1738-
```
1739-
1740-
</details>
1741-
1742-
<details>
1743-
<summary>v2</summary>
1744-
1745-
```yaml
1746-
linters:
1747-
enable:
1748-
- staticcheck
1749-
```
1750-
1751-
</details>
1865+
The `version` property has been added to the configuration file.

0 commit comments

Comments
 (0)