chore: lint-format-docs-tests-bugfixes (#105)
* docs: add jsdoc * feat: change enums to as const objects * chore(test): add themeColors.test.ts * fix: fix tests and bugs with strings.ts util * fix: path alias imports and tsconfig file bug * fix: remove --max-warnings 0
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
/* eslint-disable max-classes-per-file */
|
||||
import { Serialized } from 'chrome-extension-toolkit';
|
||||
import { CourseMeeting } from './CourseMeeting';
|
||||
import type { Serialized } from 'chrome-extension-toolkit';
|
||||
|
||||
import type { CourseMeeting } from './CourseMeeting';
|
||||
import { CourseSchedule } from './CourseSchedule';
|
||||
import Instructor from './Instructor';
|
||||
|
||||
@@ -12,12 +12,17 @@ export type InstructionMode = 'Online' | 'In Person' | 'Hybrid';
|
||||
/**
|
||||
* The status of a course (e.g. open, closed, waitlisted, cancelled)
|
||||
*/
|
||||
export enum Status {
|
||||
OPEN = 'OPEN',
|
||||
CLOSED = 'CLOSED',
|
||||
WAITLISTED = 'WAITLISTED',
|
||||
CANCELLED = 'CANCELLED',
|
||||
}
|
||||
export const Status = {
|
||||
OPEN: 'OPEN',
|
||||
CLOSED: 'CLOSED',
|
||||
WAITLISTED: 'WAITLISTED',
|
||||
CANCELLED: 'CANCELLED',
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* Represents the type of status for a course.
|
||||
*/
|
||||
export type StatusType = (typeof Status)[keyof typeof Status];
|
||||
|
||||
/**
|
||||
* Represents a semester, with the year and the season for when a course is offered
|
||||
@@ -49,7 +54,7 @@ export class Course {
|
||||
/** The number of credits that a course is worth */
|
||||
creditHours: number;
|
||||
/** Is the course open, closed, waitlisted, or cancelled? */
|
||||
status: Status;
|
||||
status: StatusType;
|
||||
/** all the people that are teaching this course, and some metadata about their names */
|
||||
instructors: Instructor[];
|
||||
/** Some courses at UT are reserved for certain groups of people or people within a certain major, which makes it difficult for people outside of that group to register for the course. */
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Serialized } from 'chrome-extension-toolkit';
|
||||
import type { Serialized } from 'chrome-extension-toolkit';
|
||||
|
||||
/**
|
||||
* a map of the days of the week that a class is taught, and the corresponding abbreviation
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
import { Serialized } from 'chrome-extension-toolkit';
|
||||
import { CourseMeeting, Day, DAY_MAP } from './CourseMeeting';
|
||||
import type { Serialized } from 'chrome-extension-toolkit';
|
||||
|
||||
import type { Day } from './CourseMeeting';
|
||||
import { CourseMeeting, DAY_MAP } from './CourseMeeting';
|
||||
|
||||
/**
|
||||
* This represents the schedule for a course, which includes all the meeting times for the course, as well as helper functions for parsing, serializing, and deserializing the schedule
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* eslint-disable max-classes-per-file */
|
||||
import { PointOptionsObject } from 'highcharts';
|
||||
|
||||
import { Semester } from './Course';
|
||||
/**
|
||||
* Each of the possible letter grades that can be given in a course
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { Serialized } from 'chrome-extension-toolkit';
|
||||
import type { Serialized } from 'chrome-extension-toolkit';
|
||||
|
||||
import { capitalize } from '../util/string';
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { Serialized } from 'chrome-extension-toolkit';
|
||||
import type { Serialized } from 'chrome-extension-toolkit';
|
||||
|
||||
import { Course } from './Course';
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user