Merge pull request #682 from xmtp/rygine/eslint

Revamp linting

.changeset/breezy-gorillas-relate.md

@@ -0,0 +1,8 @@
+---
+"@xmtp/content-type-primitives": patch
+"@xmtp/content-type-reaction": patch
+"@xmtp/content-type-read-receipt": patch
+"@xmtp/content-type-remote-attachment": patch
+---
+
+Update `ContentCodec` generic type

.github/workflows/content-types.yml

@@ -35,24 +35,6 @@ jobs:
       - name: Typecheck
         run: yarn turbo run typecheck --filter='./content-types/*'
 
-  lint:
-    name: Lint
-    runs-on: warp-ubuntu-latest-x64-8x
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "yarn"
-        env:
-          SKIP_YARN_COREPACK_CHECK: "1"
-      - name: Enable corepack
-        run: corepack enable
-      - name: Install dependencies
-        run: yarn
-      - name: Lint
-        run: yarn turbo run lint --filter='./content-types/*'
-
   test:
     name: Test
     runs-on: warp-ubuntu-latest-x64-8x

.github/workflows/encryption.yml

@@ -33,24 +33,6 @@ jobs:
       - name: Typecheck
         run: yarn turbo run typecheck --filter='./shared/encryption'
 
-  lint:
-    name: Lint
-    runs-on: warp-ubuntu-latest-x64-8x
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "yarn"
-        env:
-          SKIP_YARN_COREPACK_CHECK: "1"
-      - name: Enable corepack
-        run: corepack enable
-      - name: Install dependencies
-        run: yarn
-      - name: Lint
-        run: yarn turbo run lint --filter='./shared/encryption'
-
   test:
     name: Test
     runs-on: warp-ubuntu-latest-x64-8x

.github/workflows/js-sdk.yml

@@ -35,24 +35,6 @@ jobs:
       - name: Typecheck
         run: yarn turbo run typecheck --filter='./sdks/js-sdk'
 
-  lint:
-    name: Lint
-    runs-on: warp-ubuntu-latest-x64-8x
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "yarn"
-        env:
-          SKIP_YARN_COREPACK_CHECK: "1"
-      - name: Enable corepack
-        run: corepack enable
-      - name: Install dependencies
-        run: yarn
-      - name: Lint
-        run: yarn turbo run lint --filter='./sdks/js-sdk'
-
   test:
     name: Test
     runs-on: warp-ubuntu-latest-x64-8x

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: ESLint
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: warp-ubuntu-latest-x64-8x
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: "yarn"
+        env:
+          SKIP_YARN_COREPACK_CHECK: "1"
+      - name: Enable corepack
+        run: corepack enable
+      - name: Install dependencies
+        run: yarn
+      - name: Lint
+        run: yarn lint

.github/workflows/mls-client.yml

@@ -35,24 +35,6 @@ jobs:
       - name: Typecheck
         run: yarn turbo run typecheck --filter='./sdks/node-sdk'
 
-  lint:
-    name: Lint
-    runs-on: warp-ubuntu-latest-x64-8x
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "yarn"
-        env:
-          SKIP_YARN_COREPACK_CHECK: "1"
-      - name: Enable corepack
-        run: corepack enable
-      - name: Install dependencies
-        run: yarn
-      - name: Lint
-        run: yarn turbo run lint --filter='./sdks/node-sdk'
-
   test:
     name: Test
     runs-on: warp-ubuntu-latest-x64-8x

.github/workflows/noop.yml

@@ -17,8 +17,6 @@ on:
       - "*"
       - "!.node-version"
       - "!.nvmrc"
-      - "!.prettierignore"
-      - "!.prettierrc.cjs"
       - "!.yarnrc.yml"
       - "!turbo.json"
       - "!yarn.lock"
@@ -30,12 +28,6 @@ jobs:
     steps:
       - run: echo "Nothing to typecheck"
 
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    steps:
-      - run: echo "Nothing to lint"
-
   test:
     name: Test
     runs-on: ubuntu-latest

