Move scoring out of general Util into scoring util file #1962
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
GeraldRequired Reviewers
Don't want to be involved in this pull request? Comment |
jeremywiebe
commented
Dec 6, 2024
| @@ -1,21 +1,4 @@ | |||
| import Util, {isCorrect} from "../util"; | |||
|
|
|||
| describe("isCorrect", () => { | |||
There was a problem hiding this comment.
All deleted tests here just moved to scoring.test.ts
jeremywiebe
commented
Dec 6, 2024
| @@ -47,7 +47,7 @@ import {DependenciesContext} from "../dependencies"; | |||
| import HintsRenderer from "../hints-renderer"; | |||
| import {Log} from "../logging/log"; | |||
| import Renderer from "../renderer"; | |||
| import Util from "../util"; | |||
| import {combineScores, keScoreFromPerseusScore} from "../util/scoring"; | |||
There was a problem hiding this comment.
Also switched to ES6 exports in the new file.
npm Snapshot: PublishedGood news!! We've packaged up the latest commit from this PR (f44e07e) and published it to npm. You Example: yarn add @khanacademy/perseus@PR1962If you are working in Khan Academy's webapp, you can run: ./dev/tools/bump_perseus_version.sh -t PR1962 |
|
Size Change: +6 B (0%) Total Size: 1.29 MB
ℹ️ View Unchanged
|
Myranae
approved these changes
Dec 6, 2024
handeyeco
approved these changes
Dec 6, 2024
.changeset/clever-cars-eat.md
Outdated
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| "@khanacademy/perseus": minor | |||
There was a problem hiding this comment.
I'd argue this is a major change. Util is exported from index.ts:
export {default as Util} from "./util";You'll see that this breaks Webapp because I used Util.keScoreFromPerseusScore in my recent change. So:
- Probably a major change
- I'd double check the utils that you moved to make sure they're not used in Webapp (and export the ones that are)
There was a problem hiding this comment.
Agreed. I didn't catch the one usage of keScoreFromPerseusScore outside of Perseus. Fixing.
Merged
jeremywiebe
pushed a commit
that referenced
this pull request
Dec 6, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @khanacademy/perseus@46.0.0 ### Major Changes - [#1962](#1962) [`435280ac4`](435280a) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Move scoring utility functions out of `Util` object into their own file and only export externally used function (`keScoreFromPerseusScore`) - [#1961](#1961) [`d93e3ecde`](d93e3ec) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Remove deprecated/unused `examples()` function from `Renderer` ## @khanacademy/perseus-editor@15.1.3 ### Patch Changes - Updated dependencies \[[`435280ac4`](435280a), [`d93e3ecde`](d93e3ec)]: - @khanacademy/perseus@46.0.0 Author: khan-actions-bot Reviewers: jeremywiebe Required Reviewers: Approved By: jeremywiebe Checks: ⏭️ Publish npm snapshot, ✅ Cypress (ubuntu-latest, 20.x), ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ gerald Pull Request URL: #1964
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.
Summary:
Like #1948, I was working in
utils.tsand found it annoying how there were so many different utils in one file (graphing support, scoring, word/text manipulation). So this just pulls scoring-related behaviour out into a new file. This means these symbols are no longer on theUtilsobject, but I checked and they aren't used in Perseus nor in consuming apps.Issue: LEMS-2561
Test plan:
yarn testyarn typecheck