Número de ficheros
| Sigla | FILES |
| Aspecto | «Tamaño» |
| Se mide en | módulo, proyecto, tipo de fichero |
| Tipo de valor | recuento (entero, mínimo 0) |
| Dirección | informativa: ni alto ni bajo es mejor |
| Stau Metro | NumFilesModule, NumFilesProject, NumFilesFileType |
En pocas palabras
Cuenta los ficheros de un módulo, de todo el proyecto o de cada tipo de fichero (Java, XML, texto…). Es la forma más simple de decir lo grande que es un proyecto, y el total con el que se comparan los recuentos por tecnología.
Qué mide
El tamaño en número de ficheros, sin mirar lo que hay dentro. Un fichero de tres líneas y uno de tres mil cuentan igual. Por eso sirve como punto de partida y rara vez como conclusión: dos proyectos con los mismos ficheros pueden tener tamaños muy distintos en «líneas de código».
Lo útil es la composición. Repartido por tipo de fichero, el recuento dice qué parte del proyecto es código, qué parte configuración y qué parte documentación o recursos.
Cómo se calcula
Se suma 1 por cada fichero del ámbito analizado. Con el conjunto de ficheros del ámbito:
En el nivel de tipo de fichero, el ámbito se parte por tipo y se cuenta cada parte por separado; la suma de todas las filas da el total del proyecto.
Cómo interpretarla
No tiene un valor bueno ni malo, y por eso no tiene umbrales. Se usa de tres maneras:
- Entre módulos. Señala los más grandes y los más pequeños por número de ficheros.
- Por tipo de fichero. Muestra con qué se construye el proyecto. Un reparto con mucho texto plano o muchos ficheros de propiedades dice algo distinto de uno casi todo Java.
- En el tiempo. Un salto brusco suele ser un cambio de estructura (una migración, ficheros generados que se han añadido) y no un crecimiento real.
Ojo. Comparar proyectos por número de ficheros solo tiene sentido si se organizan de forma parecida. Un proyecto que agrupa muchas clases pequeñas en cada fichero y otro que usa un fichero por clase no son comparables.
Relación con otras métricas
- «Número de ficheros Java» (
J), «Kotlin» (KT), «HTML» (HTML) y «XML» (XML): partes del total, por tecnología. - «Líneas de código» (
LOC): el mismo ámbito medido en líneas; el cociente da el tamaño medio de un fichero. - «Número de módulos» (
MOD) y «número de paquetes» (P): otras formas de contar la estructura del proyecto.
En las herramientas
Stau Metro (NumFilesModule, NumFilesProject, NumFilesFileType). Cuenta los ficheros que visita el análisis.
Entra cualquier fichero que el IDE no tenga por binario (Java, Kotlin, XML, HTML, propiedades, YAML, texto plano…),
esté o no en una raíz de fuentes, siempre que pertenezca al contenido de un módulo y no esté excluido; un .yml
bajo una raíz de recursos, por ejemplo, cuenta. No entran:
- los ficheros binarios y las clases compiladas;
- los ficheros excluidos del proyecto y los que quedan fuera del contenido de los módulos;
- los ficheros Java situados bajo una raíz de recursos, que el análisis no recorre en absoluto, igual que las inspecciones del propio IDE.
Los ficheros fuera del ámbito elegido al lanzar el análisis tampoco cuentan; los de test entran si el ámbito los incluye. Los niveles de módulo y de proyecto cuentan los mismos ficheros; el de tipo de fichero solo tiene una fila por cada tipo que aparece, así que no hay filas con valor 0.
SonarQube define la métrica files como «el número de ficheros» y no precisa más en su documentación.
Referencias
- SonarQube, definición de métricas: https://docs.sonarsource.com/sonarqube-server/latest/user-guide/code-metrics/metrics-definition/