forklift-console-plugin AGENTS.md

AI Assistant Guidelines for Forklift Console Plugin

Project overview, tech stack, and domain knowledge: See .cursor/rules/project-context.mdc for Forklift-specific context (CRDs, providers, migration flow, architecture). This file focuses on coding standards and conventions.

---

Code Style & Conventions

TypeScript

1. Use type instead of interface for type definitions:

   // ✅ Good
   type UserProps = {
     name: string;
     age: number;
   };
   
   // ❌ Bad
   interface UserProps {
     name: string;
     age: number;
   }
   

2. Type imports:

   • If all imports from a module are types, use import type:

     // ✅ Good - all imports are types
     import type { FC, ReactNode } from 'react';
     import type { UserProps } from './types';
     

   • If some imports are types and some are values, use inline type keyword:

     // ✅ Good - mixed types and values
     import { type FC, useState, type ReactNode } from 'react';
     

   • Never separate type and value imports from the same module:

     // ❌ Bad - separate imports from same module
     import type { FC } from 'react';
     import { useState } from 'react';
     

3. Strict null checks are enabled - always handle nullable values properly.

React

1. Never use default or star imports for React:

   // ✅ Good
   import { useState, useEffect, type FC } from 'react';
   
   // ❌ Bad
   import React from 'react';
   import * as React from 'react';
   

2. Use functional components with FC type:

   const MyComponent: FC<MyComponentProps> = ({ prop1, prop2 }) => {
     return <div>{prop1}</div>;
   };
   

3. Export components as default at the end of the file (for component files).

PatternFly Components

1. Use ButtonVariant enum instead of string literals:

   // ✅ Good
   <Button variant={ButtonVariant.primary}>Click</Button>
   
   // ❌ Bad
   <Button variant="primary">Click</Button>