fix(Settings): use schema #3375
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
Codecov Report
@@ Coverage Diff @@
## main #3375 /- ##
==========================================
- Coverage 93.54% 93.46% -0.09%
==========================================
Files 88 88
Lines 6558 6575 17
Branches 1513 1525 12
==========================================
Hits 6135 6145 10
- Misses 393 399 6
- Partials 30 31 1
Continue to review full report at Codecov.
|
edemaine
reviewed
Oct 30, 2021
src/Settings.js
Outdated
| output: { | ||
| type: {enum: ["htmlAndMathml", "html", "mathml"]}, | ||
| description: "Determines the markup language of the output.", | ||
| cli: "-f, --format <type>", |
There was a problem hiding this comment.
-f conflicts with --macro-file. I guess we should remove it for backward compatibility?
Tracked in #1503. |
edemaine
approved these changes
Oct 30, 2021
|
Thank you for all the reviews! |
KaTeX-bot
added a commit
that referenced
this pull request
Oct 30, 2021
## [0.14.1](v0.14.0...v0.14.1) (2021-10-30) ### Bug Fixes * **Settings:** use schema ([#3375](#3375)) ([b58a432](b58a432))
|
🎉 This PR is included in version 0.14.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
What is the previous behavior before this PR?
The options of
Settingswere repeated incli.js,type SettingsOptions,class Settings, andSettings::constructor(). This caused some options missing in the CLI, #2237, #2428, andminRuleThickness.What is the new behavior after this PR?
DRY options in
cli.js,Settings::constructor(), andtype SettingsOptions. UseSETTINGS_SCHEMAand$Shape<Settings>, respectively.This adds
-f, --format <type>and--min-rule-thickness <size>to the CLI. Fixes #2237 and closes #2241. It also exportsSETTINGS_SCHEMA, so developers and users could use.Currently, Flow checks if a non-existent property on Settings exists on the schema.
In the future, we could
optionsagainst the schema, throwing on unknown values or type mismatches (this would be a breaking change)Settingsexist on the schemaSettingsmatches the schema (I'd like to do these two after Consider using TypeScript instead of Flow #2110)