Skip to content

AGENTS.md

Latest commit

 

History

History
98 lines (69 loc) · 2.86 KB

AGENTS.md

File metadata and controls

98 lines (69 loc) · 2.86 KB
Raw

Configuration for AI agents

ESLint Configuration

This project uses ESLint rules from cozy-libs. When generating code, strictly follow these rules:

Configuration files

  • config/eslint-config-cozy-app/basics.js
  • config/eslint-config-cozy-app/react.js

Important rules to follow

Prettier (formatting)

'prettier/prettier': [
  'error',
  {
    arrowParens: 'avoid',      // No parentheses for single-parameter arrow functions
    endOfLine: 'auto',         // Automatic line ending
    semi: false,               // NO SEMICOLONS at end of lines
    singleQuote: true,         // Single quotes
    trailingComma: 'none'      // NO TRAILING COMMAS
  }
]

Import/Order (import order)

  • Mandatory alphabetical order (alphabetize: { order: 'asc' })
  • Import groups in this order:
    1. builtin (Node.js modules)
    2. external (npm packages)
    3. internal (project internal imports)
    4. ['parent', 'sibling', 'index'] (relative imports)
  • Special pattern for cozy-_ and twake-_ (position after external)
  • Empty line between each group (newlines-between: 'always')

React

  • react/prop-types: off (disabled)
  • react/jsx-curly-brace-presence: no unnecessary braces for props and children
  • No display-name in .spec files

TypeScript (if applicable)

  • explicit-function-return-type: required
  • no-explicit-any: forbidden

Compliant code example

import React from "react";

import Button from "cozy-ui/transpiled/react/Buttons";
import cx from "classnames";

import FieldInput from "./FieldInput";
import { makeIsRequiredError } from "./helpers";

const MyComponent = ({ name, label }) => {
  const isError = makeIsRequiredError(name);

  return (
    <div className={cx("u-mt-1", { "u-flex": isError })}>
      <FieldInput name={name} label={label} />
    </div>
  );
};

export default MyComponent;

Note:

  • No semicolons
  • Single quotes
  • No trailing comma
  • Alphabetical import order (React before Button, Button before cx)
  • Empty line between import groups (builtin/external, external/internal, etc.)

Package update within the monorepo

Do not manually bump package versions. Lerna updates them automatically in CI based on conventional commits.

Migration order within the monorepo

The CI runs tests for all packages on every PR. When a package is modified and its dist/ gets rebuilt, any other package importing from that dist (via workspace imports) may break.

Rule: migrate consumers before the packages they consume. The most-consumed dependency should be migrated last.

Dependency-aware migration steps for any package-level change:

  1. Check the dependency graph: which packages does this one consume? Which consume it?
  2. Migrate leaf consumers first (packages that no other workspace package depends on)
  3. Work up the dependency chain
  4. Migrate the root dependency (consumed by everyone) last