Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adr/adr-log
Generate an architectural decision record log (adr-log) out of architectural decision records (ADRs)
https://github.com/adr/adr-log
architecture-decision-records architecture-doc npm-package
Last synced: 30 days ago
JSON representation
Generate an architectural decision record log (adr-log) out of architectural decision records (ADRs)
- Host: GitHub
- URL: https://github.com/adr/adr-log
- Owner: adr
- License: mit
- Fork: true (jonschlinkert/markdown-toc)
- Created: 2017-08-24T14:04:57.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T19:49:45.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T20:33:18.511Z (about 1 month ago)
- Topics: architecture-decision-records, architecture-doc, npm-package
- Language: JavaScript
- Homepage:
- Size: 123 KB
- Stars: 81
- Watchers: 3
- Forks: 49
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - adr/adr-log - Generate an architectural decision record log (adr-log) out of architectural decision records (ADRs) (JavaScript)
- stars - adr/adr-log - Generate an architectural decision record log (adr-log) out of architectural decision records (ADRs) \[*MIT License*\] (⭐️82) (JavaScript)
- stars - adr/adr-log - Generate an architectural decision record log (adr-log) out of architectural decision records (ADRs) \[*MIT License*\] (⭐️81) (JavaScript)
README
# adr-log [](https://www.npmjs.com/package/adr-log)
> Generate an architectural decision log out of architectural decision records (ADRs).
## Table of Contents
- [Install](#install)
- [CLI](#cli)
- [Usage](#usage)
* [Examples](#examples)
+ [Printing the adr log to stdout](#printing-the-adr-log-to-stdout)
+ [Generating an index.md file containing the adr log](#generating-an-indexmd-file-containing-the-adr-log)
- [Developing](#developing)
- [Related Tooling](#related-tooling)
- [License](#license)
## Install
Install with [npm](https://www.npmjs.com/):
```sh
npm install -g adr-log
```
## CLI
```text
Usage: adr-log [-d ] [-i ] [-p ]
input: The markdown file to contain the table of contents.
If no file is specified, an index.md file containing the log is created in the current directory.
-i: Edit the file directly, injecting the log at .
Using only the -i flag, the tool will scan the current working directory for all *.md files and
inject the resulting adr-log into the default index.md file.
(Without this flag, the default is to print the log to stdout.)
-d: Scans the given for .md files.
(Without this flag, the current working directory is chosen as default.)
-e Exclude any files matching the given
-p: Path prefix for each ADR file path written in log
(Default is empty)
-b Change the character used to for bullets
Supports: asterisk, dash, plus
(Default is asterisk)
-h: Shows how to use this program
```
## Usage
### Examples
#### Printing the adr log to stdout
Consider a directory consisting of three files (`0000-example-1.md`, `0001-example-2.md`, `0002-example-3.md`).
Execute following command:
```sh
adr-log -d .
```
This outputs following log on your console:
```markdown
* [ADR-0000](0000-example-1.md) - Example 1
* [ADR-0001](0001-example-2.md) - Example 2
* [ADR-0002](0002-example-3.md) - Example 3
```
#### Generating an index.md file containing the adr log
Since this is basically a fork of [Jon Schlinkert's](https://github.com/jonschlinkert) [markdown-toc](https://github.com/jonschlinkert/markdown-toc), you can also choose to insert the log into an existing file.
For this to work the file must contain an opening `` code comment, after which the log will be inserted.
If the file already contains an adrlog surrounded by an opening `` and closing `` code comment, the existing is be replaced.
Using `-i` alone (`adr-log -i`) generates an `index.md` file in the current working directory containing the log.
```sh
$ adr-log -i
```
Result in following `index.md`:
```markdown
* [ADR-0000](0000-example-1.md) - Example 1
* [ADR-0001](0001-example-2.md) - Example 2
* [ADR-0002](0002-example-3.md) - Example 3
```
### Alternative Indexing
- search recursively underneath the given directory
- allow date prefixes as well as number prefixes
- allow specification of `index` or `date` properties in frontmatter
- fallback to auto-numbering for ADRs without filename prefixes or frontmatter
## Developing
- Run `node cli.js` to execute the CLI.
Also works with relative directgories.
E.g., `node ../../../adr-log/cli.js -d .` runs adr-log and outputs the result to the console.
- You can turn on debugging output by adjusting lines 6 and 7 in `cli.js`.
- Use [relase-it](https://www.npmjs.com/package/release-it) and [github-release-from-changelog](https://github.com/MoOx/github-release-from-changelog) for release management.
See also [ADR-0003](docs/adr/0003-use-release-it-and-github-release-from-changelog-as-release-tooling.md).
## Related Tooling
[adr-tools](https://github.com/npryce/adr-tools) is the most prominent related tool.
It supports generating an ADR log by using `adr generate toc`.
An example to can be investigated at .
The difference to adr-tools is
1. adr-log is available using `npm` and thus more easy to install.
2. adr-tools does not include the heading of each ADR into the output.
## License
Copyright © 2017 [Tino Stadelmaier](https://github.com/tstadelmaier), [Oliver Kopp](https://github.com/koppor), [Armin Hüneburg](https://github.com/hueneburg), [Tobias Wältken](https://github.com/mee4895).
Released under the [MIT License](LICENSE).