added formatting and linting to docs

Author: ndbroadbent

.github/workflows/docs.yml

@@ -23,13 +23,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Wait for required checks
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const script = require('./.github/wait-for-checks.js');
-            await script({ github, context, core });
-
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
@@ -43,6 +36,19 @@ jobs:
       - name: Install dependencies
         run: cd docs && pnpm install
 
+      - name: Check formatting
+        run: cd docs && pnpm format:check
+
+      - name: Lint code
+        run: cd docs && pnpm lint
+
+      - name: Wait for required checks
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const script = require('./.github/wait-for-checks.js');
+            await script({ github, context, core });
+
       - name: Build with Astro
         run: cd docs && pnpm build
 

docs/.prettierignore

@@ -0,0 +1,7 @@
+dist/
+node_modules/
+.astro/
+pnpm-lock.yaml
+package-lock.json
+*.min.js
+*.min.css

docs/.prettierrc.json

@@ -0,0 +1,25 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "proseWrap": "preserve",
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    },
+    {
+      "files": ["*.md", "*.mdx"],
+      "options": {
+        "proseWrap": "always",
+        "printWidth": 80
+      }
+    }
+  ]
+}

docs/CLAUDE.md

@@ -4,9 +4,11 @@
 
 ### Never Use H1 Headers in Content
 
-**NEVER** start MDX pages with an H1 (`# Header`) - Starlight automatically generates the H1 from the frontmatter `title`.
+**NEVER** start MDX pages with an H1 (`# Header`) - Starlight automatically
+generates the H1 from the frontmatter `title`.
 
 ❌ **Wrong:**
+
 ```mdx
 ---
 title: MCP Server Configuration
@@ -18,6 +20,7 @@ Content here...
 ```
 
 ✅ **Correct:**
+
 ```mdx
 ---
 title: MCP Server Configuration
@@ -31,16 +34,31 @@ Content here starts immediately, or with H2 (## Section)
 Always import Starlight components at the top:
 
 ```mdx
