Skip to content

Refactor Grid CoursePanel into Typescript React Components - #1830

Merged
david-yz-liu merged 17 commits into
Courseography:masterfrom
PeanutPiglet:ts-migrate-course_panel
Nov 15, 2026
Merged

david-yz-liu merged 17 commits into
Courseography:masterfrom
PeanutPiglet:ts-migrate-course_panel

Conversation

@PeanutPiglet

@PeanutPiglet PeanutPiglet commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Proposed Changes

Refactored components previously in js/components/grid/course_panel.js.jsx into individual files.
Migrated from javascript react (jsx) to typescript (tsx).
Appended previously missing fields to common frontend type.

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
✨ New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality) X
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.
  • I have updated the project Changelog (this is required for all changes).

After opening your pull request:

  • I have verified that the CI checks have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@coveralls

coveralls commented Nov 10, 2026 •

Copy link
Copy Markdown

Coverage Report for CI Build 43685013005

Coverage increased (+0.02%) to 61.618%

Details

  • Coverage increased (+0.02%) from the base build.
  • Patch coverage: 21 uncovered changes across 5 files (48 of 69 lines covered, 69.57%).
  • No coverage regressions found.

Uncovered Changes

File Changed Covered %
js/components/grid/course_entry.tsx 6 0 0.0%
js/components/grid/course_panel.tsx 14 8 57.14%
js/components/grid/course.tsx 30 27 90.0%
js/components/grid/course_list.tsx 12 9 75.0%
js/components/grid/lecture_section.tsx 4 1 25.0%
Total (6 files) 69 48 69.57%

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 4295
Covered Lines: 2698
Line Coverage: 62.82%
Relevant Branches: 1007
Covered Branches: 569
Branch Coverage: 56.5%
Branches in Coverage %: Yes
Coverage Strength: 158.3 hits per line

💛 - Coveralls

@PeanutPiglet
PeanutPiglet marked this pull request as ready for review November 10, 2026 03:27

@david-yz-liu david-yz-liu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @PeanutPiglet, I just left two inline comments

Comment thread js/components/grid/course.tsx Outdated
* Also retrieves the course information. It holds list of F, S and Y lecture, tutorial
* and practical sections for the course.
*/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not include a blank line between the class docstring and the header (throughout)

Comment thread js/components/grid/course.tsx Outdated
@@ -0,0 +1,210 @@
import { useState, useEffect, useCallback } from "react"
import { getCourse } from "../common/utils"
import { SelectedLecture } from "./types"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

throughout, use type-only imports for identifiers that are only imported for type annotations

Comment thread js/components/grid/course.tsx Outdated
<h3
onClick={toggleSelect}
data-satisfied="true"
data-taken={containsSelectedLecture() ? "true" : "false"}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PeanutPiglet sorry I forgot about this when I published my review, but if this attribute is not actually used anywhere in the codebase, you can just remove it.

Comment thread js/components/grid/course.tsx Outdated
unhoverLecture,
selectLecture,
displayInfo,
}: CourseProps) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PeanutPiglet Ah, looking at #1831, I realized I should have asked you to provide return type annotations for all of these components as well!

@david-yz-liu david-yz-liu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, @PeanutPiglet!

@david-yz-liu
david-yz-liu merged commit 9a9f57b into Courseography:master Nov 15, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants