adr / madr

Markdown Architectural Decision Records
https://adr.github.io/madr/
Other
1.42k stars 402 forks source link

Add trailing newline to toc #26

Closed dreh23 closed 4 years ago

dreh23 commented 4 years ago

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

koppor commented 4 years ago

I wonder which tool you are using. This repository does not offer any comamnd line tool(yet). adr-log does not offer -u. Is it our fork of adr-tools? This does not support -u, does it?

I would like to work on a fix, since I also make heavy use of markdown-lint and a GitHub action workflow:

name: Lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Git repository
        uses: actions/checkout@v2
      - name: Lint all files
        uses: avto-dev/markdown-lint@v1
        with:
          args: 'en/'
          config: '.markdownlint.yml'
dreh23 commented 4 years ago

Sorry I think I mixed things up, I am using the npm adr tool from phodal. I filed an ussue there

koppor commented 4 years ago

That motivates me to resume work on adr-j with direct support of MADR.