• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

I do not know how to use the command syntax from the CLI.

For instance, when I use this syntax :

adr -n "Title"

It works. But when I use that one :

adr new "Title"

I get no result at all, no error, no file created. I use Ubuntu 20.

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

It seems to me that the commander options, for instance this one :

.option('-n, new <title...>', 'create new ADR', create)

should be replaced with that :

.option('-n', 'create new ADR', create)
.command('new <title>')
  .description('create new ADR')
  .action(create)

I must be wrong because people may have already noticed it, but I don't know then, which is the good syntax.

• I'm submitting a ...
  [ X] feature request

• Summary
  The autogenerated TOC has no trailing newline.

This is problematic if you run a markdown linter that lints according to the commonmark spec. Since we autogenerate (adr -u) the TOC and we do linting in a continuous integration context this always fails.

A flag for adr -u to add a newline after generation would be useful.

README.md:3 MD047/single-trailing-newline Files should end with a single newline character

As a workaround I changed line 47 to following:

fs.writeFileSync(savePath + 'README.md', toc + "\n");

This is not very elegant and maybe not be platform independent.

As reference I filed an issue in the wrong repo first see

• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  Custom template.md is included in the html export

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  I have just one DR.

I execute yarn adr list 2

I get an error Error: ENOENT: no such file or directory, open 'docs/adr/undefined'

Add author field in decision record.

In template:

## Author
[author-name](mailto:[email protected])

author command

adr author name

Search adr by author.

• I'm submitting a ...
  [ ] language request
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

  • use case:
    • I have a CI set up on GitHub that ensures an adr update is run against the ADR directories in my repository
      • Specifically, when I push a branch, CI executes adr update command on ADR directories
        • CI fails if there is any difference
    • The problem is when I commit an ADRs with NFD-typed characters in their titles
      • Currently, the file name generated by adr update also contains NFD characters
      • However, if I push this branch to GitHub, "only" the filenames are implicitly converted to NFC type, so adr update on CI continues to generate NFC -> NFD filename diffs
    • I want to force nam of generated files normalized in NFC format

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

  • I implemented this feature on my branch: https://github.com/Rindrics/adr/tree/fix-error-with-nfd-characters

• I'm submitting a ...
  [x] language request
  [ ] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  Please remove HTML comments in Cantonese: When exported to HTML, the language is not being picked up.

• I'm submitting a ...
  [ ] language request
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

Show detail information in terminal

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

• npm i adr -g

• adr

Expected

• $adr -> shows info

Actual

• $ adr -> command not found: adr

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)
  Perhaps, this is because "build" folder is missing in version 1.4.2: https://registry.npmjs.org/adr/-/adr-1.4.2.tgz
  V 1.4.1. works as expected: https://registry.npmjs.org/adr/-/adr-1.4.1.tgz

• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

I encountered the error below when I executed yarn test on 7da4097:

❯ yarn test
yarn run v1.22.19
$ yarn lint && yarn unit && nyc report --reporter=lcov && yarn check-coverage
$ tslint --project . src/**/*.ts
/Users/akirahayashi/dev/adr/src/lib/cache.ts:47:12
ERROR: 47:12  strict-type-predicates  Expression is always true.

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

I avoided the error on my branch: https://github.com/Rindrics/adr/tree/avoid-strict-type-predicates-error

Maybe we can use a command to update adr status and not manually.

I have a simple realization about it.

Incidentally, can i add i18n of command description?

adr export csv and adr export json error!

csv:

adr export CSV
{ Error: ENOENT: no such file or directory, open 'undefined0001-test.md'
    at Object.fs.openSync (fs.js:663:18)
    at Object.fs.readFileSync (fs.js:568:33)
    at getAllStatus (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/StatusHelper.js:37:23)
    at Object.getLatestStatus (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/StatusHelper.js:56:21)
    at buildFunc (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/output/CSVBuilder.js:13:49)
    at /home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/base/GenerateBuilder.js:23:17
    at Array.forEach (<anonymous>)
    at GenerateBuilder.setBody (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/base/GenerateBuilder.js:15:20)
    at CSVBuilder.buildContent (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/output/CSVBuilder.js:25:14)
    at output (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/output.js:26:26)
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: 'undefined0001-test.md' }

json:

