Commit Graph

375 Commits

Author SHA1 Message Date
github-actions[bot]
cf2ac84426 chore: 🔖 release new versions (#1410) 2024-01-26 16:10:24 +02:00
github-actions[bot]
d95bef1bf2 chore: 🔖 release new versions (#1370) 2024-01-23 13:04:55 +02:00
volodymyr-rutskyi
4ff9eb64c1 docs: preview command (#1384) 2024-01-23 12:49:56 +02:00
Lorna Jane Mitchell
e8ea285762 docs: add a guide for linting and bundling as two separate but chained commands (#1385)
* docs: add a guide for linting and bundling as two separate but chained commands

* Apply suggestions from code review

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

* docs: reformat wrapping

* docs: grammar fix for guides index page

* Update docs/guides/lint-and-bundle.md

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

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2024-01-11 08:46:18 +00:00
Andrew Tatomyr
7c7198d72e docs: correct description of multiline patterns usage based on #1353 (#1380) 2024-01-04 12:56:50 +02:00
Lorna Jane Mitchell
574541f12e docs: Add a note about expected newlines in multiline markdown fields (#1372) 2024-01-02 11:17:36 +00:00
Julien
918f570203 docs: fix typo in the migration guide (#1366) 2023-12-21 19:20:16 +02:00
Andrew Tatomyr
9930c3c339 docs: explain using refs in a config file (#1364)
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-12-21 18:41:54 +02:00
github-actions[bot]
122ce07670 chore: 🔖 release new versions (#1361) 2023-12-21 16:09:59 +02:00
Lorna Jane Mitchell
cddec3327f Docs: Add examples for the filter decorators (#1360)
* docs: Add an example for filter out decorator

* docs: Add a filter-in example

* Chore: run prettier
2023-12-15 10:59:34 +00:00
Ihor Karpiuk
588b956d85 chore: deprecate lint option in the join command (#1349) 2023-12-14 18:09:40 +02:00
Lorna Jane Mitchell
513a6a1b8d docs: Minor fix to code sample from website feedback (#1359) 2023-12-14 13:22:21 +00:00
Ihor Karpiuk
d5e2e289b8 chore: update link to async api specification (#1350) 2023-12-07 18:35:28 +02:00
Lorna Jane Mitchell
88cd624d7a Docs updates spotted when crafting Advent content (#1346)
* docs: Fix typo and remove reference to feature we're planning to drop

* docs: re-word the rule explanation, add link to operationId blog post

* docs: simplify rule description, pick more relevant related rules to link to

* docs: simplify kebab-case explanation
2023-12-04 12:02:01 +00:00
github-actions[bot]
70e5133708 chore: 🔖 release new versions (#1337) 2023-11-29 12:54:55 +02:00
Ihor Karpiuk
79936f2bb3 chore: add deprecate warning for the lint-related options (#1342)
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2023-11-29 11:06:10 +02:00
Lorna Jane Mitchell
c6831826d4 docs: Add a cookbook mention to the configurable rules page (#1341)
* docs: Add a cookbook mention to the configurable rules page

* chore: Run prettier.
2023-11-28 10:12:25 +00:00
Ihor Karpiuk
efb6a453f5 feat: create new rule to enforce array parameters format (#1338) 2023-11-24 16:18:58 +02:00
Lorna Jane Mitchell
afb5d9425f docs: Update docs tooling and checks (#1330)
* fix: Remove github token with incorrect access

* docs: Improve uninstall CTA in migration guide

* fix: Update checkout action version for vale

* docs: Vale reports errors in any edited file

* docs: Update to make Vale happy

* docs: Markdownlint fixes

* fix: Remove sync actions as this integration is no longer used

* core: Add markdownlint config and github action

Uses rules from https://github.com/Redocly/marketing-site-portal/pull/1142

* chore: Move contributing file to top level

* chore: Add markdown to the file types that we want prettier to operate on

* fix: Make files fit prettier rules, ignore LICENSE since we can't change that

* chore: Combine docs-related workflows into one for simplicity

* docs: Add instructions for running the CLI docs standalone from this repo

* chore: Add changeset, this docs change is quite large

* Update .changeset/bright-steaks-walk.md

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>

---------

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>
2023-11-20 16:00:32 +00:00
Lorna Jane Mitchell
de80612b55 chore: Run prettier on all docs files (#1334) 2023-11-17 09:45:03 +00:00
github-actions[bot]
166e16d6ca chore: 🔖 release new versions (#1315) 2023-11-15 15:14:37 +01:00
Lorna Jane Mitchell
2ad0ffb0c2 docs: decorators in main sidebar (#1324) 2023-11-10 16:02:28 +00:00
redocly-bot
d008291a32 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-09 15:56:27 +00:00
Andrew Tatomyr
3f13cb9ada chore: move remove-unused-components decorator to decorators folder (#1316) 2023-11-09 09:36:13 +01:00
redocly-bot
828290ea23 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-08 11:55:24 +00:00
redocly-bot
eadf29f6a8 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-03 15:28:27 +00:00
github-actions[bot]
b50ae469c4 chore: 🔖 release new versions (#1313) 2023-10-26 16:31:02 +03:00
Andrew Tatomyr
4620f79f29 feat: add built-in recommeded-strict ruleset (#1311) 2023-10-26 15:07:19 +03:00
Ihor Karpiuk
1510e471b7 feat: extend split and join commands to produce JSON output (#1305) 2023-10-26 14:42:06 +03:00
github-actions[bot]
4e712a8c70 chore: 🔖 release new versions (#1306) 2023-10-19 17:02:17 +03:00
Ihor Karpiuk
0c52110c80 chore: set default severity for lint config (#1292) 2023-10-19 16:23:18 +03:00
Jeremy Fiel
fcae48e9f4 fix(docs): update example (#1281) 2023-10-19 10:54:11 +02:00
redocly-bot
1280b08336 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-18 14:49:40 +00:00
github-actions[bot]
45b31e6640 chore: 🔖 release new versions (#1272) 2023-10-18 08:48:35 +02:00
redocly-bot
c4ae8fac66 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-10 13:31:02 +00:00
redocly-bot
85a5c6b281 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 19:12:22 +00:00
redocly-bot
9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 16:35:49 +00:00
Andrew Tatomyr
cfe66a79a9 chore: set minimal required NPM version to 7 (#1267) 2023-09-21 15:46:15 +02:00
github-actions[bot]
e16f1fd3a2 chore: 🔖 release new versions (#1264) 2023-09-18 15:55:23 +02:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Roman Hotsiy
680c431cbb AsyncAPI linting support (#1127)
* chore: progress on asyncapi

* chore: more progress

* chore: enable assertions

* Feat: Start adding protocol-specific channel bindings

* Feat: flesh out components fields

* Fix: remove link and x-code-sample, not supported for asyncapi

* Feat: Add solace protocol support

* chore: refactor channel/server bindings to define and add to collection

* chore: re-order nodes to group by protocol

* chore: re-order node listings to also group by protocol

* feat: add topicConfiguration for Kafka and fix a typo

* feat: rename ServerMap for clarity

* feat: Add message bindings, remove incomplete protocols

* fix: a few tests were failing after original refactoring

* feat: add MessageTrait object

* feat: Add operation bindings, export operation and message bindings

* Feat: add a few rules for asyncapi, create channels-kebab-case

* fix: Add messageBindings and operationBindings to components section

* feat: Add no-channel-trailing-slash rule for asyncapi

* fix: Update allowed/required list for httpAPIkey

* chore: add tests for new AsyncAPI rules

* Feat: Add sample asyncapi descriptions as tests

* chore: generate snapshot.js for async-api tests

* chore: fix some minor drift between main branch and this one after
rebasing

* docs: add a guide to linting AsyncAPI

* fix: broken links in guide

* chore: run prettier

* chore: update test snapshot

* chore: clean up comments and stray log message

* docs: Update from review feedback, and add a health warning

* Update packages/core/src/config/config-resolvers.ts

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>

* fix: allow async2 as the only feature in custom plugins

* chore: add tests and tweak error messages for document type detection

* chore: fix tests and rename majorSpecVersion->getMajorSpecVersion

* chore: run prettier

* chore: Tidy and improve comments in main asyncapi types file

* chore: remove outdated comment

* fix: remove extraneous empty extends from guide and tests

* docs: Add changeset for AsyncAPI feature

* Update .changeset/quick-emus-punch.md

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>

---------

Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: SmoliyY <yevhen.smoliy@gmail.com>
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
2023-09-15 13:52:03 +01:00
github-actions[bot]
b8bf0075ac chore: 🔖 release new versions (#1218) 2023-09-14 16:12:57 +02:00
Arif Kurkchi
cb7e3edf42 feat: add ignoreCase for tags-alphabetical rule (#1258) 2023-09-13 12:18:07 +02:00
redocly-bot
06c8fda196 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-08-21 16:58:19 +00:00
redocly-bot
068db392ae sync: Synced local 'docs/' with remote 'docs/cli/' 2023-08-18 13:10:39 +00: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
redocly-bot
572980cb33 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-08-08 13:12:44 +00:00
github-actions[bot]
79820648b5 chore: 🔖 release new versions (#1217) 2023-08-07 19:15:18 +03:00
github-actions[bot]
c5c30bc2eb chore: 🔖 release new versions (#1213) 2023-08-07 14:27:59 +02:00
Andrew Tatomyr
499482d279 chore: enable chagesets (#1211) 2023-08-07 11:40:21 +02:00