Reorganized utilities and handled multiline comments in JSON #10
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
ijlee2
added
bug
ijlee2
commented
Jan 23, 2023
| @@ -49,6 +49,7 @@ | |||
| "@babel/eslint-parser": "^7.19.1", | |||
| "glob": "^8.1.0", | |||
| "lodash.template": "^4.5.0", | |||
| "strip-json-comments": "^5.0.0", | |||
There was a problem hiding this comment.
We can remove this dependency if we can find another (simple) way to partially update tsconfig.json.
ijlee2
commented
Jan 23, 2023
Comment on lines
+23
to
+24
| "concurrently": "<%= context.projectRoot.devDependencies['concurrently'] %>", | ||
| "prettier": "<%= context.projectRoot.devDependencies['prettier'] %>" |
There was a problem hiding this comment.
Addressed a technical risk (hard-coded latest versions).
ijlee2
commented
Jan 23, 2023
Comment on lines
+4
to
+5
| export function processTemplate(file, data) { | ||
| const settings = { |
There was a problem hiding this comment.
I renamed the variables so that the words context and options don't carry more than one meaning.
ijlee2
commented
Jan 23, 2023
Comment on lines
+4
to
+5
| test('utils | blueprints | process-template > escape', function () { | ||
| const blueprintFile = '<%- context.htmlCode %>'; |
There was a problem hiding this comment.
At the moment, none of the blueprints make use of the escape feature from lodash.template.
ijlee2
changed the title
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.
Description
Refactors
I reorganized the utility functions so that their purpose and relation to one another is more clear. In addition, I wrote unit tests that had been missing.
Bug fix
Prior to this pull request,
sanitizeJson()didn't remove multiline comments in a JSON file, soJSON.parse()would have resulted in a runtime error. (This case isn't likely ifember-cli-typescripthad createdtsconfig.json.)I installed
strip-json-commentsto remove the inline and multiline comments fromtsconfig.json. In the future, I may look at whether there's an easy way to preserve comments and partially update a JSON.