adr -o json
{ Error: ENOENT: no such file or directory, open 'undefined0001-test.md'
    at Object.fs.openSync (fs.js:663:18)
    at Object.fs.readFileSync (fs.js:568:33)
    at getAllStatus (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/StatusHelper.js:37:23)
    at Object.getLatestStatus (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/StatusHelper.js:56:21)
    at buildFunc (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/output/JSONBuilder.js:12:49)
    at /home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/base/GenerateBuilder.js:23:17
    at Array.forEach (<anonymous>)
    at JsonGenerateBuilder.setBody (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/base/GenerateBuilder.js:15:20)
    at JSONBuilder.buildContent (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/output/JSONBuilder.js:25:14)
    at output (/home/shitake/.nvm/versions/node/v9.3.0/lib/node_modules/adr/build/main/lib/output.js:26:26)
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: 'undefined0001-test.md' 

• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

I just get start with this tool.

I was sending this command on the CLI (I already init the folder - it worked):

adr new "no need for monorepo"

This is the error message:

/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/build/main/lib/create.js:35
    console.log(i18n.logSavePath + savePath);
                     ^

TypeError: Cannot read properties of undefined (reading 'logSavePath')
    at create (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/build/main/lib/create.js:35:22)
    at /Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/build/main/cli.js:23:29
    at Array.forEach (<anonymous>)
    at Command.<anonymous> (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/build/main/cli.js:23:12)
    at Command.listener [as _actionHandler] (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/node_modules/commander/index.js:413:31)
    at Command._parseCommand (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/node_modules/commander/index.js:914:14)
    at Command._dispatchSubcommand (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/node_modules/commander/index.js:865:18)
    at Command._parseCommand (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/node_modules/commander/index.js:882:12)
    at Command.parse (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/node_modules/commander/index.js:717:10)
    at Object.<anonymous> (/Users/anton/.nvm/versions/node/v16.14.1/lib/node_modules/adr/build/main/cli.js:78:9)

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

Any idea? Am I doing it wrong?

• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  Currently adr list prints a list of files before printing the ADR table list:

$ adr list
docs/adr/0001-implementation-of-decision-records.md
docs/adr/0002-implementing-nx-framework.md
╔══════════════════════════════════════╤════════════════════╤═════════════════════╗
║ Decision                             │ Last Modified Date │ Last Status         ║
╟──────────────────────────────────────┼────────────────────┼─────────────────────╢
║ 1.Implementation of Decision Records │ 2022-11-26         │ 2022-11-26 accepted ║
╟──────────────────────────────────────┼────────────────────┼─────────────────────╢
║ 2.implementing NX Framework          │ 2022-11-26         │ 2022-11-26 proposed ║
╚══════════════════════════════════════╧════════════════════╧═════════════════════╝

that list of files should be removed.

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

• I'm submitting a ...
  [ ] language request
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [x] question about how to use this project

• Summary

As README.md mentioned, there is no other informations to explain how to do next after using adr new command. It's confused and console prints the save directory path. So I think it's important to add more informations what to do next.

I found adr-tools using the environment variable to open new file with which editor, so it would be better to use some package(such as open-in-editor) to implement this feature and adding the editor configuration.

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

1. open-in-editor
2. launch-editor

• I'm submitting a ...
  [ ] language request
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  yarn adr help export says: 'export ADR reporter in HTML, CSV, JSON, Markdown'

but

yarn adr export Markdown fails

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

• I'm submitting a ...

• language request
• bug report
• feature request
• question about the decisions made in the repository
• question about how to use this project

• Summary

It would be really handy if the tool was also supporting writing ADR using Asciidoc.
Asciidoc is quite popular too, and has interesting 3rd party tooling for aggregating documentation or publishing documentation to Confluence for example.

So it would be nice if the adr tool would let you chose between Markdown and Asciidoc, while keeping Markdown as default.

• I'm submitting a ...
  [ ] language request
  [ x ] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  GHSA-wx77-rp39-c6vg

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)
  Please switch from unmaintained markdown package to something else. I'm not feeling in a good position to propose any alternatives.

• I'm submitting a ...
  [X] feature request

• Summary
  What do you think about adding support for asset-compression (images specifically)?

The total asset size for ADR can get out of hand over time.

We added a basic image compression system to our repo for ADRs using the sharp library with caching in mind. I can work on adding it to this library as well.

• I'm submitting a ...
  [ ] language request
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

Detect if a template.md file exists in savePath (specified in config) and use it before using default templates.

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)