Add validate command
#28
Merged
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
Gudahtt
force-pushed
the
add-validate-command
branch
from
62821ed to
983cf0a
Compare
Gudahtt
force-pushed
the
move-update-to-subcommand
branch
from
def1d77 to
9192289
Compare
Gudahtt
force-pushed
the
add-validate-command
branch
3 times, most recently
from
c826108 to
cf1da06
Compare
Gudahtt
force-pushed
the
add-validate-command
branch
from
cf1da06 to
20c436f
Compare
Gudahtt
force-pushed
the
add-validate-command
branch
from
20c436f to
56b1a64
Compare
Gudahtt
force-pushed
the
add-validate-command
branch
from
56b1a64 to
cc77665
Compare
|
Rebased to resolve conflicts |
Gudahtt
commented
Apr 21, 2021
| configureCommonCommandOptions(_yargs) | ||
| .option('rc', { | ||
| default: false, | ||
| description: `Verify that the current version has a release header in the changelog`, |
There was a problem hiding this comment.
I left rc out of the "commonCommandOptions" group because it was helpful to have a separate description for this flag for each command, since it implies something a bit different in each case.
Gudahtt
force-pushed
the
add-validate-command
branch
2 times, most recently
from
592aedd to
57f1a08
Compare
Gudahtt
commented
Apr 21, 2021
The validate command will validate the formatting of the changelog. If the `--rc` flag is used, it will also ensure that the current version is included as a release header, and that there are no unreleased changes. The CLI command displays a rudimentary diff if formatting problems are detected. This can be improved later with colours, and with highlighting within each line to show what has changed. It also doesn't yet highlight whitespace changes. The validation logic is also exposed via the API as a function called `validateChangelog`. It doesn't include the fancy diff output, but it does throw an error with all of the required information for someone to construct the same output. Tests have been added to comprehensively test the changelog validation. Closes #11
All invalid changelog cases are now described by the `InvalidChangelogError` error type, which has sub-classes to describe each possible scenario. This allows distinguishing invalid changelog errors from all other unexpected errors. The CLI has been updated to take advantage of this; we now print a simpler error message if the changelog is invalid, rather than a stack trace.
Gudahtt
force-pushed
the
add-validate-command
branch
from
8b592ed to
6a7e22f
Compare
rekmarks
requested changes
Apr 23, 2021
Gudahtt
force-pushed
the
add-validate-command
branch
from
5986ad7 to
5a5f983
Compare
The `generateDiff` function now has a comprehensive test suite. It has been updated to ensure that the resulting diff displays a notice about whether or not the file has a trailing newline. I started this journey by trying to ensure we were trimming each line properly. I found that `diff.diffLines` always returned change sets that ended in a newline, except when returning the very last change to a file that didn't terminate in a newline. So in order to ensure we were correctly showing all changes, I needed to add special handling for end-of-file changes. We could display this differently than I've chosen to here, but I figured showing what `git` shows was a good start. The `generateDiff` function now also ensures the correct context is shown in between each change. The dependency `outdent` was added to help with writing inline test fixtures. This saves us from having to come up with a name for each fixture and cross-reference them in each test. When adding that dependency, an ESLint error brought to my attention that we were accidentally including test files in our `files` property in `package.json`. It was updated to exclude test files, which resolved the ESLint error.
Gudahtt
force-pushed
the
add-validate-command
branch
from
5a5f983 to
b1375e8
Compare
Co-authored-by: Erik Marks <[email protected]>
The passing test cases have been grouped together at the beginning of the main `describe` block.
|
Just pushed one more commit to improve variable names and comments. I think everything has been addressed - let me know if not! |
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.
The validate command will validate the formatting of the changelog. If the
--rcflag is used, it will also ensure that the current version is included as a release header, and that there are no unreleased changes.The CLI command displays a rudimentary diff if formatting problems are detected. This can be improved later with colours, and with highlighting within each line to show what has changed. It also doesn't yet highlight whitespace changes.
The validation logic is also exposed via the API as a function called
validateChangelog. It doesn't include the fancy diff output, but it does throw an error with all of the required information for someone to construct the same output.Closes #11