pipal icon indicating copy to clipboard operation
pipal copied to clipboard

Output as markdown

Open digininja opened this issue 1 year ago • 4 comments

@lexus89 As a user of the tool, how would you feel if I update the output to produce markdown rather than basic text? I'm thinking about it as it would then let me do markdown to HTML for some nicer reports.

digininja avatar Aug 18 '23 15:08 digininja

I've just committed a checker called basic_markdown which outputs as markdown. The only bit I've not worked out is the graphs, I'm still thinking about that.

digininja avatar Aug 18 '23 16:08 digininja

It indeed would be nice to have HTML as an additional output format, besides the current regular text output. Something easy to parse for adding the data into other custom reports. Thanks I will be testing it out next week!

Lexus89 avatar Aug 18 '23 17:08 Lexus89

After enabling the markdown checker I do get some messages like the following:

pipal/checkers_available/basic_markdown.rb:9: warning: already initialized constant Basic Checker::FIRST_CAP_LAST_NUM_RE

For various checkers I also get listings with just 1s:

Top 10 base words

  1. password
  2. welcome
  3. letmein

Lexus89 avatar Aug 23 '23 08:08 Lexus89

It sites over the top of the normal basic so you need to remove that one for this to work, I should have renamed it internally.

It looks like GitHub has styled your 1's. In markdown, you do ordered lists with 1. starting everything, the renderer then puts the numbers in. You can do it with incrementing numbers but don't have to so it is easier for me just to hardcode 1. rather than do increments.

I'm going to try to do graphs today. From what I've seen, the only real way to do them would be to create images and reference them as external files. I'd rather have everything in a single file but looks like I won't be able to do that. I'll see how it goes.

digininja avatar Aug 23 '23 10:08 digininja