Add linting and format checks

.github/actions/setup/action.yaml

@@ -0,0 +1,24 @@
+name: 'Setup Action'
+description: 'Checks out the repo, sets up node, and installs dependencies'
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout repository
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+    - name: Set up Node.js
+      uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+      with:
+        node-version: '22'
+
+    - name: Cache dependencies
+      id: cache
+      uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
+      with:
+        path: ./node_modules
+        key: modules-${{ hashFiles('package-lock.json') }}
+
+    - name: Install dependencies
+      if: steps.cache.outputs.cache-hit != 'true'
+      run: npm ci
+      shell: bash

.github/dependabot.yaml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    groups:
+      docusaurus:
+        patterns:
+          - '*docusaurus*'
+    ignore:
+      # Pin key docusaurus dependencies to major versions
+      - dependency-name: '@mdx-js/react'
+        update-types: ['version-update:semver-major']
+      - dependency-name: 'prism-react-renderer'
+        update-types: ['version-update:semver-major']
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'

.github/workflows/_static-checks.yaml

@@ -0,0 +1,37 @@
+name: Static checks
+
+on:
+  workflow_call:
+
+jobs:
+  lint:
+    name: Lint and format checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Run ESLint
+        run: npm run eslint
+
+      - name: Run markdownlint
+        run: npm run markdownlint
+
+      - name: Run Prettier
+        run: npm run prettier
+
+  build:
+    name: Build site
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Build site
+        run: npm run build

.github/workflows/on-pr.yaml

@@ -0,0 +1,13 @@
+name: On PR
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  static-checks:
+    name: Static checks
+    uses: ./.github/workflows/_static-checks.yaml
+    secrets: inherit

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.lintstagedrc

@@ -0,0 +1,5 @@
+{
+  "*.{js,jsx,ts,tsx,mjs,cjs}": ["npx prettier --write", "npx eslint --fix"],
+  "*.md": ["npx prettier --write", "npx markdownlint-cli2 --fix"],
+  "*.css": ["npx prettier --write"]
+}

.markdownlint.json

@@ -0,0 +1,35 @@
+{
+  "heading-style": {
+    "style": "atx"
+  },
+  "ul-style": {
+    "style": "dash"
+  },
+  "line-length": {
+    "line_length": 80,
+    "code_blocks": false,
+    "tables": false
+  },
+  "hr-style": {
+    "style": "---"
+  },
+  "proper-names": {
+    "names": ["CodeGate", "Copilot", "GitHub"],
+    "code_blocks": false
+  },
+  "code-block-style": {
+    "style": "fenced"
+  },
+  "code-fence-style": {
+    "style": "backtick"
+  },
+  "emphasis-style": {
+    "style": "underscore"
+  },
+  "strong-style": {
+    "style": "asterisk"
+  },
+  "table-pipe-style": {
+    "style": "leading_and_trailing"
+  }
+}

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "jsxSingleQuote": true,
+  "printWidth": 80,
+  "proseWrap": "always",
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "useTabs": false
+}

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "unifiedjs.vscode-mdx",
+    "esbenp.prettier-vscode",
+    "davidanson.vscode-markdownlint"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "mdx.validate.validateFileLinks": "warning",
+  "mdx.validate.validateFragmentLinks": "warning",
+  "mdx.validate.validateMarkdownFileLinkFragments": "warning",
+  "mdx.validate.validateReferences": "warning",
+  "mdx.validate.validateUnusedLinkDefinitions": "hint",
+  "prettier.configPath": ".prettierrc",
+  "prettier.requireConfig": true,
+  "yaml.format.proseWrap": "always",
+
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[mdx]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

docs/about/changelog.md

@@ -5,8 +5,8 @@ sidebar_position: 20
 ---
 
 - **UI port change** - 7 Jan, 2025\
-  The internal port for the dashboard UI has changed from 80 to 9090 to resolve a
-  permissions issue for Linux users.
+  The internal port for the dashboard UI has changed from 80 to 9090 to resolve
+  a permissions issue for Linux users.
 
 - **Introducing CodeGate** - 17 Dec, 2024\
   Initial public launch of CodeGate!

docs/about/contributing.md

@@ -20,7 +20,7 @@ process outlined in the project's
 ## Creating GitHub issues
 
 GitHub issues are used to track feature requests and bug reports. If you have a
