Skip to content

Commit 24e52b2

Browse files
committed
Fix some grammar; extend output section
1 parent 4da0531 commit 24e52b2

File tree

1 file changed

+179
-18
lines changed

1 file changed

+179
-18
lines changed

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

Lines changed: 179 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -390,9 +390,9 @@ linters:
390390

391391
### `linters-settings`
392392

393-
`linters-settings` section has been split to `linters.settings` and `formatters.settings`.
393+
The `linters-settings` section has been split into `linters.settings` and `formatters.settings`.
394394

395-
Settings for `gci`, `gofmt`, `gofumpt`, `goimports` are moved to the `formatters.settings` section.
395+
Settings for `gci`, `gofmt`, `gofumpt`, and `goimports` are moved to the `formatters.settings` section.
396396

397397
<details>
398398
<summary>v1</summary>
@@ -515,7 +515,7 @@ linters:
515515

516516
#### `linters-settings.errcheck.exclude`
517517

518-
This option has been deprecated since v1.42.0.
518+
This option has been deprecated since v1.42.0 and has been removed.
519519

520520
To exclude functions, use `linters.settings.errcheck.exclude-functions` instead.
521521

@@ -547,7 +547,7 @@ linters:
547547

548548
#### `linters-settings.errcheck.ignore`
549549

550-
This option has been deprecated since v1.13.0.
550+
This option has been deprecated since v1.13.0 and has been removed.
551551

552552
To exclude functions, use `linters.settings.errcheck.exclude-functions` instead.
553553

@@ -558,7 +558,6 @@ To exclude functions, use `linters.settings.errcheck.exclude-functions` instead.
558558
linters-settings:
559559
errcheck:
560560
ignore: 'io:.*'
561-
562561
```
563562

564563
</details>
@@ -582,7 +581,7 @@ linters:
582581

583582
This option has been removed.
584583

585-
To analyze generated files use `linters.exclusions.generated`.
584+
To analyze generated files, use `linters.exclusions.generated`.
586585

587586
<details>
588587
<summary>v1</summary>
@@ -704,7 +703,7 @@ linters:
704703

705704
This option has been removed.
706705

707-
To analyze generated files use `linters.exclusions.generated`.
706+
To analyze generated files, use `linters.exclusions.generated`.
708707

709708
<details>
710709
<summary>v1</summary>
@@ -1213,11 +1212,6 @@ output:
12131212

12141213
The property `output.formats[].format` has been replaced with `output.formats[].<format_name>`.
12151214

1216-
The formats `colored-line-number`, `colored-tab` have been replaced by an option `colors`:
1217-
1218-
- `output.formats[].text.colors: true`
1219-
- `output.formats[].tab.colors: true`.
1220-
12211215
<details>
12221216
<summary>v1</summary>
12231217

@@ -1227,8 +1221,7 @@ output:
12271221
- format: json
12281222
path: stderr
12291223
- format: checkstyle
1230-
path: 'report.xml'
1231-
- format: colored-line-number
1224+
path: report.xml
12321225
```
12331226

