feat: add the eject and translate commands #1668

tatomyr · 2024-08-16T12:06:56Z

What/Why/How?

Added the translate and eject commands.

Also, refactored types.

~~Open questions: https://github.com/Redocly/redocly/issues/9612#issuecomment-2298159934 .~~

Another question: do we want to use options in camel case like --configDir? We mostly use kebab-case for options (except for --outDir in the split command and some options in the build-docs command which is legacy of redoc-cli I believe).

Reference

Resolves #1629

The eject docs PR: https://github.com/Redocly/redocly/pull/10344

Testing

Screenshots (optional)

Check yourself

Code changed? - Tested with redoc/reference-docs/workflows (internal)
All new/updated code is covered with tests
New package installed? - Tested in different environments (browser/node)

Security

Security impact of change has been considered
Code follows company security practices and guidelines

changeset-bot · 2024-08-16T12:07:00Z

🦋 Changeset detected

Latest commit: 46595da

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@redocly/cli	Minor
@redocly/openapi-core	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2024-08-16T12:08:18Z

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`redocly lint packages/core/src/benchmark/benches/rebilly.yaml`	999.0 ± 22.6	958.9	1035.3	1.02 ± 0.03
`redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml`	983.1 ± 18.0	956.9	1015.2	1.00

github-actions · 2024-08-16T12:09:01Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	77.5%	4739/6115
🟡	Branches	65.84%	1968/2989
🟡	Functions	71.78%	781/1088
🟡	Lines	77.69%	4471/5755

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🔴	`...` / eject.ts	0%	0%	0%	0%
🔴	`...` / translations.ts	0%	0%	0%	0%

Test suite run success

765 tests passing in 108 suites.

Report generated by 🧪jest coverage report action from 46595da

packages/cli/src/index.ts

lornajane · 2024-08-20T15:29:41Z

If we are shipping this CLI update without docs (I assume we are, since time is pressing), please open one issue per command for documentation, and link those issues to this pull request. I'll pick them up (we sort of have some old translations docs, but they're not ready to publish as they are)

lornajane

Added a few comments of things to tidy up before we can publish, trying to make things clear and consistent with existing CLI patterns.

packages/cli/src/index.ts

.changeset/short-panthers-smoke.md

packages/cli/src/index.ts

Co-authored-by: Lorna Jane Mitchell <[email protected]>

docs/commands/preview.md

lornajane · 2024-08-22T18:52:06Z

docs/commands/preview.md

