Comment j'ai obtenu les vraies lignes de code dans mon projet.

Dans le développement de logiciels, mesurer avec précision la taille d'une base de code est essentiel pour la gestion de projet, l'allocation des ressources et le suivi des progrès. Cependant, les outils traditionnels incluent souvent des fichiers de données générés automatiquement, tels que package-lock.json, Yarn.lock et data.json, etc. dans leur nombre de lignes. Cela conduit à des métriques gonflées car techniquement, vous n'avez pas ajouté les lignes de code vous-même. Pour relever ce défi, j'ai développé git-repo-lines-of-code, un projet open source conçu pour fournir un nombre de lignes précis en excluant les fichiers spécifiés.

La motivation derrière les lignes de code git-repo

Bien que des outils comme cloc soient populaires pour compter les lignes de code, ils n'offrent pas de mécanismes simples pour exclure des fichiers ou des modèles spécifiques, en particulier lorsqu'il s'agit de fichiers générés automatiquement qui peuvent fausser l'analyse. Cette limitation a conduit à la création d'un outil qui permet aux développeurs et aux gestionnaires de :

• Exclure les fichiers indésirables : omettez les fichiers qui ne contribuent pas à la base de code réelle, garantissant ainsi des métriques plus précises.
• Automatisez le processus de comptage : éliminez le besoin d'ajustements manuels, réduisez les erreurs et gagnez du temps.
• Améliorer la réutilisabilité : fournissez une solution qui s'intègre facilement à divers projets et flux de travail.

Comment utiliser git-repo-lines-of-code

Pour démarrer avec git-repo-lines-of-code, suivez ces étapes :

1. Installation : installez le package globalement à l'aide de npm :

npm install -g git-repo-lines-of-code

1. Utilisation de base :

import getRepoLinesOfCode from 'git-repo-lines-of-code';

const owner = 'octocat';
const repo = 'Hello-World';
const excludeFilePaths = ['path-to-file.ts', 'path-to-auto-generated-code.json'];

getRepoLinesOfCode(owner, repo, excludeFilePaths)
    .then((linesOfCode) => {
        console.log(`Total lines of code: ${linesOfCode}`);
    })
    .catch((error) => {
        console.error(`Error: ${error}`);
    });

L'exécution de cette fonction exécutera le nombre de lignes avec les exclusions spécifiées.

Conclusion

git-repo-lines-of-code offre une approche simplifiée pour mesurer avec précision votre base de code en excluant les fichiers non essentiels. Sa flexibilité et sa facilité d'utilisation en font un outil précieux pour les développeurs et les gestionnaires recherchant des métriques de code précises.

Le package est open source et les contributions sont les bienvenues. Vous pouvez accéder au package npm ici et au référentiel GitHub ici.

N'hésitez pas à l'explorer, à contribuer et à l'intégrer dans vos projets pour maintenir des métriques de code précises.

Bon codage !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!