Add formatter, linters, typecheck and enforce it all via CI (#33)

* Add formatters

* run formatter

* lint

* Types

* Added wide typecheck

* add CI check

* oopsie

* we can do it

Author: essential-randomness

.github/workflows/ci.yaml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    name: Lint, format, typecheck, build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Format check
+        run: npm run format:check
+
+      - name: Lint
+        run: npm run lint:ci
+
+      - name: Workspace consistency
+        run: npm run sherif
+
+      - name: Typecheck
+        run: npm run typecheck
+
+      - name: Build
+        run: npm run build

astro-alt-text-toolkit/__example__/package.json

@@ -1,8 +1,8 @@
 {
   "name": "example",
-  "type": "module",
   "version": "0.0.1",
   "private": "true",
+  "type": "module",
   "scripts": {
     "dev": "astro dev",
     "build": "astro build",

astro-alt-text-toolkit/__example__/src/components/ImageWithAlt.astro

@@ -33,7 +33,7 @@ const getPathToAltTextMap = (
   },
   altTextModules: {
     [originalPath: string]: string;
-  }
+  },
 ) => {
   const pathToAltTextMap = new Map<string, string>();
   for (const [originalPath, module] of Object.entries(imageModules)) {
@@ -58,7 +58,7 @@ const getFinalSrc = async (image: typeof Astro.props.src) => {
 
 const finalPathToAltTextMap = getPathToAltTextMap(
   imageModules as any,
-  altTextModules as any
+  altTextModules as any,
 );
 
 const alt =

astro-alt-text-toolkit/package.json

@@ -1,10 +1,31 @@
 {
   "name": "@fujocoded/astro-alt-text-toolkit",
   "version": "0.0.1",
+  "private": true,
   "description": "",
-  "main": "dist/index.js",
+  "keywords": [
+    "astro",
+    "astro-integration",
+    "withastro"
+  ],
+  "homepage": "https://github.com/FujoWebDev/fujocoded-plugins#readme",
+  "bugs": {
+    "url": "https://github.com/FujoWebDev/fujocoded-plugins/issues"
+  },
+  "license": "MIT",
+  "author": "FujoCoded LLC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FujoWebDev/fujocoded-plugins.git"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
   "type": "module",
-  "private": true,
+  "main": "dist/index.js",
   "exports": {
     ".": {
       "import": {
@@ -13,33 +34,13 @@
       }
     }
   },
-  "files": [
-    "dist",
-    "LICENSE",
-    "README.md",
-    "package.json"
-  ],
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown --watch",
     "validate": "npx publint",
-    "test": "vitest"
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/FujoWebDev/fujocoded-plugins.git"
-  },
-  "keywords": [
-    "astro",
-    "withastro",
-    "astro-integration"
-  ],
-  "author": "FujoCoded LLC",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/FujoWebDev/fujocoded-plugins/issues"
-  },
-  "homepage": "https://github.com/FujoWebDev/fujocoded-plugins#readme",
   "dependencies": {},
   "devDependencies": {
     "tsdown": "^0.14.1"

astro-alt-text-toolkit/src/_image-service.ts

@@ -34,12 +34,14 @@ const imageService: LocalImageService<AstroConfig["image"]> = {
     };
 
     Object.entries(params).forEach(([param, key]) => {
-      options[key] && searchParams.append(param, options[key].toString());
+      if (options[key]) {
+        searchParams.append(param, options[key].toString());
+      }
     });
 
     const imageEndpoint = path.join(
       import.meta.env.BASE_URL,
-      imageConfig.endpoint.route
+      imageConfig.endpoint.route,
     );
     return `${imageEndpoint}?${searchParams}`;
   },

astro-alt-text-toolkit/src/index.ts

@@ -32,20 +32,20 @@ const showAltTextPopup = (image: HTMLElement) => {
         dialog.open = false;
       }
     },
-    { signal }
+    { signal },
   );
   dialog.addEventListener(
     "close",
     () => {
       dialog.remove();
       controller.abort();
     },
-    { signal }
+    { signal },
   );
 };
 
 const images = Array.from(
-  document.querySelectorAll<HTMLImageElement>(`img[alt]:not(img[alt=""])`)
+  document.querySelectorAll<HTMLImageElement>(`img[alt]:not(img[alt=""])`),
 );
 for (const image of images) {
   addBadgeToImage(image);

astro-alt-text-toolkit/tsconfig.json

@@ -20,8 +20,8 @@
     "declaration": true,
     "allowImportingTsExtensions": true,
     "noEmit": true,
-    "types": ["./src/types.d.ts"]
+    "types": ["vite/client"]
   },
-  "include": ["./src/types.d.ts"],
+  "include": ["./src/**/*"],
   "exclude": ["node_modules"]
 }

astro-ao3-loader/__examples__/works-list/astro.config.mjs

@@ -1,5 +1,5 @@
 // @ts-check
-import { defineConfig } from 'astro/config';
+import { defineConfig } from "astro/config";
 
 // https://astro.build/config
 export default defineConfig({});

astro-ao3-loader/__examples__/works-list/package.json

@@ -1,15 +1,15 @@
 {
   "name": "astro-5",
-  "type": "module",
   "version": "0.0.1",
+  "type": "module",
   "scripts": {
     "dev": "astro dev",
     "build": "astro build",
     "preview": "astro preview",
     "astro": "astro"
   },
   "dependencies": {
-    "astro": "^5.16.9",
-    "@fujocoded/astro-ao3-loader": "file:../.."
+    "@fujocoded/astro-ao3-loader": "file:../..",
+    "astro": "^5.16.9"
   }
-}
+}

astro-ao3-loader/__examples__/works-list/src/content/ao3/series.yaml

@@ -1 +1 @@
-- 1728802
+- 1728802