search

adobe / aio-cli-plugin-app

Create, Build and Deploy Cloud Native Applications
Apache License 2.0
19 stars 35 forks source link

app plugin: code links in README point to a `.ts` file #759

Closed shazron closed 5 months ago

shazron commented 5 months ago

Example: https://github.com/adobe/aio-cli-plugin-app?tab=readme-ov-file#aio-app-add has See code: to src/commands/app/add/index.ts

Expected: The code link should point to the actual file, which has a .js extension

aiojbot commented 5 months ago

JIRA issue created: https://jira.corp.adobe.com/browse/ACNA-2800

shazron commented 5 months ago

The line is generated here: https://github.com/oclif/oclif/blob/7e7cd03171e31f958ee6d522d5efd1014d5f1777/src/commands/readme.ts#L65 And the command path is calculated here: https://github.com/oclif/oclif/blob/7e7cd03171e31f958ee6d522d5efd1014d5f1777/src/commands/readme.ts#L257

shazron commented 5 months ago

This PR introduced this issue: https://github.com/oclif/oclif/pull/1191 These lines cause the bug: https://github.com/oclif/oclif/blob/7e7cd03171e31f958ee6d522d5efd1014d5f1777/src/commands/readme.ts#L279-L280

shazron commented 5 months ago

Our eslint config has typescript in it, but I forget why I had to add it for this commit: https://github.com/adobe/eslint-config-aio-lib-config/commit/88c8f9697d6d2fb82039de8272d50824c8b3d167 Removing it from the eslint config, publishing a major, and removing typescript from our plugins (and using the updated eslint config) will fix this issue.