Add ESLint and Prettier config

.github/pull_request_template.md

@@ -10,3 +10,7 @@ Provide a succinct description of what this pull request entails.
 What were you trying to do?
 Link issues here -  using `fixes #number`
 -->
+
+## Checklist
+
+- [ ] I have run `bun run format` (or `bun run lint`) to check formatting and linting

.github/workflows/test-build.yml

@@ -16,5 +16,7 @@ jobs:
       - uses: oven-sh/setup-bun@v1
       - name: Install dependencies
         run: bun install
+      - name: Check formatting and linting
+        run: bun run lint
       - name: Test build website
         run: bun run build

.prettierignore

@@ -0,0 +1,8 @@
+.github
+.astro
+node_modules
+public
+dist
+**/*.min.css
+**/*.min.js
+

.prettierrc

@@ -0,0 +1,23 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "**/*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    },
+    {
+      "files": "**/*.mdx",
+      "options": {
+        "parser": "mdx"
+      }
+    }
+  ]
+}
+
+
+

README.md

@@ -39,14 +39,16 @@ curl -fsSL https://bun.sh/install | bash
 
 All commands are run from the root of the project, from a terminal:
 
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `bun install`             | Installs dependencies                            |
-| `bun run start`           | Starts local dev server at `localhost:1105`      |
-| `bun run build`           | Build your production site to `./dist/`          |
-| `bun run preview`         | Preview your build locally, before deploying     |
-| `bun run astro ...`       | Run CLI commands like `astro add`, `astro check` |
-| `bun run astro -- --help` | Get help using the Astro CLI                     |
+| Command                   | Action                                              |
+| :------------------------ | :-------------------------------------------------- |
+| `bun install`             | Installs dependencies                               |
+| `bun run start`           | Starts local dev server at `localhost:1105`         |
+| `bun run build`           | Build your production site to `./dist/`             |
+| `bun run preview`         | Preview your build locally, before deploying        |
+| `bun run astro ...`       | Run CLI commands like `astro add`, `astro check`    |
+| `bun run astro -- --help` | Get help using the Astro CLI                        |
+| `bun run format`          | Format and auto-fix code with Prettier & ESLint     |
+| `bun run lint`            | Check formatting and linting without making changes |
 
 You can substitute the `bun` commands with whatever package manager of your choice uses.
 

astro.config.mjs

