Package Wiki

Track, group and annotate package.json content in a human-friendly format

Overview

When beginning work on a larger repository, it can be hard to know where to start. Viewing the project's package.json is one way, but package names and versions only supply so much information.

Package Wiki generates an initial package-wiki.md file at the project root, listing:

• Sections:

  • Dependencies
  • Dev dependencies
  • Peer dependencies
  • Scripts

• Groups:

  • An initial "General" group

• Packages:

  • Title
  • Description
  • Home page or repo link

• Scripts:

  • Key
  • An empty description

This initial dump of information should then be ordered, updated, and amended as required, then kept up to date so new users can quickly understand the project.

Installation

Install with NPM (or Yarn):

npm i -D package-wiki

Usage

Generate the initial package-wiki.md:

package-wiki

This will generate a new file to the project root – which should be committed to version control.

Flags:

• --force - force overwrite of an existing file
• --json - output as JSON to package-wiki.json