Merge: nitmetrics: metrics about ReadMe files
authorJean Privat <jean@pryen.org>
Thu, 3 May 2018 13:44:21 +0000 (09:44 -0400)
committerJean Privat <jean@pryen.org>
Thu, 3 May 2018 13:44:21 +0000 (09:44 -0400)
commit35575c299011cd9c9ccf18ef23381f6d0722a2d1
treee2a318201bbae83b31d05c177c66a9899f751b07
parent74cc8ca5527507afcf1b10bec8ac2fa3b803bdee
parent662f1a45b5dd059c211e1c5cad50f5913960fd68
Merge: nitmetrics: metrics about ReadMe files

This PR add an option `--readme` to extract metrics about ReadMe / Markdown files.

Running the following command:

~~~sh
nitmetrics --readme tests/test_prog
~~~

Will produce the following output:

~~~md
*** METRICS ***

# ReadMe metrics

 ## package test_prog (test_prog/README.md)
  * has_package 1
  * has_readme 1
  * md_lines 12
  * nb_section 0
  * md_blocks 14
  * BlockParagraph 4
  * BlockUnorderedList 1
  * BlockListItem 4
  * SpanCode 4
  * Image 1
~~~

Pull-Request: #2634
Reviewed-by: Lucas Bajolet <r4pass@hotmail.com>
Reviewed-by: Jean Privat <jean@pryen.org>