Ús amb agents de programació amb IA
Els assistents de programació amb IA sovint escriuen el seu propi codi per calcular la lletra d’un DNI, o apliquen una regla desfasada a un CIF. Aquesta biblioteca inclou documentació en text pla escrita per a ells, perquè la puguin fer servir en lloc d’això, des del vostre node_modules o des d’aquest lloc web.
Els fitxers
Secció titulada «Els fitxers»| Fitxer | Què conté | On és |
|---|---|---|
llms.txt |
Una guia breu (uns 2.000 tokens): quina funció fer servir, fragments provats, els codis d’error i els errors habituals | En aquest lloc web i a node_modules/nif-dni-nie-cif-validation/llms.txt |
llms-full.txt |
La referència completa en un sol fitxer: el README, el disseny de l’API, la guia de migració des de la v1 i les regles amb les seves fonts | En aquest lloc web i a node_modules/nif-dni-nie-cif-validation/llms-full.txt |
Tots dos segueixen la convenció llms.txt i són en anglès. Van dins del paquet d’npm, de manera que un agent que només pugui llegir el vostre projecte també els troba. Tots els fragments de codi de llms.txt s’executen als tests de la biblioteca.
Instruccions per al vostre agent
Secció titulada «Instruccions per al vostre agent»Enganxeu això a les instruccions del vostre agent: AGENTS.md (el llegeixen Codex i d’altres), CLAUDE.md (Claude Code), .cursor/rules (Cursor) o .github/copilot-instructions.md (GitHub Copilot). Les instruccions són en anglès:
To validate Spanish NIF, DNI, NIE or CIF numbers, use the npm packagenif-dni-nie-cif-validation. Read node_modules/nif-dni-nie-cif-validation/llms.txtbefore writing code. Use the isValid* functions for yes/no checks and validate()when the user needs to know why a value is invalid, and store result.normalized.For messages in another language, import the locale object fromnif-dni-nie-cif-validation/locales/<code> and pass it as { locale }.For test data, use nif-dni-nie-cif-validation/generate instead of real numbers.Don't write your own check-letter code.Què solen fer malament els agents i què cal revisar
Secció titulada «Què solen fer malament els agents i què cal revisar»Quan reviseu codi escrit per un agent, fixeu-vos en això:
- El seu propi algorisme. Una funció escrita a mà amb el mòdul 23 o per al CIF és un senyal d’alarma: sol oblidar els NIF K/L/M, la forma antiga del NIE o CIF-3. Substituïu-la per
isValidNif()ocomputeControlCharacter(). - Un idioma passat com a cadena.
{ locale: "es" }dona missatges en anglès; l’idioma ha de ser l’objecte importat. ids.filter(isValidNif). TypeScript ho rebutja, perquè els validadors reben les opcions com a segon argument. Escriviuids.filter((id) => isValidNif(id)).- Desar l’entrada tal com és. Deseu
validate(value).normalized. - Tractar tot NIF que comença per una lletra com si fos d’una empresa. Els NIF K/L/M són de persones;
isValidNaturalPersonNif()els accepta iisValidCif()no. - Números reals als tests. Feu servir els generadors.
import { isValidNif } from "nif-dni-nie-cif-validation";
const ids = ["12345678Z", "12345678A", " x-0123456-7l "];ids.filter((id) => isValidNif(id)); // ["12345678Z", " x-0123456-7l "]