plugin: configure biome style rules

Author: jamiebrynes7

biome.json

@@ -1,14 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.1.1/schema.json",
-  "files": {
-    "experimentalScannerIgnores": [
-      "**/node_modules/**",
-      "**/dist/**",
-      "**/build/**",
-      "**/.devenv/**",
-      "**/.direnv/**"
-    ]
-  },
+  "$schema": "https://biomejs.dev/schemas/2.3.8/schema.json",
   "formatter": {
     "enabled": true,
     "indentStyle": "space",
@@ -24,9 +15,75 @@
       },
       "a11y": {
         "noStaticElementInteractions": "off"
+      },
+      "style": {
+        "noDefaultExport": "error",
+        "noExportedImports": "error",
+        "noInferrableTypes": "error",
+        "noMagicNumbers": "error",
+        "noNegationElse": "error",
+        "noNestedTernary": "error",
+        "noNonNullAssertion": "error",
+        "noParameterAssign": "error",
+        "noParameterProperties": "error",
+        "noShoutyConstants": "error",
+        "noUselessElse": "error",
+        "noYodaExpression": "error",
+        "useArrayLiterals": "error",
+        "useAsConstAssertion": "error",
+        "useBlockStatements": "error",
+        "useCollapsedElseIf": "error",
+        "useCollapsedIf": "error",
+        "useConsistentArrayType": {
+          "level": "error",
+          "options": {
+            "syntax": "shorthand"
+          }
+        },
+        "useConsistentCurlyBraces": "error",
+        "useConsistentObjectDefinitions": {
+          "level": "error",
+          "options": {
+            "syntax": "shorthand"
+          }
+        },
+        "useConst": "error",
+        "useDefaultParameterLast": "error",
+        "useDefaultSwitchClause": "error",
+        "useEnumInitializers": "error",
+        "useExplicitLengthCheck": "error",
+        "useForOf": "error",
+        "useFragmentSyntax": "error",
+        "useImportType": "error",
+        "useLiteralEnumMembers": "error",
+        "useNumberNamespace": "error",
+        "useNumericSeparators": "error",
+        "useObjectSpread": "error",
+        "useReactFunctionComponents": "error",
+        "useReadonlyClassProperties": "error",
+        "useSelfClosingElements": "error",
+        "useShorthandFunctionType": "error",
+        "useSingleVarDeclarator": "error",
+        "useTemplate": "error",
+        "useThrowNewError": "error",
+        "useThrowOnlyError": "error"
       }
     }
   },
