chore: 🧪 release (feat: wip, introduce "respect") (#1919)

* feat: add respect to cli

* chore: prettier

* chore: changes to e2e and rename to respect-core

* feat: remove respect auth

* fix: add ignored module

* chore: add files

* fix: type issue in utils

* fix: update all e2e tests

* chore: renaming

* chore: fix and simplify go-to logic

* chore: fix lint and unit tests

* chore: fix e2e for new goto

* chore: fix scripts to support respect-core

* fix parser:generate

* chore: rename ResultObject type

* chore: remove todos

* chore: sync package-lock

* chore: fix some lint errors

* chore: add secret

* chore: prettier fix

* chore: add abnf-parser to prettierignore

* chore: publish respect-core snaphot to npm

* chore: comment ignored e2e snapshot and update regexp

* fix: update cert regexp

* chore: try fixing publish and yarn smokes

* chore: try fixing publish

* chore: try fixing publish and remove smokes for node 14 and 16

* chore: fix docker smoke test

* chore: improve README and CONTRIBUTING files

* fix: cookies from workflows and step are not set to the request (#1918)

---------

Co-authored-by: DmitryAnansky <[email protected]>
Co-authored-by: Roman Hotsiy <[email protected]>
Co-authored-by: Andrew Tatomyr <[email protected]>

.github/workflows/smoke-plugins.yaml

@@ -64,29 +64,3 @@ jobs:
         with:
           node-version: 18
       - run: bash ./__tests__/smoke-plugins/run-smoke.sh
-
-  run-smoke-plugins--npm--node-16:
-    needs: prepare-smoke-plugins
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/cache@v3
-        with:
-          path: __tests__/smoke-plugins/
-          key: cache-plugins-${{ github.run_id }}-${{ github.run_attempt }}
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: bash ./__tests__/smoke-plugins/run-smoke.sh
-
-  run-smoke-plugins--npm--node-14:
-    needs: prepare-smoke-plugins
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/cache@v3
-        with:
-          path: __tests__/smoke-plugins/
-          key: cache-plugins-${{ github.run_id }}-${{ github.run_attempt }}
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 14
-      - run: bash ./__tests__/smoke-plugins/run-smoke.sh

.github/workflows/snapshot-release.yaml

@@ -31,9 +31,14 @@ jobs:
           # Update Core package version
           jq ".version = \"$VERSION\"" packages/core/package.json > tmp.json && mv tmp.json packages/core/package.json
 
-          # Update CLI package version and the Core dependency
+          # Update Respect Core package version and dependencies
+          jq ".version = \"$VERSION\"" packages/respect-core/package.json > tmp.json && mv tmp.json packages/respect-core/package.json
+          jq ".dependencies[\"@redocly/openapi-core\"] = \"$VERSION\"" packages/respect-core/package.json > tmp.json && mv tmp.json packages/respect-core/package.json
+
+          # Update CLI package version and dependencies
           jq ".version = \"$VERSION\"" packages/cli/package.json > tmp.json && mv tmp.json packages/cli/package.json
           jq ".dependencies[\"@redocly/openapi-core\"] = \"$VERSION\"" packages/cli/package.json > tmp.json && mv tmp.json packages/cli/package.json
+          jq ".dependencies[\"@redocly/respect-core\"] = \"$VERSION\"" packages/cli/package.json > tmp.json && mv tmp.json packages/cli/package.json
 
           # Add comment with installation instructions
           COMMENT="📦 A new experimental version **v$VERSION** of Redocly CLI has been published for testing.
@@ -66,5 +71,11 @@ jobs:
 
           cd packages/core
           npm publish --tag snapshot
+          sleep 10
+
+          cd ../respect-core
+          npm publish --tag snapshot
+          sleep 10
+
           cd ../cli
           npm publish --tag snapshot

.github/workflows/tests.yaml

@@ -28,7 +28,7 @@ jobs:
         run: npm run e2e
         env:
           CI: true
-
+          SANDBOX_REBILLY_TOKEN: ${{ secrets.SANDBOX_REBILLY_TOKEN }}
   cli-package-test:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -13,3 +13,4 @@ output/
 *.tgz
 redoc-static.html
 packages/cli/README.md
+.env

.prettierignore

@@ -4,6 +4,7 @@ lib/
 output/
 *snapshot.js
 packages/core/src/rules/__tests__/fixtures/invalid-yaml.yaml
+packages/respect-core/src/modules/runtime-expressions/abnf-parser.js
 __tests__/webpack-bundle/bundle-workflows/metafile.json
 benchmark/api-definitions/
 LICENSE.md

CONTRIBUTING.md

@@ -1,6 +1,7 @@
 # Redocly CLI Contributing Guide
 
-Hi! We're really excited that you are interested in contributing to Redocly CLI. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
+Hi! We're really excited that you are interested in contributing to Redocly CLI.
+Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
 
 - [Issue reporting guidelines](#issue-reporting-guidelines)
 - [Pull request guidelines](#pull-request-guidelines)
@@ -48,7 +49,8 @@ npm install # or npm i
 
 To compile the code, run `npm run compile`. To do that on the fly, run `npm run watch` in a separate thread.
 
-To run a specific CLI command, use `npm run cli`, e.g. `npm run cli -- lint resources/museum.yaml --format=stylish`. Please notice that the extra `--` is required to pass arguments to the CLI rather than to NPM itself.
+To run a specific CLI command, use `npm run cli`, e.g. `npm run cli -- lint resources/museum.yaml --format=stylish`.
+Please notice that the extra `--` is required to pass arguments to the CLI rather than to NPM itself.
 
 Format your code with `npm run prettier` before committing.
 
@@ -70,15 +72,15 @@ To test local changes as a package, you can use the following steps:
 
 1. Optionally, bump the version of the packages ([see details](#version-updating)).
 
-1. Run `npm run pack:prepare` in the repository's root. This generates **redocly-cli.tgz** and **openapi-core.tgz** files and makes some changes to **packages/cli/package.json** file.
+1. Run `npm run pack:prepare` in the repository's root.
+   This generates **redocly-cli.tgz**, **respect-core.tgz**, and **openapi-core.tgz** files.
 
-1. Copy **redocly-cli.tgz** file to a destination folder and then run `npm install redocly-cli.tgz` there to install Redocly CLI. To install `openapi-core` do the same but with **openapi-core.tgz** file.
-
-Don't forget to revert the changes to **package.json** files later.
+1. Copy those **.tgz** files to a destination folder and then run `npm install redocly-cli.tgz` there to install Redocly CLI. To install `openapi-core` do the same but with **openapi-core.tgz** file.
 
 ## Contribute documentation
 
-Additions and updates to our documentation are very welcome. You can find the documentation in the `docs/` folder, and this is published to https://redocly.com/docs/cli/ as part of our main website.
+Additions and updates to our documentation are very welcome.
+You can find the documentation in the `docs/` folder, and this is published to https://redocly.com/docs/cli/ as part of our main website.
 
 To preview your documentation changes locally:
 
@@ -92,11 +94,14 @@ redocly preview
 
 By default, you can access the docs preview at http://localhost:4000 or http://127.0.0.1:4000.
 
-> Please note that currently the custom markdoc tags used in the main website are not available in the local preview version, and links that point to the wider website do show as errors when using a local platform. The pull request workflows generate a full preview, so rest assured that you are able to check everything is in good shape before we review and merge your changes.
+> Please note that currently the custom markdoc tags used in the main website are not available in the local preview version, and links that point to the wider website do show as errors when using a local platform.
+> The pull request workflows generate a full preview, so rest assured that you are able to check everything is in good shape before we review and merge your changes.
 
 ### Prose linting
 
-We are proud of our docs. When you open a pull request, we lint the prose using [Vale](https://vale.sh/). You can also install this tool locally and run it from the root of the project with:
+We are proud of our docs.
+When you open a pull request, we lint the prose using [Vale](https://vale.sh/).
+You can also install this tool locally and run it from the root of the project with:
 
 ```bash
 vale docs/
@@ -112,7 +117,9 @@ We use [Markdownlint](https://github.com/DavidAnson/markdownlint) to check that
 
 ### Markdown link checking
 
-We use [`mlc`](https://github.com/becheran/mlc) to check the links in the `docs/` folder. This tool runs automatically on every pull request, but you can also run it locally if you want to. Visit the project homepage to find the installation instructions for your platform, and then run the command like this:
+We use [`mlc`](https://github.com/becheran/mlc) to check the links in the `docs/` folder.
+This tool runs automatically on every pull request, but you can also run it locally if you want to.
+Visit the project homepage to find the installation instructions for your platform, and then run the command like this:
 
 ```bash
 mlc docs/
@@ -122,7 +129,8 @@ It only checks links within the local docs (it can't check links to other docs s
 
 ## Built-in rules changes
 
-After adding a new rule, make sure it is added to the `minimal`, `recommended`, `recommended-strict` (the same as the previous but with warnings turned into error) and `all` rulesets with appropriate severity levels. The defaults are `off` for `minimal` and `recommended` and `error` for `all`.
+After adding a new rule, make sure it is added to the `minimal`, `recommended`, `recommended-strict` (the same as the previous but with warnings turned into error) and `all` rulesets with appropriate severity levels.
+The defaults are `off` for `minimal` and `recommended` and `error` for `all`.
 Also add the rule to the built-in rules list in [the config types tree](./packages/core/src/types/redocly-yaml.ts).
 
 Separately, open a merge request with the corresponding documentation changes.
@@ -139,11 +147,16 @@ Environment variables should not affect the **core** package logic.
 
 ### Command line arguments
 
-Use them to provide some arguments that are specific to a certain command. Think of them as modifiers. They should not affect the **core** package logic.
+Use them to provide some arguments that are specific to a certain command.
+Think of them as modifiers.
+They should not affect the **core** package logic.
 
 ### Configuration file
 
-The **redocly.yaml** file is the most flexible way of providing arguments. Please use it to provide arguments that are common for all the commands, for a specific command, or for a specific API. It could be used for providing arguments for both **cli** and **core** packages. Please refer to the [configuration file](https://redocly.com/docs/cli/configuration/) documentation for more details.
+The **redocly.yaml** file is the most flexible way of providing arguments.
+Please use it to provide arguments that are common for all the commands, for a specific command, or for a specific API.
+It could be used for providing arguments for both **cli** and **core** packages.
+Please refer to the [configuration file](https://redocly.com/docs/cli/configuration/) documentation for more details.
 
 ## Exit codes
 
@@ -217,14 +230,17 @@ If you made any changes, make sure to compile the code before running the tests.
       - **`packages/core/src/types`**: contains the common types for several OpenAPI versions.
       - **`packages/core/src/typings`**: contains the common Typescript typings.
 
+  - **`packages/respect-core`**: contains the Respect core package.
+
 - **`resources`**: contains some example API descriptions and configuration files that might be useful for testing.
 
 ## Release flow
 
 We use [Changesets](https://github.com/changesets/changesets) flow.
 After merging a PR with a changeset, the release PR is automatically created.
 
-If the pipelines are not starting, close and reopen the PR. Merging that PR triggers the release process.
+If the pipelines are not starting, close and reopen the PR.
+Merging that PR triggers the release process.
 
 ### Revert a release
 

Dockerfile

@@ -1,36 +1,20 @@
 FROM node:alpine
 
 WORKDIR /build
-
-# Copy files required for npm install only
-COPY package.json package-lock.json /build/
-COPY packages/cli/package.json /build/packages/cli/
-COPY packages/core/package.json   /build/packages/core/
-COPY packages/cli/bin/ /build/packages/cli/bin/
-
-RUN npm ci --no-optional --ignore-scripts
-
-# Copy rest of the files
-COPY . /build/
-RUN npm run prepare
-
-# Install redocly-cli globally, similar to npm install --global @redocly/cli
-# but the local package is used here
-RUN apk update && apk add jq && \
-    apk add git && \
+COPY . .
+RUN apk add --no-cache jq git && \
+    npm ci --no-optional --ignore-scripts && \
+    npm run prepare && \
     npm run pack:prepare && \
-    npm install --global redocly-cli.tgz
-
-# npm pack in the previous RUN command does not include these assets
-RUN cp packages/cli/src/commands/preview-docs/preview-server/default.hbs /usr/local/lib/node_modules/@redocly/cli/lib/commands/preview-docs/preview-server/default.hbs && \
-    cp packages/cli/src/commands/preview-docs/preview-server/hot.js /usr/local/lib/node_modules/@redocly/cli/lib/commands/preview-docs/preview-server/hot.js && \
-    cp packages/cli/src/commands/build-docs/template.hbs /usr/local/lib/node_modules/@redocly/cli/lib/commands/build-docs/template.hbs
-
-# Clean up to reduce image size
-RUN npm cache clean --force && rm -rf /build
+    npm install --global redocly-cli.tgz && \
+    cp packages/cli/src/commands/preview-docs/preview-server/default.hbs \
+       packages/cli/src/commands/preview-docs/preview-server/hot.js \
+       /usr/local/lib/node_modules/@redocly/cli/lib/commands/preview-docs/preview-server/ && \
+    cp packages/cli/src/commands/build-docs/template.hbs \
+       /usr/local/lib/node_modules/@redocly/cli/lib/commands/build-docs/ && \
+    # Clean up to reduce image size
+    npm cache clean --force && rm -rf /build
 
 WORKDIR /spec
-
-ENTRYPOINT [ "redocly" ]
-
+ENTRYPOINT ["redocly"]
 ENV REDOCLY_ENVIRONMENT=docker