-general usage question, please ask in the #codegate channel on
+general usage question, please ask in the `#codegate` channel on
 [Discord](https://discord.gg/stacklok). To report a bug or request a feature,
 create a new issue in the
 [CodeGate GitHub repository](https://github.com/stacklok/codegate/issues).

docs/how-to/use-with-continue.mdx

@@ -287,8 +287,8 @@ option, best suited to quick experimentation with various coding models.
 To use this provider, download your desired model file in GGUF format from the
 [Hugging Face library](https://huggingface.co/models?library=gguf&sort=trending).
 Then copy it into the `/app/codegate_volume/models` directory in the CodeGate
-container. To persist models between restarts, run CodeGate with a Docker
-volume as shown in the [recommended configuration](./install.md#recommended-settings).
+container. To persist models between restarts, run CodeGate with a Docker volume
+as shown in the [recommended configuration](./install.md#recommended-settings).
 
 Example using huggingface-cli to download our recommended models for chat (at
 least a 7B model is recommended for best results) and autocomplete (a 1.5B or 3B

docs/partials/_remove-cert.mdx

@@ -18,7 +18,8 @@ Certificates in the CurrentUser\Root certificate store must be deleted from the
 GUI.
 
 1. In the Start menu, search for **Manage User Certificates** or run
-   (<kbd>Win</kbd>+<kbd>R</kbd>) `certmgr.msc` to open the user certificate store
+   (<kbd>Win</kbd>+<kbd>R</kbd>) `certmgr.msc` to open the user certificate
+   store
 1. Navigate to **Trusted Root Certification Authorities** → **Certificates**
 1. Delete the "CodeGate CA" certificate
 

docs/quickstart-copilot.mdx

@@ -7,8 +7,6 @@ id: quickstart
 slug: /quickstart
 ---
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import ThemedImage from '@theme/ThemedImage';
 

docusaurus.config.ts

@@ -138,16 +138,16 @@ const config: Config = {
           title: 'Links',
           items: [
             {
-              html: '<a href="https://www.stacklok.com" target="_blank" class="navbar__link header-stacklok-link"">&nbsp;&nbsp;Stacklok</a>'
+              html: '<a href="https://www.stacklok.com" target="_blank" class="navbar__link header-stacklok-link"">&nbsp;&nbsp;Stacklok</a>',
             },
             {
-              html: '<a href="https://youtube.com/@stacklok" target="_blank" class="navbar__link header-youtube-link"">&nbsp;&nbsp;YouTube</a>'
+              html: '<a href="https://youtube.com/@stacklok" target="_blank" class="navbar__link header-youtube-link"">&nbsp;&nbsp;YouTube</a>',
             },
             {
-              html: '<a href="https://github.com/stacklok/codegate" target="_blank" class="navbar__link header-github-link">&nbsp;&nbsp;GitHub</a>'
+              html: '<a href="https://github.com/stacklok/codegate" target="_blank" class="navbar__link header-github-link">&nbsp;&nbsp;GitHub</a>',
             },
             {
-              html: '<a href="https://discord.gg/stacklok" target="_blank" class="navbar__link header-discord-link">&nbsp;&nbsp;Discord</a>'
+              html: '<a href="https://discord.gg/stacklok" target="_blank" class="navbar__link header-discord-link">&nbsp;&nbsp;Discord</a>',
             },
           ],
         },
@@ -180,7 +180,7 @@ const config: Config = {
       theme: { light: 'neutral', dark: 'dark' },
       options: {
         themeVariables: {
-          fontFamily: 'Figtree, system-ui, sans-serif'
+          fontFamily: 'Figtree, system-ui, sans-serif',
         },
       },
     },

eslint.config.mjs

@@ -0,0 +1,35 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import pluginReact from 'eslint-plugin-react';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import * as mdx from 'eslint-plugin-mdx';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  { ignores: ['.docusaurus/', 'build/', 'node_modules/'] },
+  { files: ['**/*.{js,mjs,cjs,ts,jsx,tsx}'] },
+  { languageOptions: { globals: globals.node } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  pluginReact.configs.flat.recommended,
+  eslintConfigPrettier,
+  {
+    ...mdx.flat,
+    processor: mdx.createRemarkProcessor({
+      lintCodeBlocks: false,
+      languageMapper: {},
+    }),
+    rules: {
+      ...mdx.flat.rules,
+      'react/no-unescaped-entities': 'off',
+    },
+  },
+  {
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  },
+];