feat: create linter system

[araujogui]

Description

Create linter system

Validation

Run CLI

Related Issues

Fixes #56

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I've covered new added functionality with unit tests if necessary.

[flakey5]

first pass will finish in a bit

[AugustinMauroy]

do we have ability to warn if it's an unknown stability level ?

[araujogui]

do we have ability to warn if it's an unknown stability level ?

I didn't create this rule but it's a good idea, I can develop this.

[flakey5]

Wdyt of adding a capability here to ignore only specific linting errors? I.e. being able to ignore an invalid introduced_in but still getting errors on everything else

[AugustinMauroy]

+1 for ingnoring rules

[ovflowd]

Such a clean code! LGTM! ✨

[AugustinMauroy]

If it's not too complicated have the rules deactivated if not LGTM

[bjohansebas]

LGTM, is there any way to test this?

[AugustinMauroy]

LGTM, is there any way to test this?

clone this repo npx api-docs-tooling -i "/path/to/node/doc/api/*.md"

[bjohansebas]

LGTM, is there any way to test this?

clone this repo npx api-docs-tooling -i "/path/to/node/doc/api/*.md"

I was referring to more automated tests without having to take that step you mentioned.

[ovflowd]

Agreed some unit tests would be cool

[ovflowd]

Can we add some unit tests, @araujogui?

[araujogui]

Can we add some unit tests, @araujogui?

Sure, I'll push this tomorrow. Disabling rules too.

[bjohansebas]

LGTM!

[araujogui]

GitHub seems to be automatically stripping ANSI escape sequences, so tests pass locally and fail in CI

[ovflowd]

GitHub seems to be automatically stripping ANSI escape sequences, so tests pass locally and fail in CI

Any workaround?

[ovflowd]

LGTM

[araujogui]

GitHub seems to be automatically stripping ANSI escape sequences, so tests pass locally and fail in CI

Any workaround?

Yep, FORCE_COLOR=1 fixed the issue.