feat(tests): Add a test to validate scripts/migration/renamings.js
#5980
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
* Make scripts/migration/renamings.js a valid JSON5 file. * Add a schema for it in tests/migration/renamings-schema.json. * Add a script to test one against the other, as tests/migration/validate-renamings. It is a node.js script that will exit 0 if the renamings file is valid, or 1 if it is not (and print a not-very-helpful error message from which is possible, with some effort, to deduce what the error is.)
cpcallen
commented
Mar 7, 2022
scripts/migration/renamings.json5
Outdated
| @@ -11,8 +11,6 @@ | |||
| * This file is in JSON5 format; see https://json5.org/. | |||
| */ | |||
|
|
|||
| /* eslint-disable */ | |||
There was a problem hiding this comment.
Since eslint is more picky about formatting than JSON5.parse (sensibly!), I wonder if we should still try to lint this file.
There was a problem hiding this comment.
Related plugin for doing so: https://github.com/bayesimpact/eslint-plugin-json5
There was a problem hiding this comment.
That looks useful but I think I want to postpone this to a later PR: there are some things I don't quite understand about our eslint setup.
This reverts commit efe070e.
And fix the resulting validation error in the example entry.
Tweaked line wrapping of some existing entries (example and acutal) that were otherwise untouched.
Also fixed extraneous whitespace in run_all_tests.sh
# Conflicts: # scripts/migration/renamings.js
|
Tests failing on Node v12 with |
Also remove success message, to adhere to usual unix convention (silence implies success) as eslint does, and reduce unecessary npm test output clutter.
|
OK, @gonfunko: this should now be ready for final review. |
gonfunko
approved these changes
Mar 9, 2022
* Fix typos. * Remove redundant check.
This was referenced Apr 21, 2022
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 basics
The details
Resolves
Resolves #5645.
Proposed Changes
scripts/migration/renamings.jsa valid JSON5 file.tests/migration/renamings-schema.json.tests/migration/validate-renamings.renamings.jsso that:tests/run_all_tests.shto runvalidate-renamings.Behaviour Before Change
The renamings file existed, but it had a different format and there were no tests.
Behaviour After Change
Now we have a beautifully formatted, schema-ed renamings file that should serve all of our renaming needs.
Reason for Changes
Supporting handling renamings for people.
Test Coverage
This is tests!
Documentation
N/A
Additional Information
N/A