content-types/content-type-primitives/package.json

@@ -45,7 +45,6 @@
     "clean": "yarn clean:dist && rimraf .turbo node_modules",
     "clean:dist": "rimraf dist",
     "dev": "yarn clean:dist && yarn rollup -c --watch",
-    "lint": "eslint . --ignore-path ../../.gitignore",
     "test": "yarn test:node && yarn test:jsdom",
     "test:jsdom": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest run --environment happy-dom",
     "test:node": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest run --environment node",
@@ -70,8 +69,6 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.0",
     "@types/node": "^20.16.11",
-    "eslint": "^8.57.0",
-    "eslint-config-custom": "workspace:*",
     "happy-dom": "^15.7.4",
     "rimraf": "^6.0.1",
     "rollup": "^4.24.0",

content-types/content-type-primitives/src/index.ts

@@ -45,12 +45,21 @@ export type EncodedContent<Parameters = Record<string, string>> = {
   content: Uint8Array;
 };
 
-export type ContentCodec<T = any> = {
+export type ContentCodec<
+  ContentType = any,
+  Parameters = Record<string, string>,
+> = {
   contentType: ContentTypeId;
-  encode(content: T, registry: CodecRegistry<T>): EncodedContent;
-  decode(content: EncodedContent, registry: CodecRegistry<T>): T;
-  fallback(content: T): string | undefined;
-  shouldPush: (content: T) => boolean;
+  encode(
+    content: ContentType,
+    registry: CodecRegistry<ContentType>,
+  ): EncodedContent<Parameters>;
+  decode(
+    content: EncodedContent<Parameters>,
+    registry: CodecRegistry<ContentType>,
+  ): ContentType;
+  fallback(content: ContentType): string | undefined;
+  shouldPush: (content: ContentType) => boolean;
 };
 
 /**

content-types/content-type-primitives/tsconfig.json

@@ -1,5 +1,4 @@
 {
   "extends": "tsconfig/build.json",
-  "include": ["src"],
-  "exclude": ["dist", "node_modules"]
+  "include": ["src", "rollup.config.js"]
 }

content-types/content-type-reaction/package.json

@@ -45,7 +45,6 @@
     "clean": "yarn clean:dist && rimraf .turbo node_modules",
     "clean:dist": "rimraf dist",
     "dev": "yarn clean:dist && yarn rollup -c --watch",
-    "lint": "eslint . --ignore-path ../../.gitignore",
     "test": "yarn test:node && yarn test:jsdom",
     "test:jsdom": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest run --environment happy-dom",
     "test:node": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest run --environment node",
@@ -72,8 +71,6 @@
     "@types/node": "^20.16.11",
     "@xmtp/xmtp-js": "^11.6.3",
     "buffer": "^6.0.3",
-    "eslint": "^8.57.0",
-    "eslint-config-custom": "workspace:*",
     "ethers": "^6.11.1",
     "happy-dom": "^15.7.4",
     "rimraf": "^6.0.1",

content-types/content-type-reaction/src/Reaction.ts

@@ -36,19 +36,22 @@ export type Reaction = {
   schema: "unicode" | "shortcode" | "custom";
 };
 
-type LegacyReactionParameters = Pick<
+export type LegacyReactionParameters = Pick<
   Reaction,
   "action" | "reference" | "schema"
 > & {
   encoding: "UTF-8";
 };
 
-export class ReactionCodec implements ContentCodec<Reaction> {
+export class ReactionCodec
+  implements
+    ContentCodec<Reaction, LegacyReactionParameters | Record<string, never>>
+{
   get contentType(): ContentTypeId {
     return ContentTypeReaction;
   }
 
-  encode(reaction: Reaction): EncodedContent {
+  encode(reaction: Reaction) {
     const { action, reference, referenceInboxId, schema, content } = reaction;
     return {
       type: this.contentType,
@@ -65,20 +68,20 @@ export class ReactionCodec implements ContentCodec<Reaction> {
     };
   }
 
-  decode(encodedContent: EncodedContent): Reaction {
+  decode(encodedContent: EncodedContent<LegacyReactionParameters>): Reaction {
     const decodedContent = new TextDecoder().decode(encodedContent.content);
 
     // First try to decode it in the canonical form.
     try {
       const reaction = JSON.parse(decodedContent) as Reaction;
       const { action, reference, referenceInboxId, schema, content } = reaction;
       return { action, reference, referenceInboxId, schema, content };
-    } catch (e) {
+    } catch {
       // ignore, fall through to legacy decoding
     }
 
     // If that fails, try to decode it in the legacy form.
-    const parameters = encodedContent.parameters as LegacyReactionParameters;
+    const parameters = encodedContent.parameters;
     return {
       action: parameters.action,
       reference: parameters.reference,

content-types/content-type-reaction/src/index.ts

@@ -1,2 +1 @@
-export { ReactionCodec, ContentTypeReaction } from "./Reaction";
-export type { Reaction } from "./Reaction";
+export * from "./Reaction";

content-types/content-type-reaction/tsconfig.json

@@ -1,5 +1,4 @@
 {
   "extends": "tsconfig/build.json",
-  "include": ["src"],
-  "exclude": ["dist", "node_modules"]
+  "include": ["src", "rollup.config.js", "vitest.config.ts", "vitest.setup.ts"]
 }

content-types/content-type-read-receipt/package.json

@@ -45,7 +45,6 @@
     "clean": "yarn clean:dist && rimraf .turbo node_modules",
     "clean:dist": "rimraf dist",
     "dev": "yarn clean:dist && yarn rollup -c --watch",
-    "lint": "eslint . --ignore-path ../../.gitignore",
     "test": "yarn test:node && yarn test:jsdom",
     "test:jsdom": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest run --environment happy-dom",
     "test:node": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest run --environment node",
@@ -72,8 +71,6 @@
     "@types/node": "^20.16.11",
     "@xmtp/xmtp-js": "^11.6.3",
     "buffer": "^6.0.3",
-    "eslint": "^8.57.0",
-    "eslint-config-custom": "workspace:*",
     "ethers": "^6.11.1",
     "happy-dom": "^15.7.4",
     "rimraf": "^6.0.1",

content-types/content-type-read-receipt/src/ReadReceipt.ts

@@ -1,7 +1,6 @@
 import {
   ContentTypeId,
   type ContentCodec,
-  type EncodedContent,
 } from "@xmtp/content-type-primitives";
 
 export const ContentTypeReadReceipt = new ContentTypeId({
@@ -13,12 +12,16 @@ export const ContentTypeReadReceipt = new ContentTypeId({
 
 export type ReadReceipt = Record<string, never>;
 
-export class ReadReceiptCodec implements ContentCodec<ReadReceipt> {
+export type ReadReceiptParameters = Record<string, never>;
+
+export class ReadReceiptCodec
+  implements ContentCodec<ReadReceipt, ReadReceiptParameters>
+{
   get contentType(): ContentTypeId {
     return ContentTypeReadReceipt;
   }
 
-  encode(): EncodedContent {
+  encode() {
     return {
       type: ContentTypeReadReceipt,
       parameters: {},

content-types/content-type-read-receipt/src/index.ts

@@ -1,2 +1 @@
-export { ReadReceiptCodec, ContentTypeReadReceipt } from "./ReadReceipt";
-export type { ReadReceipt } from "./ReadReceipt";
+export * from "./ReadReceipt";

content-types/content-type-read-receipt/tsconfig.json

@@ -1,5 +1,4 @@
 {
   "extends": "tsconfig/build.json",
-  "include": ["src"],
-  "exclude": ["dist", "node_modules"]
+  "include": ["src", "rollup.config.js", "vitest.config.ts", "vitest.setup.ts"]
 }