+  "overrides": [
+    {
+      "includes": [
+        "**/*.test.ts"
+      ],
+      "linter": {
+        "rules": {
+          "style": {
+            "noMagicNumbers": "off"
+          }
+        }
+      }
+    }
+  ],
   "assist": {
     "actions": {
       "source": {

plugin/src/api/domain/task.ts

@@ -29,10 +29,17 @@ export type Task = {
   order: number;
 };
 
-export type Priority = 1 | 2 | 3 | 4;
+export const Priorities = {
+  P4: 1,
+  P3: 2,
+  P2: 3,
+  P1: 4,
+} as const;
+
+export type Priority = (typeof Priorities)[keyof typeof Priorities];
 
 export type CreateTaskParams = {
-  priority: number;
+  priority: Priority;
   projectId: ProjectId;
   description?: string;
   sectionId?: SectionId;

plugin/src/api/fetcher.ts

@@ -4,6 +4,25 @@ export interface WebFetcher {
   fetch(params: RequestParams): Promise<WebResponse>;
 }
 
+export type StatusCode = number;
+
+export const StatusCode = {
+  isError(code: StatusCode): boolean {
+    return code >= StatusCodes.BadRequest;
+  },
+  isServerError(code: StatusCode): boolean {
+    return code >= StatusCodes.InternalServerError;
+  },
+} as const;
+
+export const StatusCodes = {
+  OK: 200,
+  BadRequest: 400,
+  Unauthorized: 401,
+  Forbidden: 403,
+  InternalServerError: 500,
+} as const;
+
 export type RequestParams = {
   url: string;
   method: string;
@@ -12,7 +31,7 @@ export type RequestParams = {
 };
 
 export type WebResponse = {
-  statusCode: number;
+  statusCode: StatusCode;
   body: string;
 };
 

plugin/src/api/index.ts

@@ -6,17 +6,17 @@ import type { Project } from "@/api/domain/project";
 import type { Section } from "@/api/domain/section";
 import type { CreateTaskParams, Task, TaskId } from "@/api/domain/task";
 import type { UserInfo } from "@/api/domain/user";
-import type { RequestParams, WebFetcher, WebResponse } from "@/api/fetcher";
-import debug from "@/log";
+import { type RequestParams, StatusCode, type WebFetcher, type WebResponse } from "@/api/fetcher";
+import { debug } from "@/log";
 
 type PaginatedResponse<T> = {
   results: T[];
   nextCursor: string | null;
 };
 
 export class TodoistApiClient {
-  private token: string;
-  private fetcher: WebFetcher;
+  private readonly token: string;
+  private readonly fetcher: WebFetcher;
 
   constructor(token: string, fetcher: WebFetcher) {
     this.token = token;
@@ -26,14 +26,14 @@ export class TodoistApiClient {
   public async getTasks(filter?: string): Promise<Task[]> {
     if (filter !== undefined) {
       return await this.doPaginated<Task>("/tasks/filter", { query: filter });
-    } else {
-      return await this.doPaginated<Task>("/tasks");
     }
+
+    return await this.doPaginated<Task>("/tasks");
   }
 
   public async createTask(content: string, options?: CreateTaskParams): Promise<Task> {
     const body = snakify({
-      content: content,
+      content,
       ...(options ?? {}),
     });
     const response = await this.do("/tasks", "POST", body);
@@ -87,7 +87,7 @@ export class TodoistApiClient {
   private async do(path: string, method: string, json?: object): Promise<WebResponse> {
     const params: RequestParams = {
       url: `https://api.todoist.com/api/v1${path}`,
-      method: method,
+      method,
       headers: {
         Authorization: `Bearer ${this.token}`,
       },
@@ -110,7 +110,7 @@ export class TodoistApiClient {
       context: response,
     });
 
-    if (response.statusCode >= 400) {
+    if (StatusCode.isError(response.statusCode)) {
       throw new TodoistApiError(params, response);
     }
 
@@ -119,7 +119,7 @@ export class TodoistApiClient {
 }
 
 export class TodoistApiError extends Error {
-  public statusCode: number;
+  public statusCode: StatusCode;
 
   constructor(request: RequestParams, response: WebResponse) {
     const message = `[${request.method}] ${request.url} returned '${response.statusCode}: ${response.body}`;

plugin/src/commands/index.ts

@@ -8,7 +8,7 @@ import {
 import { t } from "@/i18n";
 import type { Translations } from "@/i18n/translation";
 import type TodoistPlugin from "@/index";
-import debug from "@/log";
+import { debug } from "@/log";
 
 export type MakeCommand = (
   plugin: TodoistPlugin,

plugin/src/data/deadline.ts

@@ -84,6 +84,8 @@ const formatDeadline = (info: DeadlineInfo): string => {
       return i18n.lastWeekday(getFormatter("weekday").format(info.raw));
     case "nextWeek":
       return getFormatter("weekday").format(info.raw);
+    default:
+      break;
   }
 
   if (!info.isCurrentYear) {

plugin/src/data/dueDate.ts

@@ -170,6 +170,8 @@ const formatDate = (info: DateInfo): string => {
       return i18n.lastWeekday(getFormatter("weekday").format(info.raw));
     case "nextWeek":
       return getFormatter("weekday").format(info.raw);
+    default:
+      break;
   }
 
   if (!info.isCurrentYear) {
@@ -194,6 +196,8 @@ const formatDueDateHeader = (due: DueDate): string => {
     case "tomorrow":
       parts.push(i18n.tomorrow);
       break;
+    default:
+      break;
   }
 
   return parts.join(" ‧ ");

plugin/src/data/index.ts

@@ -4,6 +4,7 @@ import type { Project, ProjectId } from "@/api/domain/project";
 import type { Section, SectionId } from "@/api/domain/section";
 import type { Task as ApiTask, CreateTaskParams, TaskId } from "@/api/domain/task";
 import type { UserInfo } from "@/api/domain/user";
+import { StatusCode, StatusCodes } from "@/api/fetcher";
 import { Repository, type RepositoryReader } from "@/data/repository";
 import { SubscriptionManager, type UnsubscribeCallback } from "@/data/subscriptions";
 import type { Task } from "@/data/task";
@@ -146,10 +147,10 @@ export class TodoistAdapter {
       description: apiTask.description,
 
       project: project ?? makeUnknownProject(apiTask.projectId),
-      section: section,
+      section,
       parentId: apiTask.parentId ?? undefined,
 
-      labels: labels,
+      labels,
       priority: apiTask.priority,
 
       due: apiTask.due ?? undefined,
@@ -253,13 +254,13 @@ class Subscription {
         kind: QueryErrorKind.Unknown,
       };
       if (error instanceof TodoistApiError) {
-        if (error.statusCode === 400) {
+        if (error.statusCode === StatusCodes.BadRequest) {
           result.kind = QueryErrorKind.BadRequest;
-        } else if (error.statusCode === 401) {
+        } else if (error.statusCode === StatusCodes.Unauthorized) {
           result.kind = QueryErrorKind.Unauthorized;
-        } else if (error.statusCode === 403) {
+        } else if (error.statusCode === StatusCodes.Forbidden) {
           result.kind = QueryErrorKind.Forbidden;
-        } else if (error.statusCode > 500) {
+        } else if (StatusCode.isServerError(error.statusCode)) {
           result.kind = QueryErrorKind.ServerError;
         }
       }

plugin/src/data/subscriptions.ts

@@ -3,7 +3,7 @@ export type UnsubscribeCallback = () => void;
 
 export class SubscriptionManager<T> {
   private readonly subscriptions: Map<SubscriptionId, T> = new Map();
-  private generator: Generator<SubscriptionId> = subscriptionIdGenerator();
+  private readonly generator: Generator<SubscriptionId> = subscriptionIdGenerator();
 
   public subscribe(value: T): UnsubscribeCallback {
     const id = this.generator.next().value;

plugin/src/data/transformations/grouping.ts

@@ -24,7 +24,7 @@ export function groupBy(tasks: Task[], groupBy: GroupVariant): GroupedTasks[] {
     case GroupVariant.Label:
       return groupByLabel(tasks);
     default:
-      throw Error(`Cannot group by ${groupBy}`);
+      throw new Error(`Cannot group by ${groupBy}`);
   }
 }