@@ -1,75 +1,82 @@
-import { defineConfig } from "astro/config";
-import starlight from "@astrojs/starlight";
-import remarkMath from "remark-math";
-import rehypeMathjax from "rehype-mathjax";
-import starlightLinksValidator from "starlight-links-validator";
-import starlightFullViewMode from "starlight-fullview-mode";
+import { defineConfig } from 'astro/config'
+import starlight from '@astrojs/starlight'
+import remarkMath from 'remark-math'
+import rehypeMathjax from 'rehype-mathjax'
+import starlightLinksValidator from 'starlight-links-validator'
+import starlightFullViewMode from 'starlight-fullview-mode'
 
 // https://astro.build/config
 export default defineConfig({
-  site: "https://interledger.net",
+  site: 'https://interledger.net',
   markdown: {
     remarkPlugins: [remarkMath],
-    rehypePlugins: [rehypeMathjax],
+    rehypePlugins: [rehypeMathjax]
   },
   integrations: [
     starlight({
-      title: "Docs style guide",
-      description: "The style guide for all Interledger documentation sites. Because we love consistency.",
+      title: 'Docs style guide',
+      description:
+        'The style guide for all Interledger documentation sites. Because we love consistency.',
       customCss: [
-        "./node_modules/@interledger/docs-design-system/src/styles/teal-theme.css",
-        "./node_modules/@interledger/docs-design-system/src/styles/ilf-docs.css",
+        './node_modules/@interledger/docs-design-system/src/styles/teal-theme.css',
+        './node_modules/@interledger/docs-design-system/src/styles/ilf-docs.css'
       ],
       plugins: [starlightLinksValidator(), starlightFullViewMode()],
       expressiveCode: {
         styleOverrides: {
-          borderColor: "transparent",
-          borderRadius: "var(--border-radius)",
-        },
+          borderColor: 'transparent',
+          borderRadius: 'var(--border-radius)'
+        }
       },
-      social: [{ icon: "github", label: "GitHub", href: "https://github.com/interledger/docs-styleguide" }],
+      social: [
+        {
+          icon: 'github',
+          label: 'GitHub',
+          href: 'https://github.com/interledger/docs-styleguide'
+        }
+      ],
       components: {
-        Header: "./src/components/Header.astro",
+        Header: './src/components/Header.astro'
       },
       sidebar: [
         {
-          label: "Overview of doc styles",
-          link: "/",
+          label: 'Overview of doc styles',
+          link: '/'
         },
         {
-          label: "Style guides",
+          label: 'Style guides',
           autogenerate: {
-            directory: "content",
-          },
+            directory: 'content'
+          }
         },
         {
-          label: "Classes, styles, HTML, etc",
+          label: 'Classes, styles, HTML, etc',
           autogenerate: {
-            directory: "classes",
-          },
+            directory: 'classes'
+          }
         },
         {
-          label: "Shared Components",
+          label: 'Shared Components',
           autogenerate: {
-            directory: "shared",
-          },
+            directory: 'shared'
+          }
         },
         {
-          label: "Open Payments Components",
+          label: 'Open Payments Components',
           autogenerate: {
-            directory: "oppm",
-          },
+            directory: 'oppm'
+          }
         },
         {
-          label: "Web Monetization Components",
+          label: 'Web Monetization Components',
           autogenerate: {
-            directory: "webm",
-          },
-        },
-      ],
-    }),
+            directory: 'webm'
+          }
+        }
+      ]
+    })
   ],
   server: {
-    port: 1105,
-  },
-});
+    port: 1105
+  }
+})

eslint.config.js

@@ -0,0 +1,30 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+import { defineConfig, globalIgnores } from 'eslint/config'
+import eslintConfigPrettier from 'eslint-config-prettier/flat'
+import eslintPluginAstro from 'eslint-plugin-astro'
+
+export default defineConfig([
+  {
+    files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
+    plugins: { js },
+    extends: ['js/recommended'],
+    languageOptions: { globals: { ...globals.browser, ...globals.node } }
+  },
+  tseslint.configs.recommended,
+  eslintPluginAstro.configs.recommended,
+  globalIgnores(['dist', '.astro', 'node_modules', 'public', '**/*.min.js']),
+  {
+    rules: {
+      'no-console': 'error',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_' }
+      ],
+      '@typescript-eslint/no-explicit-any': 'error',
+      'astro/no-set-text-directive': 'error'
+    }
+  },
+  eslintConfigPrettier
+])

package.json

@@ -6,7 +6,9 @@
     "start": "astro dev",
     "build": "astro build",
     "preview": "astro preview",
-    "astro": "astro"
+    "astro": "astro",
+    "format": "prettier --write '**/*.{js,mjs,ts,tsx,json,md,mdx,astro}' && eslint --max-warnings=0 --fix .",
+    "lint": "prettier --check '**/*.{js,mjs,ts,tsx,json,md,mdx,astro}' && eslint --max-warnings=0 ."
   },
   "dependencies": {
     "@astrojs/starlight": "^0.36.2",
@@ -17,5 +19,17 @@
     "sharp": "^0.34.5",
     "starlight-fullview-mode": "^0.2.6",
     "starlight-links-validator": "^0.19.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@typescript-eslint/parser": "^8.48.0",
+    "astro-eslint-parser": "^1.2.2",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-astro": "^1.5.0",
+    "globals": "^16.5.0",
+    "prettier": "3.6.2",
+    "prettier-plugin-astro": "0.14.1",
+    "typescript-eslint": "^8.48.0"
   }
 }