Jm/prettier eslint

.prettierignore

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

.prettierrc

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

README.md

@@ -52,9 +52,20 @@ All commands are run from the root of the project, from a terminal:
 | `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 code and fix linting issues               |
+| `bun run lint`            | Check code formatting and linting                |
 
 You can substitute the `bun` commands with whatever package manager of your choice uses.
 
+### 🔍 Code Formatting
+
+This project uses [ESLint](https://eslint.org/) for code linting and [Prettier](https://prettier.io/) for code formatting. Before submitting a pull request, please ensure your code is properly formatted:
+
+1. **Fix issues**: Run `bun run format` to automatically format code and fix linting issues
+2. **Check before pushing**: Run `bun run lint` to verify everything passes (CI will also run this)
+
+ESLint is configured to work with TypeScript and Astro files. The configuration extends recommended rules from ESLint, TypeScript ESLint, and Astro ESLint plugins, and integrates with Prettier to avoid conflicts.
+
 ### 👀 Want to learn more?
 
 Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

astro.config.mjs

@@ -1,55 +1,61 @@
-import { defineConfig } from "astro/config";
-import starlight from "@astrojs/starlight";
-import starlightLinksValidator from "starlight-links-validator";
-import starlightFullViewMode from "starlight-fullview-mode";
+import { defineConfig } from 'astro/config'
+import starlight from '@astrojs/starlight'
+import starlightLinksValidator from 'starlight-links-validator'
+import starlightFullViewMode from 'starlight-fullview-mode'
 
 // https://astro.build/config
 export default defineConfig({
-  site: "https://paymentpointers.org",
+  site: 'https://paymentpointers.org',
   integrations: [
     starlight({
-      title: "Payment Pointers",
+      title: 'Payment Pointers',
       description:
-        "Payment Pointers are a standardized identifier for payment accounts. In the same way that an email address provides an identifier for a mailbox in the email ecosystem a payment pointer is used by an account holder to share the details of their account with a counter-party.",
+        'Payment Pointers are a standardized identifier for payment accounts. In the same way that an email address provides an identifier for a mailbox in the email ecosystem a payment pointer is used by an account holder to share the details of their account with a counter-party.',
       head: [
         {
-          tag: "script",
+          tag: 'script',
           attrs: {
             defer: true,
-            "data-website-id": "cab4fd0a-e2db-4666-a974-5b199f0d6d43",
-            src: "https://ilf-site-analytics.netlify.app/script.js",
-            "data-domains": "paymentpointers.org",
-          },
-        },
+            'data-website-id': 'cab4fd0a-e2db-4666-a974-5b199f0d6d43',
+            src: 'https://ilf-site-analytics.netlify.app/script.js',
+            'data-domains': 'paymentpointers.org'
+          }
+        }
       ],
       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()],
       components: {
-        Header: "./src/components/Header.astro",
-        PageSidebar: "./src/components/PageSidebar.astro",
+        Header: './src/components/Header.astro',
+        PageSidebar: './src/components/PageSidebar.astro'
       },
       expressiveCode: {
         styleOverrides: {
-          borderColor: "transparent",
-          borderRadius: "var(--border-radius)",
-        },
+          borderColor: 'transparent',
+          borderRadius: 'var(--border-radius)'
+        }
       },
-      social: [{ icon: "github", label: "GitHub", href: "https://github.com/interledger/paymentpointers.org" }],
-      sidebar: [
-        { label: "Explainer", link: "/" },
-        { label: "Design Goals", link: "/goals" },
-        { label: "Flow", link: "/flow" },
-        { label: "Syntax and Resolution", link: "/syntax" },
-        { label: "IANA Considerations", link: "/iana" },
-        { label: "Security Considerations", link: "/security" },
-        { label: "About", link: "/about" },
+      social: [
+        {
+          icon: 'github',
+          label: 'GitHub',
+          href: 'https://github.com/interledger/paymentpointers.org'
+        }
       ],
-    }),
+      sidebar: [
+        { label: 'Explainer', link: '/' },
+        { label: 'Design Goals', link: '/goals' },
+        { label: 'Flow', link: '/flow' },
+        { label: 'Syntax and Resolution', link: '/syntax' },
+        { label: 'IANA Considerations', link: '/iana' },
+        { label: 'Security Considerations', link: '/security' },
+        { label: 'About', link: '/about' }
+      ]
+    })
   ],
   server: {
-    port: 1102,
-  },
-});
+    port: 1102
+  }
+})