npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

madr-tools

v1.2.2

Published

Node.js CLI to to create and manage Markdown Architectural Decision Records (MADR)

Downloads

1,711

Readme

madr-tools

Node.js CLI tools to help you create and manage Markdown Architectural Decision Records (MADR).
The famous ADR Tools have been taken as a role model for this Node.js port.

Installation

Within specific project (recommended):

npm i -D madr-tools

Globally:

npm i -g madr-tools

Usage

Run npx madr --help to get an overview and description for all available commands. Each command provides another, more detailed help. E.g. npx madr init --help.

Initialization

Run the following command within the root directory of your repository to initialize the MADR directory and config file.

npx madr init [optional path] [-i readme.md]

By default, the MADR directory will be created under docs/decisions. You can specify a custom directory by providing the relative path as the first positional argument.
Furthermore, the overview over all MADRs is written to a file called index.md by default as the official MADR Documentation suggests. However, when watching the directory within a web-based Git repo (e.g. GitHub or GitLab), it will automatically render the readme.md file within the directory. Therefore, it's possible to use readme.md instead of index.md as the file name by setting the -i readme.md option.

Creating a new MADR

Run the following command to create a new MADR-File.

npx madr new <title>

e.g.

npx madr new "A very important decision"

It will create a new MADR file within the configured directory based on the template.md file. Furthermore, it updates the MADR log.

Updating the MADR Log

When you change the filename or title of a MADR, it is possible to trigger an update of the log manually by running

npx madr index

Contribution

Every contribution to this project is more than welcome. Just follow these rules:

  • The repo uses Conventional Commits to create semantic versions
  • The codebase should automatically be reformatted using Prettier in a pre-commit hook. Therefore, it should be pretty hard to commit something which is not well formatted... 😅
  • Create a PR once you have finished your feature

Local development

  • Clone the repo
  • Install the dependencies npm i
  • Run the build npm run build
  • Locally link the bin script npm link
  • Afterwards, you should be able to run madr --help in your favorite console