fix adr/adr-log#28

[Fetz]

Changelog

• fix issue: link of ADR log/toc generated will be wrong if input path and directory of the logs are different #28
• added slash that should convert windows paths to web/unix paths
• did some code cleanup:
  • reuse already require module instead of requiring it again
  • delete non used variable
  • convert usage of var to const:
    1. change
  • convert usage of var to let:
    1. change
    2. change
    3. change

[koppor]

Thank you so much for taking quick action! I'll try to release a new version soon!

Another idea for improvement is that the tool works without toc markings. It can deduct from the structure where the old TOC resides (begins with an item linking to an ADR and ends with a link-to-ADR item followed by a newine)

[chrisgilmerproj]

I think that this broke something for me. My new links now show up as like:

[ADR-0014](../adr0014-aws-roles-and-privileges.md) - AWS Roles and Privileges

I am expecting a slash between adr and 0014. It only appeared for me recently so I may have to pin to 2.1.1. Would you like me to open an issue on this?

[Fetz]

Hey @chrisgilmerproj sorry about that. I will try to fix it today. Can you share the expected markup and if is on Windows or Unix (Marcos, Linux...)

[koppor]

I think, the expected markup is:

[ADR-0014](0014-aws-roles-and-privileges.md) - AWS Roles and Privileges

@chrisgilmerproj told about a slash, which would lead to

[ADR-0014](../adr/0014-aws-roles-and-privileges.md) - AWS Roles and Privileges

I think, this is not the desired result (why go one directory up?)

[Fetz]

running my version of the code (on a mac) with both examples in docs:

1. input and adr in the same folder:

./cli.js docs/adr/index.md -d docs/adr/

# <!-- adrlog -- Regenerate the content by using "adr-log -i". You can install it via "npm install -g adr-log" -->
# 
# - [ADR-0000](0000-use-markdown-architectural-decision-records.md) - Use Markdown Architectural Decision Records
# - [ADR-0001](0001-extend-markdown-toc.md) - Extend markdown-toc
# - [ADR-0002](0002-use-console-stamp-as-logging-framework.md) - Use console-stamp as logging framework
# - [ADR-0003](0003-use-release-it-and-github-release-from-changelog-as-release-tooling.md) # - Use release-it and github-release-from-changelog for releasing
# - [ADR-0004](0004-filename-as-direct-parameter.md) - Filename as direct parameter
# 
# <!-- adrlogstop -->

2. input is on a level up compared to the adrs

 ./cli.js docs/index.md -d docs/adr/
# <!-- adrlog -- Regenerate the content by using "adr-log -i". You can install it via "npm install -g adr-log" -->
# 
# - [ADR-0000](adr/0000-use-markdown-architectural-decision-records.md) - Use Markdown Architectural Decision Records
# - [ADR-0001](adr/0001-extend-markdown-toc.md) - Extend markdown-toc
# - [ADR-0002](adr/0002-use-console-stamp-as-logging-framework.md) - Use console-stamp as logging framework
# - [ADR-0003](adr/0003-use-release-it-and-github-release-from-changelog-as-release-tooling.md) - Use release-it and github-release-from-changelog for releasing
# - [ADR-0004](adr/0004-filename-as-direct-parameter.md) - Filename as direct parameter
# 
# <!-- adrlogstop -->

[chrisgilmerproj]

Hey @chrisgilmerproj sorry about that. I will try to fix it today. Can you share the expected markup and if is on Windows or Unix (Marcos, Linux...)

Yep, it used to be:

[ADR-0014](0014-aws-roles-and-privileges.md) - AWS Roles and Privileges

Now it is:

[ADR-0014](../adr0014-aws-roles-and-privileges.md) - AWS Roles and Privileges

But I expected the change to give me:

[ADR-0014](../adr/0014-aws-roles-and-privileges.md) - AWS Roles and Privileges

Which is still annoying if my ADR is in the same directory as my index.md.

[chrisgilmerproj]

I am also using this script inside a pre-commit hook which you can see here: https://github.com/trussworks/pre-commit-hooks/blob/master/pre-commit-gen-docs.