fix: upgrade typescript + prettier + eslint with a single shared linting config #424

stefl · 2024-12-03T15:23:28Z

Description

Upgrades Typescript to latest
Upgrades Eslint to latest
Moves all config to a shared eslint-config package
Uses the new Eslint config format

We primarily use Typescript, some ESM, and an occasional CommonJS file. So this makes TS the preferred format, ESM the secondary and CommonJS a tertiary format.

To write JS code, name your file with the .mjs extension.
To write code with CommonJS you will need to use the .cjs extension.

Linting rules will now apply to each type of file, and we can specify rules that apply generally, or specifically for certain types of file.

How to review

Pull the branch down locally
Restart your editor
Make changes to a file / break something
Make sure that linting is performant and you get feedback as expected
Fix the issue
Make sure you get feedback quickly that the error is resolved

vercel · 2024-12-03T15:23:33Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
oak-ai-lesson-assistant	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 3, 2024 8:08pm

stefl · 2024-12-03T17:14:33Z

apps/nextjs/package.json

-    "ts-jest": "^29.1.4",
-    "typescript": "5.3.3",
+    "ts-jest": "^29.2.5",
+    "typescript": "5.7.2",


Bumps Typescript to latest

stefl · 2024-12-03T17:15:04Z

apps/nextjs/src/components/AppComponents/Chat/chat-message/index.tsx

@@ -1,6 +1,6 @@
 // Inspired by Chatbot-UI and modified to fit the needs of this project
 // @see https://github.com/mckaywrigley/chatbot-ui/blob/main/components/Chat/ChatMessage.tsx
-import type { ReactNode } from "react";
+import type { ReactNode, JSX } from "react";


Global JSX is now deprecated

stefl · 2024-12-03T17:15:45Z

apps/nextjs/tests-e2e/tests/aila-chat/helpers.ts