-import { Card, CardGrid, LinkCard, Tabs, TabItem, Steps, Code, Aside } from '@astrojs/starlight/components';
+import {
+  Card,
+  CardGrid,
+  LinkCard,
+  Tabs,
+  TabItem,
+  Steps,
+  Code,
+  Aside,
+} from '@astrojs/starlight/components';
+
+;
 ```
 
 ### Best Practices
 
-1. **Structure**: Start content immediately after frontmatter, use H2 for main sections
-2. **Components**: Use `<Steps>` for numbered procedures, `<Tabs>` for platform-specific content
-3. **Cards**: Don't overuse CardGrid - simple lists are often better for readability
+1. **Structure**: Start content immediately after frontmatter, use H2 for main
+   sections
+2. **Components**: Use `<Steps>` for numbered procedures, `<Tabs>` for
+   platform-specific content
+3. **Cards**: Don't overuse CardGrid - simple lists are often better for
+   readability
 4. **Code blocks**: Use proper language tags for syntax highlighting
-5. **Links**: Use LinkCard for prominent external links, regular markdown links for inline references
+5. **Links**: Use LinkCard for prominent external links, regular markdown links
+   for inline references
 
 ### Common Components
 
@@ -70,6 +88,7 @@ description: Brief description for SEO and navigation
 ### Preview Formats
 
 When showing renamify CLI output, use the appropriate format:
+
 - `summary` - For AI agents (structured, minimal)
 - `table` - For human-readable overviews
 - `diff` - For detailed change previews
@@ -78,12 +97,14 @@ When showing renamify CLI output, use the appropriate format:
 ### Testing Guidelines
 
 - Always use `--dry-run` flag when testing renamify commands in docs
-- Use "renamed_renaming_tool" as replacement target in examples (not the alternative protected string)
+- Use "renamed_renaming_tool" as replacement target in examples (not the
+  alternative protected string)
 - Test all links and ensure they work in the local dev server
 
 ### Sidebar Configuration
 
 - Keep sidebar items concise and well-organized
-- Use autogenerate for large directories: `autogenerate: { directory: "commands" }`
+- Use autogenerate for large directories:
+  `autogenerate: { directory: "commands" }`
 - Group related items under clear labels
 - Put most important sections (like MCP Server) near the top

docs/README.md

@@ -1,6 +1,7 @@
 # Renamify Documentation Site
 
-This directory contains the Renamify documentation website built with [Starlight](https://starlight.astro.build).
+This directory contains the Renamify documentation website built with
+[Starlight](https://starlight.astro.build).
 
 ## 📖 Documentation Structure
 
@@ -28,12 +29,14 @@ The documentation is automatically built and deployed from the `main` branch.
 
 ## 📝 Content
 
-Documentation content is written in Markdown/MDX and located in `src/content/docs/`. The site includes:
+Documentation content is written in Markdown/MDX and located in
+`src/content/docs/`. The site includes:
 
 - Getting started guides
 - CLI command reference
 - Configuration examples
 - Live demo with self-hosting testing
 - Real-world case studies
 
-Visit the live documentation at https://docspring.github.io/renamify/ to learn more about Renamify.
+Visit the live documentation at https://docspring.github.io/renamify/ to learn
+more about Renamify.

docs/astro.config.mjs

@@ -1,112 +1,114 @@
 // @ts-check
-import { defineConfig } from "astro/config";
-import starlight from "@astrojs/starlight";
-import starlightImageZoom from "starlight-image-zoom";
+
+import starlight from '@astrojs/starlight';
+import { defineConfig } from 'astro/config';
+import starlightImageZoom from 'starlight-image-zoom';
 
 // https://astro.build/config
 export default defineConfig({
-  site: "https://docspring.github.io",
-  base: "/renamify",
+  site: 'https://docspring.github.io',
+  base: '/renamify',
 
   integrations: [
     starlight({
-      title: "Renamify",
+      title: 'Renamify',
       description:
-        "Smart search & replace for code and files with case-aware transformations",
+        'Smart search & replace for code and files with case-aware transformations',
       logo: {
-        src: "./src/assets/logo.svg",
+        src: './src/assets/logo.svg',
       },
-      customCss: [
-        "./src/styles/custom.css",
-      ],
+      customCss: ['./src/styles/custom.css'],
       editLink: {
-        baseUrl: "https://github.com/DocSpring/renamify/edit/main/docs",
+        baseUrl: 'https://github.com/DocSpring/renamify/edit/main/docs',
       },
       plugins: [starlightImageZoom()],
       components: {
-        Footer: "./src/components/Footer.astro",
+        Footer: './src/components/Footer.astro',
       },
       social: [
         {
-          icon: "github",
-          label: "GitHub",
-          href: "https://github.com/DocSpring/renamify",
+          icon: 'github',
+          label: 'GitHub',
+          href: 'https://github.com/DocSpring/renamify',
         },
       ],
       sidebar: [
         {
-          label: "Getting Started",
+          label: 'Getting Started',
           items: [
-            { label: "Installation", slug: "installation" },
-            { label: "Self-Hosting Demo", slug: "self-hosting-demo" },
-            { label: "Quick Start", slug: "quick-start" },
+            { label: 'Installation', slug: 'installation' },
+            { label: 'Self-Hosting Demo', slug: 'self-hosting-demo' },
+            { label: 'Quick Start', slug: 'quick-start' },
             {
-              label: "Rename vs. Replace",
-              slug: "rename-vs-replace",
+              label: 'Rename vs. Replace',
+              slug: 'rename-vs-replace',
             },
-            { label: "FAQ", link: "/#frequently-asked-questions" },
+            { label: 'FAQ', link: '/#frequently-asked-questions' },
           ],
         },
         {
-          label: "Features",
+          label: 'Features',
           items: [
             {
-              label: "Case-Aware Transformations",
-              slug: "features/case-transformations",
+              label: 'Case-Aware Transformations',
+              slug: 'features/case-transformations',
+            },
+            {
+              label: 'File and Directory Renaming',
+              slug: 'features/file-renaming',
             },
+            { label: 'Safety Features', slug: 'features/safety' },
+            { label: 'Filtering and Ignore Rules', slug: 'features/filtering' },
             {
-              label: "File and Directory Renaming",
-              slug: "features/file-renaming",
+              label: 'Resolving Case Ambiguity',
+              slug: 'features/ambiguity-resolution',
             },
-            { label: "Safety Features", slug: "features/safety" },
-            { label: "Filtering and Ignore Rules", slug: "features/filtering" },
-            { label: "Resolving Case Ambiguity", slug: "features/ambiguity-resolution" },
           ],
         },
         {
-          label: "MCP Server",
+          label: 'MCP Server',
           items: [
-            { label: "Overview", slug: "mcp/overview" },
-            { label: "Installation", slug: "mcp/installation" },
-            { label: "Configuration", slug: "mcp/configuration" },
-            { label: "Tools Reference", slug: "mcp/tools" },
-            { label: "Usage Examples", slug: "mcp/examples" },
-            { label: "AI Agent Guide", slug: "mcp/ai-guide" },
+            { label: 'Overview', slug: 'mcp/overview' },
+            { label: 'Installation', slug: 'mcp/installation' },
+            { label: 'Configuration', slug: 'mcp/configuration' },
+            { label: 'Tools Reference', slug: 'mcp/tools' },
+            { label: 'Usage Examples', slug: 'mcp/examples' },
+            { label: 'AI Agent Guide', slug: 'mcp/ai-guide' },
           ],
         },
         {
-          label: "VS Code Extension",
-          items: [{ label: "Overview", slug: "vscode/overview" }],
+          label: 'VS Code Extension',
+          items: [{ label: 'Overview', slug: 'vscode/overview' }],
         },
         {
-          label: "Commands",
+          label: 'Commands',
           items: [
-            { label: "init", slug: "commands/init" },
-            { label: "search", slug: "commands/search" },
-            { label: "rename", slug: "commands/rename" },
-            { label: "replace", slug: "commands/replace" },
-            { label: "plan", slug: "commands/plan" },
-            { label: "apply", slug: "commands/apply" },
-            { label: "dry-run", slug: "commands/dry-run" },
-            { label: "status", slug: "commands/status" },
-            { label: "history", slug: "commands/history" },
-            { label: "undo", slug: "commands/undo" },
-            { label: "redo", slug: "commands/redo" },
+            { label: 'init', slug: 'commands/init' },
+            { label: 'search', slug: 'commands/search' },
+            { label: 'rename', slug: 'commands/rename' },
+            { label: 'replace', slug: 'commands/replace' },
+            { label: 'plan', slug: 'commands/plan' },
+            { label: 'apply', slug: 'commands/apply' },
+            { label: 'dry-run', slug: 'commands/dry-run' },
+            { label: 'status', slug: 'commands/status' },
+            { label: 'history', slug: 'commands/history' },
+            { label: 'undo', slug: 'commands/undo' },
+            { label: 'redo', slug: 'commands/redo' },
           ],
         },
         {
-          label: "Examples",
-          autogenerate: { directory: "examples" },
+          label: 'Examples',
+          autogenerate: { directory: 'examples' },
         },
         {
-          label: "Case Studies",
-          autogenerate: { directory: "case-studies" },
+          label: 'Case Studies',
+          autogenerate: { directory: 'case-studies' },
         },
         {
-          label: "Reference",
+          label: 'Reference',
           items: [
-            { label: "Configuration", slug: "reference/configuration" },
-            { label: "Platform Support", slug: "reference/platform-support" },
+            { label: 'Configuration', slug: 'reference/configuration' },
+            { label: 'Platform Support', slug: 'reference/platform-support' },
           ],
         },
       ],

docs/biome.jsonc

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.2.2/schema.json",
+  "extends": ["ultracite"],
+  "files": {
+    "includes": [
+      "src/**/*.{js,jsx,ts,tsx,mjs}",
+      "*.{js,mjs,ts}",
+      "src/**/*.astro"
+    ]
+  },
+  "linter": {
+    "rules": {
+      "style": {
+        "noMagicNumbers": "off",
+        "useFilenamingConvention": "off"
+      },
+      "suspicious": {
+        "noConsole": "off"
+      }
+    }
+  },
+  "overrides": [
+    {
+      "includes": ["*.astro"],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noUnusedVariables": "off",
+            "noUnusedImports": "off"
+          }
+        }
+      }
+    }
+  ]
+}