chore: set default severity for lint config #1292

IgorKarpiuk · 2023-10-10T13:07:24Z

What/Why/How?

Set default severity for the config validation and update warning message.
Add --lint-config option to all commands and exit with code 2 if config validation failed.
Previously, we had the default severity warn only for the lint command.

Reference

Related: #1277

Testing

Screenshots (optional)

Check yourself

Code is linted
Tested with redoc/reference-docs/workflows (internal)
All new/updated code is covered with tests

Security

Security impact of change has been considered
Code follows company security practices and guidelines

changeset-bot · 2023-10-10T13:07:28Z

🦋 Changeset detected

Latest commit: bf41ff5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@redocly/cli	Minor
@redocly/openapi-core	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2023-10-10T13:08:55Z

Command	Mean [s]	Min [s]	Max [s]	Relative
`redocly lint packages/core/src/benchmark/benches/rebilly.yaml`	1.261 ± 0.056	1.180	1.386	1.00
`redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml`	1.288 ± 0.051	1.199	1.381	1.02 ± 0.06

github-actions · 2023-10-10T13:10:48Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	75.89%	4013/5288
🟡	Branches	65.78%	2138/3250
🟡	Functions	67.95%	651/958
🟡	Lines	76.07%	3761/4944

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / load.ts	88.24% (-3.6% 🔻)	78.57% (-1.92% 🔻)	100%	89.36% (-3.97% 🔻)
🟡	cli/src/utils.ts	61.64%	49.62% (-1.14% 🔻)	73.47%	60.93%
🟢	`...` / lint.ts	81.67% (-2.54% 🔻)	64.71% (-13.87% 🔻)	50%	83.05% (-2.66% 🔻)

Test suite run success

640 tests passing in 93 suites.

Report generated by 🧪jest coverage report action from bf41ff5

IgorKarpiuk · 2023-10-11T07:14:25Z

packages/cli/src/__tests__/utils.test.ts

-  it('should print warnign and error', () => {
-    printConfigLintTotals({ ...totalProblemsMock, warnings: 2 });
-    expect(process.stderr.write).toHaveBeenCalledWith(
-      '❌ Your config has 1 error and 2 warnings.\n'
-    );
-    expect(redColoretteMocks).toHaveBeenCalledWith('❌ Your config has 1 error and 2 warnings.\n');
-  });
-


We have only one rule or configuration, so there can only be one severity, error or warning

tatomyr · 2023-10-12T12:59:58Z

Does it make sense to exit with an error code if config linting fails with errors?

lornajane · 2023-10-12T19:08:36Z

I would expect an error to exit with a status code, yes

IgorKarpiuk · 2023-10-13T07:56:17Z

If we exit with an error when linting the config file (this applies to every command), do we need to add the --lint-config option for each command to specify the severity level for the configuration file?
@tatomyr @lornajane

tatomyr · 2023-10-13T11:17:53Z

do we need to add the -lint-config option for each command to specify the severity level for the configuration file?

@IgorKarpiuk this makes sense.
This wouldn't be a breaking change because we use warn as a default severity, right?

IgorKarpiuk · 2023-10-13T11:23:29Z

This wouldn't be a breaking change because we use warn as a default severity, right?

@tatomyr Yes 🙂

__tests__/lint-config/invalid-definition-and-config/snapshot.js

lornajane · 2023-10-19T08:18:08Z

.changeset/witty-taxis-occur.md

+'@redocly/cli': patch
+---
+
+Set default severity for the config validation.


Please include why this is useful, and what behaviour change the user might experience.

lornajane

Thank you for sorting this out and formatting the command pages! I think we should sort the parameters alphabetically rather than adding new ones at the end.

I commented on the changelog wording, and I think it should mention the additional parameter.

docs/commands/bundle.md

docs/commands/preview-docs.md

docs/commands/push.md

__tests__/lint-config/invalid-config-assertation-config-type/snapshot.js

__tests__/lint-config/invalid-config-assertation-name/snapshot.js

lornajane

One tiny nitpick to fix but otherwise, very happy to see this in !

lornajane · 2023-10-19T12:54:57Z

.changeset/witty-taxis-occur.md

+---
+
+Added the possibility to configure the linting severity level of the configuration file for all CLI commands.
+Now, Redocly CLI will exit with an error if there are any issues with the configuration file, and the severity is set to `error`.


Yes, but without the "Now" (sorry, a small thing I know!)

IgorKarpiuk commented Oct 11, 2023

View reviewed changes

IgorKarpiuk force-pushed the fix/config-severity branch from 3d0def4 to ad180c0 Compare October 11, 2023 07:18

IgorKarpiuk self-assigned this Oct 11, 2023

