lint

Author: sezanzeb

backend/src/entities/longtext.ts

@@ -1,5 +1,8 @@
 import { Column } from "typeorm";
 
+/**
+ * mariadb longtext, and for in-memory sqlite regular text
+ */
 export function Longtext() {
   // Sqlite doesn't support longtext. I hate this, but it is what it is if we want
   // to keep backend tests and prepare tilt for the upcoming Hackaburg as quickly

backend/src/services/config-service.ts

@@ -102,9 +102,9 @@ export class ConfigurationService implements IConfigurationService {
     const { error } = dotenv.config();
 
     if (error) {
-      // tslint:disable-next-line: no-console
       // Make sure your cwd is the backend directory, which contains the .env file,
       // and that .env.example has been copied to .env
+      // tslint:disable-next-line: no-console
       console.warn(`error loading .env configuration: ${error}`);
     }
   }

backend/src/services/criterion-service.ts

@@ -6,6 +6,9 @@ import { DatabaseServiceToken, IDatabaseService } from "./database-service";
 import { CriterionDTO, convertBetweenEntityAndDTO } from "../controllers/dto";
 import { Criterion } from "../entities/criterion";
 
+/**
+ * A service to handle criteria.
+ */
 export interface ICriterionService extends IService {
   /**
    * Get all criteria

backend/src/services/project-service.ts

@@ -73,7 +73,7 @@ export class ProjectService implements IProjectService {
 
     const [settings] = await this._settings.find();
     const allowRatingProjects = settings.application.allowRatingProjects;
-    const isAdmin = user.role == UserRole.Root;
+    const isAdmin = user.role === UserRole.Root;
 
     const projects = await this._projects.find();
     return projects.filter((project) => {

backend/src/services/rating-service.ts

@@ -16,6 +16,9 @@ import { Project } from "../entities/project";
 import { Criterion } from "../entities/criterion";
 import { UserRole } from "../entities/user-role";
 
+/**
+ * A service to handle rating entities.
+ */
 export interface IRatingService extends IService {
   /**
    * Get the ratings for a specific project, cast by a specific user.
@@ -49,7 +52,7 @@ export interface IRatingService extends IService {
 export const RatingServiceToken = new Token<IRatingService>();
 
 /**
- * A service to handle users.
+ * A service to handle rating entities.
  */
 @Service(RatingServiceToken)
 export class RatingService implements IRatingService {
@@ -63,7 +66,7 @@ export class RatingService implements IRatingService {
   ) {}
 
   /**
-   * Sets up the user service.
+   * Sets up the rating service.
    */
   public async bootstrap(): Promise<void> {
     this._ratings = this._database.getRepository(Rating);
@@ -172,12 +175,12 @@ export class RatingService implements IRatingService {
     const allProjects = await this._projects.find();
     const allRatings = await this._ratings.find();
 
-    const result = [];
+    const result: ProjectRatingResultDTO[] = [];
 
     const idToCriterion: Record<number, Criterion> = {};
 
     for (const project of allProjects) {
-      const averagesPerCriterion = [];
+      const averagesPerCriterion: { criterion: Criterion, average: number }[] = [];
 
       // Sum up
       const criterionIdToSum: Record<number, number> = {};
@@ -200,12 +203,17 @@ export class RatingService implements IRatingService {
       }
 
       // Calculate average
-      for (const criterionId in criterionIdToSum) {
-        const average =
-          criterionIdToSum[criterionId] / criterionIdToCount[criterionId];
+      Object.keys(criterionIdToSum).map(Number).forEach(criterionId => {
+        const count = criterionIdToCount[criterionId]
+        if (count === 0) {
+          return
+        }
+
+        const sum = criterionIdToSum[criterionId]
+        const average = sum / count;
         const criterion = idToCriterion[criterionId];
         averagesPerCriterion.push({ criterion, average });
-      }
+      });
 
       result.push({
         project,

frontend/src/components/base/image.tsx

@@ -1,5 +1,6 @@
 import styled from "@emotion/styled";
 import * as React from "react";
+import { borderRadius } from "../../config";
 
 const Img = styled.img`
   max-width: 100%;
@@ -17,6 +18,9 @@ export const Image = ({ src, label }: IImageProps) => (
   <Img src={src} alt={label} />
 );
 
+/**
+ * An image with rounded corners.
+ */
 export const RoundedImage = styled.img`
-  border-radius: 5px;
+  border-radius: ${borderRadius};
 `;

frontend/src/components/pages/projects.tsx

@@ -37,12 +37,12 @@ const RatingResults = () => {
   const [criteria, setCriteria] = React.useState<CriterionDTO[]>([]);
 
   useEffect(() => {
-    api.getRatingResults().then((stuff) => {
-      setRatingResults([...stuff]);
+    api.getRatingResults().then((ratingResults_) => {
+      setRatingResults([...ratingResults_]);
     });
 
-    api.getAllCriteria().then((criteria) => {
-      setCriteria([...criteria]);
+    api.getAllCriteria().then((criteria_) => {
+      setCriteria([...criteria_]);
     });
   }, []);
 
@@ -77,7 +77,7 @@ const RatingResults = () => {
                     <TableCell key={criterion.id} align="center">
                       {
                         resultForProject.averagesPerCriterion.find(
-                          (a) => a.criterion.id == criterion.id,
+                          (a) => a.criterion.id === criterion.id,
                         )?.average
                       }
                     </TableCell>

frontend/src/components/pages/rating-form.tsx

@@ -48,10 +48,10 @@ export const RatingForm = ({
     setError(null);
 
     await api.createRating({
-      criterion: criterion,
-      rating: parseInt(ratingValue ?? "0"),
+      criterion,
+      rating: parseInt(ratingValue ?? "0", 10),
       user: user!,
-      project: project,
+      project,
     } as unknown as RatingDTO);
 
     setIsSubmitting(false);

frontend/src/components/pages/read-only-project.tsx

@@ -15,13 +15,13 @@ export const ReadOnlyProject = ({ project }: { project: ProjectDTO }) => {
   const [ratings, setRatings] = React.useState<RatingDTO[]>([]);
 
   React.useEffect(() => {
-    api.getAllCriteria().then((criteria) => {
-      setCriteria([...criteria]);
+    api.getAllCriteria().then((criteria_) => {
+      setCriteria([...criteria_]);
     });
 
     if (project) {
-      api.getUsersRatingsForProject(project).then((ratings) => {
-        setRatings([...ratings]);
+      api.getUsersRatingsForProject(project).then((ratings_) => {
+        setRatings([...ratings_]);
       });
     }
   }, [project]);
@@ -49,7 +49,7 @@ export const ReadOnlyProject = ({ project }: { project: ProjectDTO }) => {
         think the project did well in this regard.
         {criteria.map((criterion) => (
           <RatingForm
-            rating={ratings.find((r) => r.criterion.id == criterion.id)}
+            rating={ratings.find((r) => r.criterion.id === criterion.id)}
             criterion={criterion}
             project={project}
           />

frontend/src/components/pages/view-project.tsx

@@ -23,7 +23,7 @@ export const ViewProject = () => {
   const params = new URLSearchParams(document.location.search);
   const projectId = Number(params.get("id"));
   React.useEffect(() => {
-    api.getProjectByID(projectId).then((project) => setProject(project));
+    api.getProjectByID(projectId).then((project_) => setProject(project_));
   }, []);
 
   const isTeamMember = React.useMemo(() => {
@@ -32,7 +32,7 @@ export const ViewProject = () => {
     );
   }, [project, user?.id]);
 
-  const isAdmin = user?.role == UserRole.Root;
+  const isAdmin = user?.role === UserRole.Root;
 
   if (!project) {
     return null;
@@ -82,7 +82,7 @@ const EditProject = ({ project }: { project: ProjectDTO }) => {
     event.preventDefault();
   }, []);
 
-  const isAdmin = user?.role == UserRole.Root;
+  const isAdmin = user?.role === UserRole.Root;
 
   return (
     <Page>