mirror of
https://github.com/harvester/harvester-ui-extension.git
synced 2026-05-14 15:01:44 +00:00
bf9b5866a7
* feat: add AGENNTS.md * refactor: update based on copilot feedback * refactor: update AGENTS.md * refactor: update based on AI suggestion * refactor: based on comments * refactor: some files * refactor: boundaries.md --------- (cherry picked from commit 67bb6dfbd5d7f3632a138626ade5040188b76394) Signed-off-by: Andy Lee <andy.lee@suse.com> Co-authored-by: Andy Lee <andy.lee@suse.com>
65 lines
1.9 KiB
Markdown
65 lines
1.9 KiB
Markdown
## Tools
|
|
|
|
### Prerequisites
|
|
|
|
- **Node.js**: `>= 24.0.0` (see `.nvmrc` for the pinned version: `24`)
|
|
- **Package manager**: `yarn` (v1 classic)
|
|
|
|
### Common Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `yarn install --frozen-lockfile` | Install dependencies (CI-safe, no lockfile changes) |
|
|
| `RANCHER_ENV=harvester API=https://<harvester-ip> yarn dev` | Start development server at `https://127.0.0.1:8005` |
|
|
| `yarn build-pkg harvester` | Build the Harvester extension package |
|
|
| `yarn serve-pkgs` | Serve the locally built extension for testing |
|
|
| `yarn lint` | Run ESLint (zero warnings allowed) |
|
|
| `yarn lint:fix` | Run ESLint with auto-fix |
|
|
| `yarn clean` | Clean build artifacts |
|
|
| `yarn agents:generate` | Regenerate `AGENTS.md` from `docs/agents.md/` sources |
|
|
|
|
### Development
|
|
|
|
- **Start dev server**:
|
|
```bash
|
|
RANCHER_ENV=harvester API=https://your-harvester-ip yarn dev
|
|
```
|
|
- `API` should point to a running Harvester cluster (e.g., `https://x.x.x.x`).
|
|
- The dashboard will be available at `https://127.0.0.1:8005`.
|
|
|
|
### Building
|
|
|
|
- **Build extension package**:
|
|
```bash
|
|
yarn build-pkg harvester
|
|
```
|
|
- **Serve locally built extension** (for integration testing with a Rancher instance):
|
|
```bash
|
|
yarn serve-pkgs
|
|
```
|
|
|
|
### Linting
|
|
|
|
- **Check** (must pass with zero warnings):
|
|
```bash
|
|
yarn lint
|
|
```
|
|
- **Auto-fix**:
|
|
```bash
|
|
yarn lint:fix
|
|
```
|
|
- ESLint covers `.js`, `.ts`, and `.vue` files.
|
|
- Always run `yarn lint:fix` before committing.
|
|
|
|
### Commit Conventions
|
|
|
|
- Commits are validated by [commitlint](https://commitlint.js.org/) via a Husky `commit-msg` hook.
|
|
- Follow [Conventional Commits](https://www.conventionalcommits.org/) format (configured in `commitlint.config.js`).
|
|
|
|
### Agent Documentation
|
|
|
|
- Source files live in `docs/agents.md/` (agents, contributors, personas subdirectories).
|
|
- After editing any source file, regenerate the root `AGENTS.md`:
|
|
```bash
|
|
yarn agents:generate
|
|
``` |