IgorKarpiuk marked this pull request as ready for review October 11, 2023 07:18

IgorKarpiuk requested a review from a team as a code owner October 11, 2023 07:18

tatomyr reviewed Oct 16, 2023

View reviewed changes

__tests__/lint-config/invalid-definition-and-config/snapshot.js Outdated Show resolved Hide resolved

IgorKarpiuk marked this pull request as draft October 16, 2023 12:28

IgorKarpiuk marked this pull request as ready for review October 17, 2023 14:41

IgorKarpiuk added 7 commits October 18, 2023 11:09

chore: set default severity for lint config

7eb4be1

chore: add changeset

d97fba1

fix: exit with code 2 if config validation failed

017dfec

fix: config unit test

aa5547a

chore: move config validation error to core

760e93d

fix: update unit tests

6e1de4a

chore: update docs

29bcb58

IgorKarpiuk force-pushed the fix/config-severity branch from 65662bd to 29bcb58 Compare October 18, 2023 08:09

IgorKarpiuk requested a review from lornajane October 18, 2023 13:17

lornajane reviewed Oct 19, 2023

View reviewed changes

lornajane suggested changes Oct 19, 2023

View reviewed changes

docs/commands/bundle.md Outdated Show resolved Hide resolved

docs/commands/preview-docs.md Outdated Show resolved Hide resolved

docs/commands/push.md Outdated Show resolved Hide resolved

tatomyr reviewed Oct 19, 2023

View reviewed changes

__tests__/lint-config/invalid-config-assertation-config-type/snapshot.js Show resolved Hide resolved

tatomyr reviewed Oct 19, 2023

View reviewed changes

__tests__/lint-config/invalid-config-assertation-name/snapshot.js Show resolved Hide resolved

chore: update changeset

cc0c2fa

chore: sort command options alphabetically

bd9205f

IgorKarpiuk requested a review from lornajane October 19, 2023 10:26

SmoliyY approved these changes Oct 19, 2023

View reviewed changes

lornajane approved these changes Oct 19, 2023

View reviewed changes

IgorKarpiuk and others added 2 commits October 19, 2023 15:58

Merge branch 'main' into fix/config-severity

03b8b0a

chore: update changelog

bf41ff5

IgorKarpiuk merged commit 0c52110 into main Oct 19, 2023
28 checks passed

IgorKarpiuk deleted the fix/config-severity branch October 19, 2023 13:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: set default severity for lint config #1292

chore: set default severity for lint config #1292

IgorKarpiuk commented Oct 10, 2023 •

edited

Loading

changeset-bot bot commented Oct 10, 2023 •

edited

Loading

github-actions bot commented Oct 10, 2023 •

edited

Loading

github-actions bot commented Oct 10, 2023 •

edited

Loading

IgorKarpiuk Oct 11, 2023

tatomyr commented Oct 12, 2023

lornajane commented Oct 12, 2023

IgorKarpiuk commented Oct 13, 2023 •

edited

Loading

tatomyr commented Oct 13, 2023

IgorKarpiuk commented Oct 13, 2023

lornajane Oct 19, 2023

IgorKarpiuk Oct 19, 2023

lornajane left a comment

lornajane left a comment

lornajane Oct 19, 2023

chore: set default severity for lint config #1292

chore: set default severity for lint config #1292

Conversation

IgorKarpiuk commented Oct 10, 2023 • edited Loading

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

changeset-bot bot commented Oct 10, 2023 • edited Loading

🦋 Changeset detected

github-actions bot commented Oct 10, 2023 • edited Loading

github-actions bot commented Oct 10, 2023 • edited Loading

Coverage report

Test suite run success

IgorKarpiuk Oct 11, 2023

Choose a reason for hiding this comment

tatomyr commented Oct 12, 2023

lornajane commented Oct 12, 2023

IgorKarpiuk commented Oct 13, 2023 • edited Loading

tatomyr commented Oct 13, 2023

IgorKarpiuk commented Oct 13, 2023

lornajane Oct 19, 2023

Choose a reason for hiding this comment

IgorKarpiuk Oct 19, 2023

Choose a reason for hiding this comment

lornajane left a comment

Choose a reason for hiding this comment

lornajane left a comment

Choose a reason for hiding this comment

lornajane Oct 19, 2023

Choose a reason for hiding this comment

IgorKarpiuk commented Oct 10, 2023 •

edited

Loading

changeset-bot bot commented Oct 10, 2023 •

edited

Loading

github-actions bot commented Oct 10, 2023 •

edited

Loading

github-actions bot commented Oct 10, 2023 •

edited

Loading

IgorKarpiuk commented Oct 13, 2023 •

edited

Loading