Skip to content

Set up Cursor Cloud dev environment for ODF Console #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TimothyAsirJeyasing wants to merge 1 commit into
base: rh-8574-mirrorpeer-pre-pair-validation
Choose a base branch
from
Draft

Set up Cursor Cloud dev environment for ODF Console #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# AGENTS.md

## Cursor Cloud specific instructions

ODF Console is the UI plugin for the OpenShift Data Foundation operator. It is an
OpenShift Console **dynamic plugin**: a webpack dev server (default port `9001`)
serves a module-federation bundle (`plugin-entry.js`) and a `plugin-manifest.json`
that a running OpenShift Console bridge loads at runtime. It is a single Yarn
workspace repo (`packages/*`); there is no standalone backend service to run.

### Environment / package manager
- Package manager is **Yarn Berry v4** (pinned via `packageManager` in `package.json`,
resolved through Corepack). The update script runs `corepack enable` + `yarn install`,
so dependencies are already present at session start.
- Node comes from the VM's `/exec-daemon/node` (v22.x), which satisfies the
`engines` requirement (`>=20.19.2`). `.nvmrc` pins `22.17` but the available
22.x runtime works for install/build/lint/test.

### Standard commands (see `package.json` scripts, `README.md`)
- Lint: `yarn lint` (runs `lint-ts` eslint + `lint-css` stylelint).
- Unit tests: `yarn test` (jest). ~670 tests; some React Router deprecation
warnings are logged during the run but tests pass.
- Dev server: `yarn dev` — compiles and serves the odf plugin on port `9001`.
First compile takes ~25s. Verify readiness by fetching
`http://localhost:9001/plugin-manifest.json` (HTTP 200) and
`http://localhost:9001/plugin-entry.js`.
- `yarn dev-mco` / `yarn dev-client` serve the mco / client plugin variants instead.

### Non-obvious caveats
- Running the **full console UI** requires a live OpenShift cluster + the console
bridge (`yarn dev:c` / `scripts/start-ocp-console.sh`, which need `oc`, a cluster,
and podman/docker). That is not available in this VM, so end-to-end UI testing of
plugin pages is not possible here. `yarn dev` alone (serving the manifest/bundle)
is the runnable, verifiable target.
- The pre-commit hook (`.husky/pre-commit`) runs `lint-staged`, `yarn i18n -s`, and
re-stages `locales/`. Commits may modify translation files.