@kingdom_soldier/repo-analyzer
v1.0.1
Published
Analiza un repositorio respetando .gitignore y exporta su estructura y contenido como JSON, ideal para dar contexto a una IA.
Maintainers
Readme
@kingdom_soldier/repo-analyzer
Analiza un repositorio respetando .gitignore y exporta su estructura y
contenido como JSON. Ideal para dar contexto a una IA sobre un proyecto.
Instalacion
npm install -g @kingdom_soldier/repo-analyzer
npx @kingdom_soldier/repo-analyzerUso como CLI
Una vez instalado globalmente, el comando es repo-analyzer:
repo-analyzer
repo-analyzer ./mi-proyecto
repo-analyzer ./mi-proyecto -o ./estructura.json
repo-analyzer -i "*.md,*.test.js,dist/"
repo-analyzer -s 500Con npx sin instalar:
npx @kingdom_soldier/repo-analyzer ./mi-proyectoOpciones
| Opcion | Descripcion |
| --- | --- |
| -o, --output <file> | Fichero JSON de salida |
| -i, --ignore <lista> | Patrones extra separados por coma |
| -s, --max-size <kb> | Tamano maximo por fichero (0 = sin limite) |
| -q, --quiet | No imprimir resumen |
| -h, --help | Ayuda |
| -v, --version | Version |
Uso como libreria
const { analyzeRepo } = require('@kingdom_soldier/repo-analyzer');
const result = await analyzeRepo({
root: './mi-proyecto',
output: './estructura.json',
ignore: ['*.test.js'],
maxSize: 500 * 1024,
});
console.log(result.fileCount);
console.log(result.structure);
console.log(result.content);Formato de salida
{
"structure": "mi-proyecto/\n|-- src/\n| `-- index.js\n|-- public/\n| `-- logo.png\n`-- package.json",
"content": [
{ "path": "src/index.js", "content": "console.log('hola');\n" },
{ "path": "package.json", "content": "{ \"name\": \"mi-proyecto\" }\n" }
]
}structure: string con el arbol visual completo del proyecto, incluyendo imagenes y binarios (siempre que no esten en.gitignore).content: array de{ path, content }con el contenido de los ficheros de texto. Los binarios no aparecen aqui.- Se respeta el
.gitignorede la raiz. - Se ignoran por defecto:
.git/,node_modules/,.DS_Store,Thumbs.db.
Licencia
MIT
