Aller au contenu

Travailler avec un assistant IA

Un assistant IA connaît mal x4js. Laissé à lui-même, il écrit du code inspiré d’autres frameworks, avec des méthodes qui n’existent pas. x4js fournit de quoi l’éviter.

Ils sont installés avec x4js, dans node_modules/x4js/, et correspondent donc toujours à la version que vous utilisez.

Fichier Contenu
aiguide.md Les règles pour écrire du code x4js idiomatique, et les erreurs à éviter.
aicontext.md La référence compacte de l’API : classes, propriétés, signatures exactes.
aicli.md La ligne de commande x4js et les clés de x4.config.json.

Donnez-les à votre assistant avant de lui demander d’écrire du code.

Plutôt que de le répéter à chaque session, écrivez-le dans le fichier d’instructions que votre assistant lit au démarrage, à la racine de votre projet. La plupart lisent AGENTS.md ; Claude Code lit CLAUDE.md.

This project uses x4js. Before writing or reviewing code, read:
- node_modules/x4js/aiguide.md (how to write idiomatic x4js code)
- node_modules/x4js/aicontext.md (exact API)
- node_modules/x4js/aicli.md (command line and build)
Do not invent x4js APIs.

Avec Claude Code, un plugin fait ce travail tout seul. Il contient un skill qui se déclenche dès que la demande concerne x4js, et qui lit les trois fichiers dans votre projet.

Fenêtre de terminal
claude plugin marketplace add rlibre/x4
claude plugin install x4js@rlibre

Pour un assistant qui consulte le site plutôt que votre projet, x4js.org publie un fichier llms.txt : un résumé du framework, les consignes essentielles et les liens vers les trois fichiers.

Avant de corriger, cherchez pourquoi. Il y a trois possibilités :

  1. la documentation était insuffisante ;
  2. l’API était ambiguë ;
  3. l’assistant s’est trompé alors qu’il avait l’information.

Dans le troisième cas, on corrige le code produit. Dans les deux premiers, c’est la documentation ou l’API qu’il vaut la peine d’améliorer : signalez-le sur le dépôt GitHub.