@@ -21,7 +21,7 @@ export async function waitForStreamingStatusChange(
  await page.waitForFunction(
    ([currentStatus, expectedStatus]) => {
      const statusElement = document.querySelector(
-        // eslint-disable-next-line @typescript-eslint/quotes, quotes
+        // eslint-disable-next-line quotes


@typescript-eslint/quotes is deprecated

stefl · 2024-12-03T17:15:55Z

apps/nextjs/tsconfig.json

@@ -9,11 +9,13 @@
    "incremental": true,
    "esModuleInterop": true,
    "module": "esnext",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",


Move back to Bundler throughout

stefl · 2024-12-03T17:17:02Z

packages/api/package.json

    "type-check": "tsc --noEmit"
  },
+  "eslintConfig": {


Remove the per-project config (for now?) and replace with this config in the package.json for each package

stefl · 2024-12-03T17:17:12Z

packages/api/package.json

  },
  "engines": {
    "node": ">=20.9.0",
    "pnpm": ">=8"
-  }
+  },
+  "type": "module"


Set all packages as type module

stefl · 2024-12-03T18:33:27Z

apps/nextjs/src/app/api/chat/fixtures/FixtureRecordOpenAiClient.ts

@@ -3,7 +3,7 @@ import { createOpenAIClient } from "@oakai/core/src/llm/openai";
 import { aiLogger } from "@oakai/logger";
 import fs from "fs/promises";
 import type OpenAI from "openai";
-import type { ChatCompletionCreateParamsNonStreaming } from "openai/resources";
+import type { ChatCompletionCreateParamsNonStreaming } from "openai/resources/index.mjs";


I'm not sure why we have to do this now. This has changed a few times

stefl · 2024-12-03T18:34:04Z

apps/nextjs/src/lib/hooks/use-sidebar.tsx

  isSidebarOpen: boolean;
  toggleSidebar: () => void;
  isLoading: boolean;
 }

-const SidebarContext = createContext<SidebarContext | undefined>(undefined);
+const SidebarContext = createContext<SidebarContextValue | undefined>(


The eslint config no longer likes types named the same as code definitions

stefl · 2024-12-03T18:35:40Z

packages/eslint-config/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@oakai/eslint-config",


This makes a new package that matches the same naming convention as the prettier config

stefl · 2024-12-03T18:36:07Z

packages/eslint-config/src/index.mjs

@@ -0,0 +1,140 @@
+import eslint from '@eslint/js';


This is the single source of truth for eslint config. ATM it has all rules for all packages in one file

stefl · 2024-12-03T18:36:27Z

packages/eslint-config/src/plugins.d.ts

@@ -0,0 +1,3 @@
+declare module 'eslint-plugin-import';


These don't have types

stefl · 2024-12-03T18:36:38Z

packages/eslint-config/src/rules.mjs

@@ -0,0 +1,64 @@
+import tsEslint from '@typescript-eslint/eslint-plugin';


Separate out the actual rule definitions

stefl · 2024-12-03T18:37:05Z

packages/eslint-config/src/rules.mjs

+const typescript = tsEslint.configs.recommended;
+
+// @ts-check
+/** @type {Partial<Record<string, import('@typescript-eslint/utils/ts-eslint').SharedConfig.RuleEntry>>} */


I originally had this as a typescript file, but it would have meant having a build step, so this is the next best approach

stefl · 2024-12-03T18:37:27Z

packages/ingest/src/steps/5-lp-parts-embed-start.ts

@@ -78,7 +78,9 @@ export async function lpPartsEmbedStart({
          await prisma.ingestLessonPlanPart.updateMany({
            where: {
              id: {
-                in: lessonPlanPartIds,
+                in: lessonPlanPartIds.filter(


Fixes a linting error

stefl · 2024-12-03T18:37:49Z

packages/prettier-config/package.json

  "devDependencies": {
-    "prettier": "^3.1.1"
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "prettier": "^3.4.1",


Bump prettier to latest

github-actions · 2024-12-03T19:23:16Z

Playwright test results

15 passed
1 skipped

Details

Open report ↗︎
16 tests across 15 suites
2 minutes, 11 seconds
efc69ea

Skipped tests

No persona › tests/auth.test.ts › authenticate through Clerk UI

sonarqubecloud · 2024-12-03T20:05:41Z

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

stefl · 2024-12-03T20:16:08Z

.github/actions/ref_from_sha/test/e2e.cjs

@@ -1,7 +1,7 @@
 const github = require("@actions/github");

-const prFromSha = require("../pr_from_sha");
-const branchFromSha = require("../branch_from_sha");
+const prFromSha = require("../pr_from_sha.cjs");


Potentially we could refactor this all to use ESM but this is the minimal change to get this to work with the new requirement to use .cjs extensions for commonjs code

codeincontext · 2024-12-04T11:07:52Z

apps/nextjs/package.json

  "private": true,
  "scripts": {
    "build": "next build",
    "build:dev": "pnpm with-env next build",
    "check": "tsc --noEmit",
    "clean": "rm -rf .next .turbo node_modules",
-    "dev": "FORCE_COLOR=1 SENTRY_SUPPRESS_TURBOPACK_WARNING=1 pnpm with-env node scripts/increase-listeners.js next dev --port 2525 --turbo | pino-pretty -C",


codeincontext · 2024-12-04T11:08:01Z

apps/nextjs/package.json

@@ -1,26 +1,27 @@
 {
  "name": "@oakai/nextjs",
-  "version": "0.1.0",
+  "version": "1.0.0",


codeincontext

The code looks great to me. I haven't tested it locally yet

codeincontext

Tested and it seems to work very well with Zed (my editor)

oak-machine-user · 2024-12-11T11:29:24Z

🎉 This PR is included in version 1.18.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

stefl added 6 commits October 29, 2024 15:29

Attempt to upgrade ts

43e1eec

Eslint config files

f1f2fd9

Move to esm modules except for the nextjs app

61e2fd7

Merge branch 'main' into fix/eslint_ts

9210246

Next needs to be cjs and everything else esm

18812d2

Move to a single config package for lint

b9ece78

vercel bot had a problem deploying to Preview December 3, 2024 15:27 Failure

stefl added 2 commits December 3, 2024 17:00

Fix nextjs linting errors

b4aa386

Fix linting issues and bugs

ef3f6e1

stefl commented Dec 3, 2024

View reviewed changes

reinstate next image mock

8dd982f

stefl commented Dec 3, 2024

View reviewed changes

vercel bot had a problem deploying to Preview December 3, 2024 17:17 Failure

stefl commented Dec 3, 2024

View reviewed changes

stefl added 3 commits December 3, 2024 18:25

Revert prisma bump

add0c82

Ensure i is string

2067cd7

Delete eslintrc

5b6d0eb

stefl commented Dec 3, 2024

View reviewed changes

vercel bot deployed to Preview December 3, 2024 18:35 View deployment

stefl commented Dec 3, 2024

View reviewed changes

packages/eslint-config/src/plugins.d.ts

@@ -0,0 +1,3 @@

declare module 'eslint-plugin-import';

Copy link

Contributor Author

stefl Dec 3, 2024

Choose a reason for hiding this comment

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

These don't have types

stefl commented Dec 3, 2024

View reviewed changes

Mark github actions as cjs

283bf67

stefl changed the title ~~fix: upgrade eslint, typescript, move to single shared config (WIP)~~ fix: upgrade typescript + prettier + eslint with a single shared linting config Dec 3, 2024

vercel bot deployed to Preview December 3, 2024 18:48 View deployment

Remove stray file

af4ecbc

vercel bot deployed to Preview December 3, 2024 18:53 View deployment

cjs instead of js for action

ad92c5a

vercel bot deployed to Preview December 3, 2024 19:09 View deployment

stefl added 2 commits December 3, 2024 19:14

cjs in imports

f83eab2

Merge remote-tracking branch 'origin/main' into fix/eslint_ts

d0090c7

vercel bot deployed to Preview December 3, 2024 19:18 View deployment

vercel bot deployed to Preview December 3, 2024 19:29 View deployment

Manypackage check

efc69ea

vercel bot deployed to Preview December 3, 2024 20:08 View deployment

stefl requested a review from a team December 3, 2024 20:10

stefl commented Dec 3, 2024

View reviewed changes

codeincontext reviewed Dec 4, 2024

View reviewed changes

apps/nextjs/package.json

@@ -1,26 +1,27 @@

{

"name": "@oakai/nextjs",

"version": "0.1.0",

"version": "1.0.0",

Copy link

Collaborator

codeincontext Dec 4, 2024

Choose a reason for hiding this comment

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

Lovely

codeincontext approved these changes Dec 4, 2024

View reviewed changes

stefl merged commit 1f4aa9d into main Dec 4, 2024
26 checks passed

stefl deleted the fix/eslint_ts branch December 4, 2024 18:18

oak-machine-user added the released label Dec 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: upgrade typescript + prettier + eslint with a single shared linting config #424

fix: upgrade typescript + prettier + eslint with a single shared linting config #424

stefl commented Dec 3, 2024 •

edited

Loading

vercel bot commented Dec 3, 2024 •

edited

Loading

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024 •

edited

Loading

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

stefl Dec 3, 2024

github-actions bot commented Dec 3, 2024 •

edited

Loading

sonarqubecloud bot commented Dec 3, 2024

stefl Dec 3, 2024

codeincontext Dec 4, 2024

codeincontext Dec 4, 2024

codeincontext left a comment

codeincontext left a comment

oak-machine-user commented Dec 11, 2024

		@@ -0,0 +1,64 @@
		import tsEslint from '@typescript-eslint/eslint-plugin';

fix: upgrade typescript + prettier + eslint with a single shared linting config #424

fix: upgrade typescript + prettier + eslint with a single shared linting config #424

Conversation

stefl commented Dec 3, 2024 • edited Loading

Description

How to review

vercel bot commented Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefl Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Dec 3, 2024 • edited Loading

Playwright test results

Details

sonarqubecloud bot commented Dec 3, 2024

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codeincontext left a comment

Choose a reason for hiding this comment

codeincontext left a comment

Choose a reason for hiding this comment

oak-machine-user commented Dec 11, 2024

stefl commented Dec 3, 2024 •

edited

Loading

vercel bot commented Dec 3, 2024 •

edited

Loading

stefl Dec 3, 2024 •

edited

Loading

github-actions bot commented Dec 3, 2024 •

edited

Loading