+| --plan            | string  | Product plan to use in preview. <br/> **Possible values:** `pro`, `enterprise`. The default value is `enterprise`. For more details, see [plans](https://redocly.com/pricing/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| --product         | string  | Name of a product to preview the project with. <br/> **Possible values:** `redoc`, `revel`, `reef`, `realm`, `redoc-revel`, `redoc-reef`, `revel-reef`. <br/> `redoc` is the flagship product for generating API documentation from OpenAPI specifications. <br/> `revel` is a specialized product designed for external API applications. <br/> `reef` is a specialized product designed for internal API needs. <br/> `realm` is a balanced product combining `redoc`, `revel`, and `reef`. <br/> `redoc-revel` is a blended product combining `redoc` and `revel`. <br/> `redoc-reef` is a blended product combining `redoc` and `reef`. <br/> `revel-reef` is a blended product combining `revel` and `reef`. <br/> The default value is autodetected from the project's `package.json` or `realm` is used. |
+| --project-dir, -d | string  | Path to the project directory. The default value is `.` (current directory).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| --port, -p        | number  | The port to run the preview server on. The default value is `4000`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |


This may not be a helpful change for a command that has port, plan and product parameters. Not a blocking request for change, but a general note that we did discuss this at the time that the command was implemented.

I don't see the problem with that at all.

Here is an example of a psql (Postgress client) CLI docs:

They have multiple args that start with letter p but still use -p as --port.

I also see this very common to in linux CLI tools, e.g. curl -i where -i is an alias for --show-headers while curl has many other arguments starting with letter i: --include, --insecure, --interface.

packages/cli/src/index.ts

Avoid blocking progress while I am OOO

adamaltman · 2024-08-23T01:38:55Z

.changeset/short-panthers-smoke.md

+"@redocly/cli": minor
+---
+
+Added the `eject` and `translations` commands for use with the new Reunite-hosted product family.


I don't want to be annoying in the final hour. I think we should rename the translations command to translate. Most of our commands are in verb format:

lint

bundle

eject

preview

Why not translate?

Here's the corresponding PR for the original source: https://github.com/Redocly/redocly/pull/10425

adamaltman · 2024-08-23T01:43:00Z

packages/cli/src/commands/translations.ts

+  const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
+  spawn(
+    npxExecutableName,
+    ['-y', '@redocly/realm', 'translations', argv.locale, `--project-dir=${argv['project-dir']}`],


I would also recommend we rename it in the original source to translate too.

tatomyr self-assigned this Aug 16, 2024

tatomyr force-pushed the feat/add-translations-and-eject branch 5 times, most recently from 068767b to 04f3a21 Compare August 20, 2024 07:40

tatomyr marked this pull request as ready for review August 20, 2024 07:41

tatomyr requested review from a team as code owners August 20, 2024 07:41

tatomyr requested review from volodymyr-rutskyi, BohdanPetryshyn, adamaltman and RomanHotsiy August 20, 2024 07:42

tatomyr changed the title ~~feat: add the translations command~~ feat: add the eject and translations commands Aug 20, 2024

RomanHotsiy approved these changes Aug 20, 2024

View reviewed changes

JLekawa approved these changes Aug 20, 2024

View reviewed changes

lornajane reviewed Aug 20, 2024

View reviewed changes

packages/cli/src/index.ts Outdated Show resolved Hide resolved

lornajane previously requested changes Aug 20, 2024

View reviewed changes

lornajane reviewed Aug 20, 2024

View reviewed changes

packages/cli/src/index.ts Outdated Show resolved Hide resolved

RomanHotsiy reviewed Aug 21, 2024

View reviewed changes

packages/cli/src/index.ts Show resolved Hide resolved

tatomyr force-pushed the feat/add-translations-and-eject branch 3 times, most recently from 40446ea to 67e9b69 Compare August 21, 2024 14:03

tatomyr and others added 3 commits August 22, 2024 19:56

feat: add the translations command

567a1be

feat: add eject command

bcd9b4a

Update .changeset/short-panthers-smoke.md

b0e76b2

Co-authored-by: Lorna Jane Mitchell <[email protected]>

tatomyr and others added 5 commits August 22, 2024 19:56

Update packages/cli/src/index.ts

5435e45

Co-authored-by: Lorna Jane Mitchell <[email protected]>

Update packages/cli/src/index.ts

85ad886

Co-authored-by: Lorna Jane Mitchell <[email protected]>

update commands descriptions

93b1a76

add the -p alias for preivew; update eject/contentDir description

7970582

alighn option naming with the latest Realm changes

cf81199

tatomyr force-pushed the feat/add-translations-and-eject branch from 4e61e6e to cf81199 Compare August 22, 2024 16:56

lornajane reviewed Aug 22, 2024

View reviewed changes

resolve comments

f7eca05

adamaltman reviewed Aug 23, 2024

View reviewed changes

rename translations to translate

46595da

tatomyr changed the title ~~feat: add the eject and translations commands~~ feat: add the eject and translate commands Aug 23, 2024

tatomyr requested a review from RomanHotsiy August 23, 2024 07:13

RomanHotsiy approved these changes Aug 23, 2024

View reviewed changes

RomanHotsiy merged commit 78e0881 into main Aug 23, 2024
31 checks passed

RomanHotsiy deleted the feat/add-translations-and-eject branch August 23, 2024 07:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add the eject and translate commands #1668

feat: add the eject and translate commands #1668

tatomyr commented Aug 16, 2024 •

edited

Loading

changeset-bot bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

lornajane commented Aug 20, 2024

lornajane left a comment

lornajane Aug 22, 2024

RomanHotsiy Aug 23, 2024

adamaltman Aug 23, 2024

RomanHotsiy Aug 23, 2024

tatomyr Aug 23, 2024

adamaltman Aug 23, 2024

feat: add the eject and translate commands #1668

feat: add the eject and translate commands #1668

Conversation

tatomyr commented Aug 16, 2024 • edited Loading

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

changeset-bot bot commented Aug 16, 2024 • edited Loading

🦋 Changeset detected

github-actions bot commented Aug 16, 2024 • edited Loading

github-actions bot commented Aug 16, 2024 • edited Loading

Coverage report

Test suite run success

lornajane commented Aug 20, 2024

lornajane left a comment

Choose a reason for hiding this comment

lornajane Aug 22, 2024

Choose a reason for hiding this comment

RomanHotsiy Aug 23, 2024

Choose a reason for hiding this comment

adamaltman Aug 23, 2024

Choose a reason for hiding this comment

RomanHotsiy Aug 23, 2024

Choose a reason for hiding this comment

tatomyr Aug 23, 2024

Choose a reason for hiding this comment

adamaltman Aug 23, 2024

Choose a reason for hiding this comment

tatomyr commented Aug 16, 2024 •

edited

Loading

changeset-bot bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading