- ¿Qué es cloc?
- ¿Cómo se instala una herramienta como cloc?
- ¿Dónde se instalan los paquetes globales?
- ¿Cómo se usa cloc?
- Usos prácticos
Cuando pensamos en Node.js, muchas veces lo asociamos solamente con código JavaScript. Pero en realidad, hay paquetes que son verdaderas utilidades o herramientas que podemos usar directamente desde la terminal, sin necesidad de escribir una sola línea de JavaScript. Una de esas herramientas es cloc. Vamos a ver juntos cómo instalarla y usarla fácilmente.
¿Qué es cloc?
cloc es una herramienta que sirve para contar líneas de código en diferentes lenguajes de programación.
Es muy útil cuando queremos saber cuánto código tenemos en un proyecto, o cómo está distribuido entre archivos de distintos tipos (por ejemplo, archivos .js, .html, .md, .css, etc.).
¿Cómo se instala una herramienta como cloc?
Algunas herramientas como cloc no necesitan que tengas un proyecto Node específico. Puedes instalarlas globalmente para poder usarlas desde cualquier parte de tu sistema, sin importar en qué carpeta estés.
Instalación global con npm
Para instalar cloc a nivel global, usamos el siguiente comando en la terminal:
npm install -g cloc
La bandera -g significa que queremos instalar el paquete de forma global, es decir, que estará disponible en todo el sistema, no solo en un proyecto.
En ese caso, anteponemos sudo al comando:
sudo npm install -g cloc
¿Dónde se instalan los paquetes globales?
Cuando instalamos un paquete con -g, npm lo guarda en una carpeta especial que no siempre es fácil de encontrar a simple vista. Si quieres ver exactamente dónde están instalados tus paquetes globales, puedes usar el siguiente comando:
npm config ls -l
Este comando muestra toda la configuración de npm. Fíjate en una línea como esta:
prefix = "/Users/tu_usuario/.asdf/installs/nodejs/14.5.0/.npm"
Ese es el directorio donde npm guarda los paquetes que se instalan de forma global.
¿Cómo se usa cloc?
Una vez instalado, puedes ejecutar cloc desde cualquier carpeta. Lo más básico es analizar todas las líneas de código del directorio actual (el punto . representa la carpeta en la que estás):
cloc .
Ejemplo de salida
Supongamos que ejecutamos ese comando dentro de una carpeta de proyecto. El resultado podría verse así:
49 text files.
41 unique files.
11 files ignored.
Language files blank comment code
-------------------------------------------------------------------------------
Markdown 19 213 0 523
YAML 21 35 0 471
CSS 1 0 0 3
-------------------------------------------------------------------------------
SUM: 41 248 0 997
-------------------------------------------------------------------------------
¿Cómo interpretamos estos datos?
| Clave | Descripción |
|---|---|
Language |
Tipo de archivo (por su lenguaje o extensión). |
files |
Número de archivos de ese tipo. |
blank |
Líneas en blanco. |
comment |
Líneas que son solo comentarios. |
code |
Líneas de código "reales", sin contar espacios ni comentarios. |
Entonces, en el ejemplo:
Hay 523 líneas de contenido en archivos Markdown (
.md).471 líneas vienen de archivos YAML (usados comúnmente en configuraciones).
Y también vemos un archivo CSS con 3 líneas de código.
Usos prácticos
Si trabajas con varios lenguajes, te ayuda a ver cuál ocupa más espacio en tu proyecto.
Puedes usar
clocen proyectos personales o profesionales para hacer reportes de avance.Te permite identificar fácilmente archivos innecesarios o con poco contenido.
Resumen
- Algunos paquetes de Node.js, como
cloc, son herramientas de línea de comandos, no solo bibliotecas de código. - Puedes instalarlos globalmente con:
npm install -g <paquete>, en este caso:npm install -g cloc - Si tu sistema lo requiere, usa
sudoal instalar. - Para saber dónde se instalan los paquetes globales, ejecuta:
npm config ls -l - Una vez instalado, puedes usar
clocdesde cualquier carpeta para contar líneas de código usando:cloc .
Trabajo independiente
📊 Analiza tu proyecto con cloc
cloc (Count Lines of Code) es una herramienta que te dice cuántas líneas de código tiene tu proyecto, separadas por lenguaje.
1️⃣ Instala cloc globalmente (esto significa que estará disponible en cualquier carpeta de tu sistema):
npm install -g cloc
2️⃣ Abre tu terminal y ve a la carpeta del proyecto que quieres analizar. Por ejemplo, si estás en nodejs-package:
cd nodejs-package cloc .
Verás una tabla como esta:
------------------------------------------------------------------------------- Language files blank comment code ------------------------------------------------------------------------------- JavaScript 4 32 10 88 JSON 1 1 0 5 -------------------------------------------------------------------------------
💡 Esto te permite tener una idea del tamaño del proyecto y en qué lenguajes está escrito.
Para acceder completo a curso necesitas un plan básico
El plan básico te dará acceso completo a todos los cursos, ejercicios y lecciones de Códica, proyectos y acceso de por vida a la teoría de las lecciones completadas. La suscripción se puede cancelar en cualquier momento.