12341227
</details>
@@ -1242,14 +1235,158 @@ output:
12421235
json:
12431236
path: stderr
12441237
checkstyle:
1245-
path: 'report.xml'
1238+
path: report.xml
1239+
```
1240+
1241+
</details>
1242+
1243+
#### `output.formats[].format: line-number`
1244+
1245+
This format has been replaced by the format `text`.
1246+
1247+
<details>
1248+
<summary>v1</summary>
1249+
1250+
```yaml
1251+
output:
1252+
formats:
1253+
- format: line-number
1254+
```
1255+
1256+
</details>
1257+
1258+
<details>
1259+
<summary>v2</summary>
1260+
1261+
```yaml
1262+
output:
1263+
formats:
1264+
text:
1265+
path: stdout
1266+
```
1267+
1268+
</details>
1269+
1270+
#### `output.formats[].format: colored-line-number`
1271+
1272+
This format has been replaced by the format `text` with the option `colors: true`.
1273+
1274+
<details>
1275+
<summary>v1</summary>
1276+
1277+
```yaml
1278+
output:
1279+
formats:
1280+
- format: colored-line-number
1281+
```
1282+
1283+
</details>
1284+
1285+
<details>
1286+
<summary>v2</summary>
1287+
1288+
```yaml
1289+
output:
1290+
formats:
12461291
text:
12471292
path: stdout
12481293
colors: true
12491294
```
12501295

12511296
</details>
12521297

1298+
#### `output.formats[].format: colored-tab`
1299+
1300+
This format has been replaced by the format `tab` with the option `colors: true`.
1301+
1302+
<details>
1303+
<summary>v1</summary>
1304+
1305+
```yaml
1306+
output:
1307+
formats:
1308+
- format: colored-tab
1309+
```
1310+
1311+
</details>
1312+
1313+
<details>
1314+
<summary>v2</summary>
1315+
1316+
```yaml
1317+
output:
1318+
formats:
1319+
tab:
1320+
path: stdout
1321+
colors: true
1322+
```
1323+
1324+
</details>
1325+
1326+
#### `output.print-issued-lines`
1327+
1328+
This property has been removed.
1329+
1330+
To print the lines with issues, use the `text` format with the option `print-issued-lines: true`.
1331+
1332+
<details>
1333+
<summary>v1</summary>
1334+
1335+
```yaml
1336+
output:
1337+
formats:
1338+
- format: line-number
1339+
path: stdout
1340+
print-issued-lines: true
1341+
```
1342+
1343+
</details>
1344+
1345+
<details>
1346+
<summary>v2</summary>
1347+
1348+
```yaml
1349+
output:
1350+
formats:
1351+
text:
1352+
path: stdout
1353+
print-issued-lines: true
1354+
```
1355+
1356+
</details>
1357+
1358+
#### `output.print-linter-name`
1359+
1360+
This property has been removed.
1361+
1362+
To print the linter name, use the `text` format with the option `print-linter-name: true`.
1363+
1364+
<details>
1365+
<summary>v1</summary>
1366+
1367+
```yaml
1368+
output:
1369+
formats:
1370+
- format: line-number
1371+
path: stdout
1372+
print-linter-name: true
1373+
```
1374+
1375+
</details>
1376+
1377+
<details>
1378+
<summary>v2</summary>
1379+
1380+
```yaml
1381+
output:
1382+
formats:
1383+
text:
1384+
path: stdout
1385+
print-linter-name: true
1386+
```
1387+
1388+
</details>
1389+
12531390
#### `output.show-stats`
12541391

12551392
This property is `true` by default.
@@ -1290,6 +1427,10 @@ issues:
12901427

12911428
### `run`
12921429

1430+
#### `run.go`
1431+
1432+
The new fallback value for this property is `1.22` instead of `1.17`.
1433+
12931434
#### `run.concurrency`
12941435

12951436
This property value set to match Linux container CPU quota by default and fallback on the number of logical CPUs in the machine.
@@ -1298,9 +1439,29 @@ This property value set to match Linux container CPU quota by default and fallba
12981439

12991440
This property has a new default value of `cfg` instead of `wd`.
13001441

1442+
<details>
1443+
<summary>v1</summary>
1444+
1445+
```yaml
1446+
run:
1447+
# When not specified, relative-path-mode is set to 'wd' by default
1448+
```
1449+
1450+
</details>
1451+
1452+
<details>
1453+
<summary>v2</summary>
1454+
1455+
```yaml
1456+
run:
1457+
relative-path-mode: 'cfg'
1458+
```
1459+
1460+
</details>
1461+
13011462
#### `run.show-stats`
13021463

1303-
This property has been deprecated since v1.57.0 and replaced by `output.show-stats`.
1464+
This property has been deprecated since v1.57.0 and has been replaced by `output.show-stats`.
13041465

13051466
<details>
13061467
<summary>v1</summary>
@@ -1324,7 +1485,7 @@ output:
13241485

13251486
#### `run.skip-dirs-use-default`
13261487

1327-
This property has been deprecated since v1.57.0 and replaced by `issues.exclude-dirs-use-default`.
1488+
This property has been deprecated since v1.57.0 and has been replaced by `issues.exclude-dirs-use-default`.
13281489

13291490
<details>
13301491
<summary>v1</summary>
@@ -1525,7 +1686,7 @@ linters:
15251686

15261687
### `linters.enable[].<formatter_name>`
15271688

1528-
`gci`, `gofmt`, `gofumpt`, `goimports` have been moved to the `formatters` section.
1689+
The linters `gci`, `gofmt`, `gofumpt`, and `goimports` have been moved to the `formatters` section.
15291690

15301691
<details>
15311692
<summary>v1</summary>

0 commit comments

Comments
 (0)