Commit Graph

36 Commits

Author SHA1 Message Date
Dmytro Anansky
599b5fa04b feat: lint arazzo test descriptions (#1601)
* feat: lint arazzo test descriptions
2024-07-10 12:08:10 +03:00
dianacheung
4c3d8cf84f docs: update commands documentation (issue 1429) and minor corrections (#1560)
* docs: updated commands documentation per issue 1429 and minor corrections, ran prettier

* docs: updated commands documentation per issue 1429 and included pr 1560 feedback

* docs: minor formatting and copyedits

---------

Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2024-07-05 20:59:59 +01:00
Lorna Jane Mitchell
546d482b03 feat: add markdown output format for lint command (#1559)
* feat: Add markdown output format for lint command

* feat: Tweak output and add a test

* fix: send markdown output to stdout to match existing json/checkstyle behaviour

* fix: Update snapshots

* fix: Check error count to determine success

* docs: Add markdown format docs to lint command page

* chore: Add changeset

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: Update from review feedback

* fix: Add missing image, run prettier

* fix: Update test to match corrected code behaviour

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2024-05-20 09:54:26 +01:00
Raymond Jelierse
2d16014b67 feat(lint): add support for GitHub Actions output format (#1497)
* feat(format): add support for GitHub Actions output format

* feat(lint): add support for GitHub Action output format

* doc: add changeset

* style: language hint on codeblock

* fix: include dependency in correct package

* refactor: remove dependency on @actions/core, do formatting of messages internally

* test: add coverage for github-actions output format

* style: format with prettier

* test: update snapshot for lint help output

* chore: update changeset to indicate minor version bump

* fix: undo local reference to @redocly/openapi-core

* Update .changeset/tame-gifts-tease.md

---------

Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2024-03-27 15:58:22 +00:00
Lorna Jane Mitchell
ee55f26c36 docs: Fix a silent failure in the Vale rules, check CI can catch it (#1464) 2024-03-05 11:28:11 +00:00
Lorna Jane Mitchell
fd79f7d4c5 docs: Use Museum API instead of Petstore examples (#1386)
* docs: add museum examples to installation and bundle/join commands

* docs: removed petstore examples and updated formatting for readability

* docs: Update petstore to museum examples in decorators section

* chore: Prettier wants to fix a file

* chore: Fix Vale-detected future tense mistakes

* Update docs/decorators/media-type-examples-override.md

* Update docs/commands/lint.md

* Update docs/commands/lint.md

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2024-02-12 18:06:11 +00:00
Lorna Jane Mitchell
de80612b55 chore: Run prettier on all docs files (#1334) 2023-11-17 09:45:03 +00:00
Andrew Tatomyr
4620f79f29 feat: add built-in recommeded-strict ruleset (#1311) 2023-10-26 15:07:19 +03:00
redocly-bot
9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 16:35:49 +00:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Lorna Jane Mitchell
daf030b7a8 Custom plugin documentation (#1222)
* Remove extra 'resources' landing page, redirect from main one

* Move custom plugins file to its own directory, add redirect to handle

* docs: split the custom plugins page into one page per feature

* docs: extend decorators explanation and link to it from the custom plugins section

* docs: Fix all the links that were broken when I moved things

* Apply excellent suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: Add examples of how to use the custom rule

* docs: Replace the nested visitor example with an object rather than a function

* Update custom-rules.md

minor consistency edits

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: clearer explanation of skip, and finish a broken sentence

* Update docs/custom-plugins/index.md

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* Apply suggestions from code review

Co-authored-by: Adam Altman <adam@redoc.ly>

* docs: use object rather than function for visitor

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
Co-authored-by: Adam Altman <adam@redoc.ly>
2023-08-16 14:26:56 +01:00
Lorna Jane Mitchell
0de4e7c9bb Refresh lint article (#1102)
* docs: tidy up lint doc, add JSON format

Rescue some changes from #665 that are worth keeping, and signpost the
rules documentation for configuration examples rather than having that
information duplicated here.

* docs: default value with variable description, anchors for renamed headings
2023-07-18 11:32:43 +01:00
Lorna Jane Mitchell
9dc78a6d3f docs: Improve CLI usage wording (#1162)
* chore: Tidy up usage options and wording

* docs: Update/refresh command docs pages, add completion page

* chore: run prettier

* fix: keep the previous push command format for backward compatibility

* fix: update test snapshots to match new usage output

* chore: run prettier

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-07-12 10:30:05 +01:00
Lorna Jane Mitchell
909fb471ca Add Vale for prose linting (#1099)
* feat: Add Vale configuration and rules

* docs: Fix top-level files to match Vale rules

* docs: Vale updates for the commands docs

* docs: apply Vale updates to the decorator docs

* docs: Update guides to match Vale rules

* docs: update rules and other content to meet Vale standards

* docs: add Vale link and information to CONTRIBUTING

* feat: Add GitHub action for Vale

* docs: minor editing to readme.md

* docs: minor editing to the changelog.md file

* docs: minor edits to the join.md file in commands folder

* docs: minor edits to lint.md file in the commands directory

* docs: minor edit to the login.md file in the commands directory

* docs: minor edits to the preview.md file in the commands directory

* docs: minor edits to push.md file in the comands directory

* docs: minor edits to the info-description-override.md file in the decorators directory

* docs: minor edits to the configure-rules.md file in the guides directory

* docs: minor edits to custom-plugin.md file in the resources directory

* docs: minor editing to the no-http-verbs-in-paths.md file in the rules directory

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-06-01 10:10:43 +01:00
Andrew Tatomyr
6729869869 docs: make greedy arrays false in yargs (#1084) 2023-05-25 16:28:29 +02:00
Ihor Karpiuk
ebbdc17488 chore: 1.0.0-beta.126 (#1069) 2023-05-10 13:06:29 +03:00
Adam Altman
9cad7e2e8d docs: rework assertions into custom rules (#917) 2022-11-02 06:58:54 -05:00
Roman Hotsiy
9a47da57f3 feat: new format option 'summary' (#860) 2022-09-08 13:42:48 -05:00
Andrew Tatomyr
b325e6f503 chore: rename 'entrypoints' into 'apis' (#802) 2022-08-09 18:07:23 +02:00
redocly-bot
417c28b6a8 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-07-18 22:16:28 +00:00
Yevhen Smoliy
b19808c2e3 chore: v1.0.0 beta.103 (#739)
* chore: v1.0.0-beta.103

* feat: add new decorators filter-in and filter-out (#736)

* feat: add new decorators filter-in and filter-out

* chore: remove unused parameters for filter tests

* chore: rename parameter and add new test

* chore: update changelog and build-in-decorators doc

* docs: update docs and changelog

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>
Co-authored-by: igor <Ihor.karpiuk@redocly.com>
Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
2022-06-27 16:54:24 +03:00
redocly-bot
4d8cf1f186 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-14 18:42:52 +00:00
Roman Hotsiy
1cacff2044 chore: rename package to @redocly/cli (#672)
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@gmail.com>
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2022-05-06 16:12:56 +02:00
Eilolz
821850f6d0 feat: added codeclimate formating for lint command (#669)
Co-authored-by: Romain Papa <romain.papa@greencom-networks.com>
2022-05-05 13:24:46 +02:00
redocly-bot
f4db5622b3 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-04 19:32:45 +00:00
redocly-bot
d7ed5092e8 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-04 18:36:13 +00:00
redocly-bot
297082a16b sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-23 22:07:26 +00:00
redocly-bot
e152cc45ff sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-14 10:21:56 +00:00
redocly-bot
5b9cc9d714 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-10 17:33:10 +00:00
Tom Wieczorek
9981ddafb9 feat: add checkstyle as a new lint format (#496) 2022-01-04 17:30:18 +02:00
Anatolii Sieryi
aa3a24cd33 chore: add docs for 1.0.0-beta.69 (#458) 2021-11-24 21:57:27 +02:00
Antonio
7df75c096f Docs: fully revised lint command for openapi-cli (#360)
* docs: fully revised lint command for openapi-cli

* docs: second review stage of the lint cli command

* fix: phrasing issues

* Apply suggestions from code review

* docs: updated lint command according to mentions

* docs: added description for --extends option for lint command

* fix: phrasing issues

* docs: updated lint command document according to mentions

* docs: fixed incorrect link to configuration document in the lint command document

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
2021-10-27 14:41:29 +11:00
redocly-bot
4ff120daba sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-30 21:24:14 +00:00
redocly-bot
187df20648 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-05 23:00:30 +00:00
redocly-bot
2143028637 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-05 01:36:10 +00:00
redocly-bot
acc0e31e22 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-07-06 12:49:53 +00:00