Package Health Score

67 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.5.2	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.6	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.7.1	\|	12/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.6.1	\|	12/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.6	\|	11/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (4,944)

GitHub Stars: 263
Forks: 51
Contributors: -

Direct Usage Popularity

The npm package adr receives a total of 4,944 downloads a week. As such, we scored adr popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package adr, we found that it has been starred 263 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like adr is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 6
Open PR: 1
Last Release: 4 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of adr based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that adr demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=10.0

Age: 8 years
Dependencies: 17 Direct
Versions: 65
Install Size: 873 kB
Dist-tags: 1
# of Files: 194
Maintainers: 1
TS Typings: Yes

adr has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

ADR - Architecture Decision Records（轻量级架构决策记录工具）

> ADR - Architecture Decision Records（轻量级架构决策记录工具）

Inspired by https://github.com/npryce/adr-tools, but supported Windows.

ADR Blogpost: Documenting Architecture Decisions

A good material about Architecture decision record

中文翻译：架构决策记录

功能特性

支持 Windows, GNU/Linux, Mac OS
Markdown 目录生成
为项目经理、业务人员等非开发人员，生成报表：HTML，CSV, JSON
兼容 adr-tools
国际化支持：English、中文、Brazilian Portuguese (pt-br), Standard Italian (it-IT)
状态历史
状态查询
更好的列表展示
兼容 adr-tools

查看本项目的架构决策记录

Features

Supported Windows, GNU/Linux, Mac OS
report for PM, BA: html, csv, json
Support Markdown and Asciidoc
generate markdown and asciidoc toc（see in docs/adr ）
i18n: English (en), 中文(zh-cn), Brazilian Portuguese (pt-br), Standard Italian (it-IT), Farsi (fa), French (fr)
status logs
status query
better list view
compatible adr-tools
custom templates: add a template.md (or template.adoc, template.asciidoc) file in the save path

HTML Reporter Example

Screenshots

ADR List

List Examples

ADR Reporter

Reporter Examples

Install

install

npm install -g adr

init

adr init

e.x: adr init en

new

adr new

e.x: adr new "create project". It will open the new file with your config editor

list

adr list

result:

╔══════════════════════════════════════╤══════════════╤═══════════════════╗
║ Decision                             │ Last Modified│ Last Status       ║
╟──────────────────────────────────────┼──────────────┼───────────────────╢
║ 1.编写完整的单元测试                    │ 2017-11-26   │ 2017-11-26 已完成  ║
╟──────────────────────────────────────┼──────────────┼───────────────────╢
║ 2.添加目录生成                         │ 2017-11-26   │ 2017-11-25 已完成  ║
╟──────────────────────────────────────┼──────────────┼───────────────────╢
║ 3.图形生成功能                         │ 2017-11-26   │ 2017-11-24 已完成  ║
╟──────────────────────────────────────┼──────────────┼───────────────────╢
║ 4.生成在线图形                         │ 2017-11-26   │ 2017-11-22 提议    ║
╚══════════════════════════════════════╧══════════════╧═══════════════════╝

generate toc

adr generate toc

results:

# Architecture Decision Records

* [1. 编写完整的单元测试](001-编写完整的单元测试.md)
* [2. 添加目录生成](002-添加目录生成.md)
* [3. 图形生成](003-图形生成.md)

generate graph

adr generate graph

results:

digraph {
  node [shape=plaintext];
  _1 [label="1.编写完整的单元测试"; URL="001-编写完整的单元测试.md"]
  _2 [label="2.添加目录生成"; URL="002-添加目录生成.md"]
  _1 -&gt; _2 [style="dotted"];
  _3 [label="3.图形生成"; URL="003-图形生成.md"]
  _2 -&gt; _3 [style="dotted"];
}

update filename by title

adr update

decisions change logs

adr logs

e.x. adr logs 9

╔════════════╤══════╗
║  -         │  -   ║
╟────────────┼──────╢
║ 2017-11-23 │ 提议 ║
╟────────────┼──────╢
║ 2017-11-24 │ 通过 ║
╚════════════╧══════╝

export adr

support: json, csv, html, markdown

adr export

e.x. adr export csv

Index, 决策, 上次修改时间, 最后状态
1, 编写完整的单元测试, 2017-11-26, 2017-11-26 已完成
2, 添加目录生成, 2017-11-26, 2017-11-25 已完成
3, 图形生成功能, 2017-11-26, 2017-11-24 已完成

search adr

adr search

e.x. adr search 测试

╔══════════════════════╤══════════════════╗
║ 决策                 │ 最后状态         ║
╟──────────────────────┼──────────────────╢
║ 19.添加-e2e-测试     │ 2017-11-28 提议  ║
╟──────────────────────┼──────────────────╢
║ 1.编写完整的单元测试 │ 2017-11-26 完成  ║
╚══════════════════════╧══════════════════╝

Config

current:

language, language
path, save path
digits, the index length, e.x. digits:3 001-index.md
prefix, the prefix of files, e.x. adr-0001
editor, the editor to open file, e.x. code, more information, and you can also use the editor by setting the program path, such as /System/Applications/TextEdit.app/Contents/MacOS/TextEdit
force_nfc, whether to normalize the names of files generated by adr commands in NFC (Normalization Form Canonical Composition) format, e.x. true
extension, the document extension/format you want to used. md for Markdown (default value) oradoc for asciidoc

example config:

{
  "path":"doc/adr/",
  "language":"zh-cn",
  "prefix": "",
  "digits": 4,
  "editor": "code",
  "force_nfc": true,
  "extension": "md"
}

License

@ 2017~2021 A Phodal Huang's Idea. This code is distributed under the MIT license. See LICENSE in this directory.

adr dependencies

@asciidoctor/core colors commander find-in-files inquirer lru-cache markdown markdown-toc mkdirp moment open-in-editor remarkable sharp table tslib walk walk-sync

FAQs

What is adr?

轻量级架构记录工具 - Command-line tools for working with Architecture Decision Records. Visit Snyk Advisor to see a full health score report for adr, including popularity, security, maintenance & community analysis.

Is adr popular?

The npm package adr receives a total of 4,944 weekly downloads. As such, adr popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is adr well maintained?

We found indications that adr maintenance is sustainable demonstrating some project activity. We saw a total of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is adr safe to use?

The npm package adr was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 23 December-2024, at 09:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4,944)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

ADR - Architecture Decision Records（轻量级架构决策记录工具）

HTML Reporter Example

Screenshots

ADR List

ADR Reporter

Install

new

list

generate toc

generate graph

update filename by title

decisions change logs

export adr

search adr

Config

License

adr dependencies

adr development dependencies

FAQs

What is adr?

Is adr popular?

Is adr well maintained?

Is adr safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues