technical-debts

1.0.1 • Public • Published

Detect Self-Admitted Technical Debts in NodeJS Packeges Build Status Coverage Status Build status

Technical debt refers to incomplete or temporary workarounds that allow us to speed software development in the short term at the cost of paying a higher price later on. Recently, studies have shown that technical debt can be detected from source code comments, referred to as self-admitted technical debt.

Install

$ npm install --save technical-debts
const detectTechnicalDebts = require('technical-debts');
 
console.log(detectTechnicalDebts('./example_packages/calculator'));
//{ files:
//   { '... index.js': { debts: 0, comments: 0 },
//     '... lib/addition.js': { debts: 1, comments: 2 },
//     '... lib/division.js': { debts: 2, comments: 7 },
//     '... lib/multiplication.js': { debts: 0, comments: 1 },
//     '... lib/subtraction.js': { debts: 1, comments: 2 } },
//  comments: 12,
//  debts: 4,
//  percentage: 0.3333333333333333 }

Related Publication

License

MIT © Suhaib Mujahid

Package Sidebar

Install

npm i technical-debts

Weekly Downloads

4

Version

1.0.1

License

MIT

Last publish

Collaborators

  • suhaib
  • x21