Bagaimana saya memperoleh baris kod sebenar dalam projek saya.

Dalam pembangunan perisian, mengukur saiz pangkalan kod dengan tepat adalah penting untuk pengurusan projek, peruntukan sumber dan penjejakan kemajuan. Walau bagaimanapun, alatan tradisional selalunya termasuk fail yang dijana secara automatik dan data, seperti package-lock.json, yarn.lock dan data.json, dsb. dalam kiraan barisnya. Ini membawa kepada metrik yang meningkat kerana secara teknikal, anda tidak menambah baris kod sendiri. Untuk menangani cabaran ini, saya membangunkan git-repo-lines-of-code, projek sumber terbuka yang direka untuk menyediakan kiraan baris yang tepat dengan mengecualikan fail yang ditentukan.

Motivasi Di Sebalik git-repo-lines-of-code

Walaupun alat seperti cloc popular untuk mengira baris kod, alat tersebut tidak menawarkan mekanisme mudah untuk mengecualikan fail atau corak tertentu, terutamanya apabila berurusan dengan fail yang dijana secara automatik yang boleh memesongkan analisis. Had ini mendorong penciptaan alat yang membolehkan pembangun dan pengurus untuk:

• Kecualikan Fail Tidak Diingini: Tinggalkan fail yang tidak menyumbang kepada pangkalan kod sebenar, memastikan metrik yang lebih tepat.
• Automasikan Proses Pengiraan: Hilangkan keperluan untuk pelarasan manual, mengurangkan ralat dan menjimatkan masa.
• Tingkatkan Kebolehgunaan Semula: Menyediakan penyelesaian yang mudah disepadukan ke dalam pelbagai projek dan aliran kerja.

Cara Menggunakan git-repo-lines-of-code

Untuk bermula dengan git-repo-lines-of-code, ikut langkah ini:

1. Pemasangan: Pasang pakej secara global menggunakan npm:

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

1. Penggunaan Asas:

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}`);
    });

Menjalankan fungsi ini akan melaksanakan kiraan baris dengan pengecualian yang ditentukan.

Kesimpulan

git-repo-lines-of-code menawarkan pendekatan yang diperkemas untuk mengukur pangkalan kod anda dengan tepat dengan mengecualikan fail yang tidak penting. Fleksibiliti dan kemudahan penggunaannya menjadikannya alat yang berharga untuk pembangun dan pengurus yang mencari metrik kod yang tepat.

Pakej ini adalah sumber terbuka dan sumbangan dialu-alukan. Anda boleh mengakses pakej npm di sini dan repositori GitHub di sini.

Sila, jangan ragu untuk meneroka, menyumbang dan menyepadukannya ke dalam projek anda untuk mengekalkan metrik kod yang tepat.

Selamat pengekodan!

Atas ialah kandungan terperinci Bagaimana saya memperoleh baris kod sebenar dalam projek saya.. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!