backpat

Backpat

Backpat is a simple tool for use in automating the production of tech stack notes in projects. Think along the lines of About pages with links for crediting community contributions to your codebase. (Looking at you, student developers.)

Install it as such:

$ npm install --save backpat

As of v0.4.0: Require it like so:

const backpat = require('backpat').backpat;

Invoke it thusly:

backpat(callback);

And it will parse your project's package.json, identifying all production and developer dependencies and fetching the particulars of each. What you'll get back is an object like this, if considerably more robust.

{ eslint:
   { version: '3.8.1',
     name: 'eslint',
     url: 'https://github.com/eslint/eslint.git',
     description: 'An AST-based pattern checker for JavaScript.',
     downloads: 4038383 },
  mocha:
   { version: '3.1.2',
     name: 'mocha',
     url: 'https://github.com/mochajs/mocha.git',
     description: 'simple, flexible, fun test framework',
     downloads: 4001598 }}

Simple as that. The npm download count attribute makes filtering the results a snap.

Worth noting: the whole shebang is async – so don't worry if you've got kitchen- sink-grade dependencies.

This is a nascent module that is bound to require some TLC. If you encounter any rough edges, please don't hesitate to drop me a line. Oh, and feel free to submit at PR. There's still much to be done.

Changelog

0.5.1 - 2016-12-15

Added

• More robust docs, including contribution and issue reporting guidelines

Changed

• Improved testing suite
• Improve workflow automation and quality checks
• Renamed test files to exclude them from coverage calculations