Put the table back in 'table of contents'! #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jan 9, 2021
Open
greglockwood
force-pushed
the
fix/npe-when-body-undefined
branch
from
9b0bda0 to
baf00e3
Compare
greglockwood
force-pushed
the
feature/table-format-for-toc
branch
2 times, most recently
from
08da522 to
714c42b
Compare
greglockwood
force-pushed
the
fix/npe-when-body-undefined
branch
from
1c5dec2 to
9b06836
Compare
greglockwood
force-pushed
the
feature/table-format-for-toc
branch
from
714c42b to
48544bc
Compare
greglockwood
changed the title
greglockwood
commented
Jan 11, 2021
github.js
Outdated
| } | ||
| }); | ||
| if (format === 'table') { | ||
| contents += table(tableData, { stringLength: width }) + '\n'; |
There was a problem hiding this comment.
Using the string-width module here works around the strange rules for the width of emoji characters to end up with a table with much more aligned delimiters between columns.
|
Thanks for opening this @greglockwood! Looking forward to using it :) |
realyze
reviewed
Jan 15, 2021
| function constructTrainNavigation(branchToPrDict, currentBranch, combinedBranch, format) { | ||
| let contents = '<pr-train-toc>\n\n'; | ||
| let tableData = [['', 'PR', 'Description']]; | ||
| Object.keys(branchToPrDict).forEach((branch) => { |
There was a problem hiding this comment.
I actually think the table format reads quite a lot nicer than the text one - so I don't think we need to support both. Could we remove the format option and simply always render a table? That should simplify things a bit. WDYT?
# Conflicts: # cfg_template.yml # consts.js # github.js # index.js
greglockwood
force-pushed
the
fix/npe-when-body-undefined
branch
from
9b06836 to
b55bc33
Compare
greglockwood
force-pushed
the
feature/table-format-for-toc
branch
from
48544bc to
67f8efb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem does this PR solve?
As suggested by @alextreppass in realyze#17, it would be nice to support displaying the table of contents in an actual table format.
Main changes
This PR adds a new config option,
prs.toc-formatto the.pr-train.yml. Valid values aretextortable. Iftableis set, a format matching what Alex suggested is used for the TOC (Table of Contents) instead. The default value istext, making this an opt-in feature for now.Related documents/resources
See previous PRs (i.e. realyze#30) for more details about the addition of the
prssection to the config file.How I tested it works
I tested this in my own test repository. One example.