Add ESLint and Prettier config (#618)

* add eslint / prettier config

* lint / format

* lint fixes

* lint / format

* package lock

* fix closing tag

* fix closing tags

* fix build

* fix ignore steps

* lint

* fix about receiving

* ignore about erceiving for linting

* Update src/content/docs/developers/about-receiving.mdx

Co-authored-by: Anca Matei <98110730+Anca2022@users.noreply.github.com>

* revert about receiving

* revert aboutreceiving

* devdependency

* fix bulletpoints

* ignore codeblocks

* fix steps

* fix the :::note prettier wrap issue

* lint and format mdx files

* fix lists and rm ignore files

* fix number list

* fix numbered list

* fix lint

* fix about receiving

* rm files from prettier ignor

* fix ::note

* add indented list

* fix notes

* fix code block

* revert type change

* better eslint config

* update package lock

* rm pnpm lock

* consistent eslint to docs design system

* fix lint

* add netlify npm fix

* netlify npm

* Update src/content/docs/publishers/link-tag-tool.mdx

Co-authored-by: Anca Matei <98110730+Anca2022@users.noreply.github.com>

* Update src/content/docs/publishers/link-tag-tool.mdx

Co-authored-by: Anca Matei <98110730+Anca2022@users.noreply.github.com>

* refactor(send-test-payments): replace Steps component with ordered lists for better readability

* fix codeblock

* fix steps and imgs

* fix linkout link

* fix get started

* ci: use npm ci with optional deps

* ci: install rollup linux binary

---------

Co-authored-by: Anca Matei <98110730+Anca2022@users.noreply.github.com>

Author: JonathanMatthey

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci --include=optional
+
+      - name: Run lint (Prettier + ESLint)
+        run: npm run lint
+

.github/workflows/deploy.yml

@@ -20,15 +20,19 @@ jobs:
     steps:
       - name: Checkout your repository using git
         uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
+          cache: npm
 
-      - uses: oven-sh/setup-bun@v1
       - name: Install dependencies
-        run: bun install
+        run: npm ci --include=optional
+      - name: Install Rollup native binary
+        run: |
+          ROLLUP_VERSION=$(node -p "require('./package-lock.json').packages['node_modules/rollup'].optionalDependencies['@rollup/rollup-linux-x64-gnu']")
+          npm install --no-save "@rollup/rollup-linux-x64-gnu@${ROLLUP_VERSION}"
       - name: Test build website
-        run: bun run build
+        run: npm run build
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

.github/workflows/test-build.yml

@@ -13,9 +13,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: oven-sh/setup-bun@v1
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
 
       - name: Install dependencies
-        run: bun install
+        run: npm ci --include=optional
+      - name: Install Rollup native binary
+        run: |
+          ROLLUP_VERSION=$(node -p "require('./package-lock.json').packages['node_modules/rollup'].optionalDependencies['@rollup/rollup-linux-x64-gnu']")
+          npm install --no-save "@rollup/rollup-linux-x64-gnu@${ROLLUP_VERSION}"
       - name: Test build website
-        run: bun run build
+        run: npm run build

.prettierignore

@@ -1,2 +1,11 @@
+# Shared ignores from paymentpointers.org
+.github
+.astro
+node_modules
+public
+dist
+**/*.min.css
+**/*.min.js
+
 # Don't disagree with W3C style on the spec
 src/pages/specification

.prettierrc

@@ -1,5 +1,20 @@
-semi: false
-tabWidth: 2
-jsxSingleQuote: true
-bracketSpacing: true
-singleQuote: true
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "**/*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    },
+    {
+      "files": "**/*.mdx",
+      "options": {
+        "proseWrap": "preserve"
+      }
+    }
+  ]
+}

README.md

@@ -36,13 +36,15 @@ bun install
 
 All commands are run from the root of the project, from a terminal:
 
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `bun run start`           | Starts local dev server at `localhost:1100`      |
-| `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 run start`           | Starts local dev server at `localhost:1100`                |
+| `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 lint`            | Check code formatting and quality with Prettier and ESLint |
+| `bun run format`          | Format code and fix linting issues automatically           |
 
 You can substitute the bun commands with your chosen package manager's commands.