feat(spec): eslint with custom rules APIC-387 #304
Conversation
millotp
requested review from
eunjae-lee and
shortcuts
and removed request for
a team
✅ Deploy Preview for api-clients-automation canceled.
|
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
Isn't Have you also tried the custom rules solution of our current tooling? It seems to require less setup https://redocly.com/docs/cli/resources/custom-rules/ |
|
|
millotp
force-pushed
the
feat/eslint-yml
branch
from
28bd2d4 to
0d4375d
Compare
millotp
changed the title
.github/workflows/check.yml
Outdated
| @@ -66,6 +66,9 @@ jobs: | |||
| - name: Test scripts | |||
| run: yarn scripts:test | |||
|
|
|||
| - name: Test custom eslint plugin | |||
| run: yarn workspace eslint test | |||
There was a problem hiding this comment.
should this be yarn workspace eslint-plugin-automation-custom test?
There was a problem hiding this comment.
yep I forgot to change it, thanks !
| if ( | ||
| typeof value.value !== 'string' || | ||
| value.value.trim().endsWith('.') || | ||
| !value.value.trim().includes(' ') |
There was a problem hiding this comment.
I've added a comment for clarity
| @@ -747,7 +747,7 @@ components: | |||
| type: integer | |||
| description: >- | |||
| The number of hits selected and sorted by the relevant sort | |||
| algorithm | |||
| algorithm. | |||
There was a problem hiding this comment.
cool to see it's working correctly with multi-line description
algolia/api-clients-automation#304 Co-authored-by: Pierre Millot <[email protected]>
algolia/api-clients-automation#304 Co-authored-by: Pierre Millot <[email protected]>
algolia/api-clients-automation#304 Co-authored-by: Pierre Millot <[email protected]>
🧭 What and Why
🎟 JIRA Ticket: APIC-387
Create custom package for eslint rules, only for yaml for now but can work with other parsers too.
You need to run
yarn build:eslintto make it work, I don't know how to include it in theyarn installprocess.Changes included:
description-dotrule to check for dot at the end of descriptions.🧪 Test
yarn workspace eslint test