ci(docs): linter bump version + expand scope (#30860)

supabase · Dec 4, 2024 · 4cecae1 · 4cecae1
1 parent 0ecd244
commit 4cecae1
Show file tree

Hide file tree

Showing 23 changed files with 462 additions and 160 deletions.
diff --git a/.github/workflows/docs-lint-v2.yml b/.github/workflows/docs-lint-v2.yml
@@ -16,8 +16,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
+          fetch-depth: 0
           sparse-checkout: |
             supa-mdx-lint.config.toml
+            supa-mdx-lint
             apps/docs/content
       - name: cache cargo
         id: cache-cargo
@@ -28,17 +30,21 @@ jobs:
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
-          key: 2d535367b06fe62354035464cf8334929bafca85
+          key: 6435a4cd1eeea7c2bbd343731de7e8a5127cb2d1
       - name: install linter
         if: steps.cache-cargo.outputs.cache-hit != 'true'
-        run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 2d535367b06fe62354035464cf8334929bafca85
+        run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 6435a4cd1eeea7c2bbd343731de7e8a5127cb2d1
       - name: install reviewdog
         uses: reviewdog/action-setup@3f401fe1d58fe77e10d665ab713057375e39b887 # v1.3.0
         with:
           reviewdog_version: v0.20.2
       - name: run linter
         env:
+          BASE_REF: ${{ github.base_ref }}
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           set -o pipefail
-          supa-mdx-lint apps/docs/content/guides/getting-started apps/docs/content/guides/ai apps/docs/content/guides/auth --format rdf | tee >(cat) | reviewdog -f=rdjsonl -reporter=github-pr-review
+          git diff --name-only origin/$BASE_REF HEAD \
+            | grep -E "^apps/docs/content/guides/(getting-started|ai|api|auth|database|deployment|functions)/" \
+            | xargs -r supa-mdx-lint --format rdf \
+            | reviewdog -f=rdjsonl -reporter=github-pr-review
diff --git a/apps/docs/content/guides/auth/auth-captcha.mdx b/apps/docs/content/guides/auth/auth-captcha.mdx
@@ -1,13 +1,13 @@
 ---
 id: 'auth-captcha'
-title: 'Enable Captcha Protection'
-description: 'Add Captcha Protection to your Supabase project'
+title: 'Enable CAPTCHA Protection'
+description: 'Add CAPTCHA Protection to your Supabase project'
 tocVideo: 'em1cpOAXknM'
 ---
 
-Supabase provides you with the option of adding captcha to your sign-in, sign-up, and password reset forms. This keeps your website safe from bots and malicious scripts. Supabase authentication has support for [hCaptcha](https://www.hcaptcha.com/) and [Cloudflare Turnstile](https://www.cloudflare.com/products/turnstile/).
+Supabase provides you with the option of adding CAPTCHA to your sign-in, sign-up, and password reset forms. This keeps your website safe from bots and malicious scripts. Supabase authentication has support for [hCaptcha](https://www.hcaptcha.com/) and [Cloudflare Turnstile](https://www.cloudflare.com/products/turnstile/).
 
-## Sign up for Captcha
+## Sign up for CAPTCHA
 
 <Tabs
   scrollable
@@ -39,13 +39,13 @@ In the Settings page, look for the **Sitekey** section and copy the key.
 </TabPanel>
 </Tabs>
 
-## Enable Captcha protection for your Supabase project
+## Enable CAPTCHA protection for your Supabase project
 
 Navigate to the **[Auth](https://supabase.com/dashboard/project/_/settings/auth)** section of your Project Settings in the Supabase Dashboard and find the **Enable Captcha protection** toggle under Settings > Authentication > Bot and Abuse Protection > Enable Captcha protection.
 
 Select your CAPTCHA provider from the dropdown, enter your Captcha **Secret key**, and click **Save**.
 
-## Add the Captcha frontend component
+## Add the CAPTCHA frontend component
 
 The frontend requires some changes to provide the captcha on-screen for the user. This example uses React and the corresponding Captcha React component, but both Captcha providers can be used with any JavaScript framework.
 

diff --git a/apps/docs/content/guides/database/extensions.mdx b/apps/docs/content/guides/database/extensions.mdx
@@ -54,7 +54,7 @@ In addition to the pre-configured extensions, you can also install your own SQL
 
 </Admonition>
 
-### Upgrade Extensions
+### Upgrade extensions
 
 If a new version of an extension becomes available on Supabase, you need to initiate a software upgrade in the [Infrastructure Settings](https://supabase.com/dashboard/project/_/settings/infrastructure) to access it. Software upgrades can also be initiated by restarting your server in the [General Settings](https://supabase.com/dashboard/project/_/settings/general).
 

diff --git a/apps/docs/content/guides/database/extensions/rum.mdx b/apps/docs/content/guides/database/extensions/rum.mdx
@@ -58,7 +58,7 @@ drop extension if exists rum;
 
 ### Syntax
 
-#### For type: tsvector
+#### For type: `tsvector`
 
 To understand the following you may need first to see [Official PostgreSQL documentation on text
 search](https://www.postgresql.org/docs/current/functions-textsearch.html)
@@ -116,7 +116,7 @@ SELECT id, d, d `<=>` '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER B
 (5 rows)
 ```
 
-#### For type: anyarray
+#### For type: `anyarray`
 
 `rum_anyarray_ops`
 

diff --git a/apps/docs/content/guides/database/postgres/column-level-security.mdx b/apps/docs/content/guides/database/postgres/column-level-security.mdx
@@ -12,7 +12,7 @@ PostgreSQL's [Row Level Security (RLS)](https://www.postgresql.org/docs/current/
   roles.
 </Admonition>
 
-## Policies at the Row Level
+## Policies at the row level
 
 Policies in Row Level Security (RLS) are used to restrict access to rows in a table. Think of them like adding a `WHERE` clause to every query.
 
@@ -35,7 +35,7 @@ update
 
 However, this gives the post owner full access to update the row, including all of the columns.
 
-## Privileges at the Column Level
+## Privileges at the column level
 
 To restrict access to columns, you can use [Privileges](https://www.postgresql.org/docs/current/ddl-priv.html).
 
@@ -80,7 +80,7 @@ You can view and edit the privileges in the [Supabase Studio](https://supabase.c
 
 ![Column level privileges](/docs/img/guides/privileges/column-level-privileges-2.png)
 
-## Manage column privileges in Migrations
+## Manage column privileges in migrations
 
 While you can manage privileges directly from the Dashboard, as your project grows you may want to manage them in your migrations. Read about database migrations in the [Local Development](https://supabase.com/docs/guides/getting-started/local-development#database-migrations) guide.
 

diff --git a/apps/docs/content/guides/database/postgres/roles.mdx b/apps/docs/content/guides/database/postgres/roles.mdx
@@ -46,7 +46,7 @@ When you created your project you were also asked to enter a password. This is a
 
 Changing the password does not result in any downtime. All connected services, such as postgrest, pgbouncer, and other Supabase managed services, are automatically updated to use the latest password to ensure availability. However, if you have any external services connecting to the Supabase database using hardcoded username/password credentials, a manual update will be required.
 
-## Granting Permissions
+## Granting permissions
 
 Roles can be granted various permissions on database objects using the `GRANT` command. Permissions include `SELECT`, `INSERT`, `UPDATE`, and `DELETE`. You can configure access to almost any object inside your database - including tables, views, functions, and triggers.
 

diff --git a/apps/docs/content/guides/database/postgres/timeouts.mdx b/apps/docs/content/guides/database/postgres/timeouts.mdx
@@ -124,9 +124,9 @@ language sql;
 
 The Supabase Dashboard contains tools to help you identify timed-out and long-running queries.
 
-### Using the Log Explorer
+### Using the Logs Explorer
 
-Go to the [Log Explorer](/dashboard/project/_/logs/explorer), and run the following query to identify timed-out events (`statement timeout`) and queries that successfully run for longer than 10 seconds (`duration`).
+Go to the [Logs Explorer](/dashboard/project/_/logs/explorer), and run the following query to identify timed-out events (`statement timeout`) and queries that successfully run for longer than 10 seconds (`duration`).
 
 ```sql
 select

diff --git a/apps/docs/content/guides/database/prisma/prisma-troubleshooting.mdx b/apps/docs/content/guides/database/prisma/prisma-troubleshooting.mdx
@@ -27,6 +27,8 @@ connection_string.../postgres?KEY1=VALUE&KEY2=VALUE&KEY3=VALUE
 
 # Errors
 
+{/* supa-mdx-lint-disable-next-line Rule001HeadingCase */}
+
 ## ... prepared statement already exists
 
 Supavisor in transaction mode (port 6543) does not support [prepared statements](https://www.postgresql.org/docs/current/sql-prepare.html), which Prisma will try to create in the background.
@@ -162,7 +164,7 @@ An alternative strategy to reference these tables is to duplicate values into Pr
 
 <details>
 	<summary>Show/Hide Details</summary>
-  
+
     ```sql table_in_public
     -- Create the 'profiles' table in the 'public' schema
     create table public.profiles (

diff --git a/apps/docs/content/guides/database/query-optimization.mdx b/apps/docs/content/guides/database/query-optimization.mdx
@@ -34,7 +34,7 @@ limit 10;
 
 In this query, there are several parts that indexes could likely help in optimizing the performance:
 
-### `where` Clause:
+### `where` clause:
 
 The `where` clause filters rows based on certain conditions, and indexing the columns involved can improve this process:
 
@@ -47,7 +47,7 @@ create index idx_customers_sign_up_date on customers (sign_up_date);
 create index idx_orders_status on orders (status);
 ```
 
-### `join` Columns
+### `join` columns
 
 Indexes on the columns used for joining tables can help Postgres avoid scanning tables in their entirety when connecting tables.
 
@@ -58,7 +58,7 @@ Indexes on the columns used for joining tables can help Postgres avoid scanning
 create index idx_orders_customer_id on orders (customer_id);
 ```
 
-### `order by` Clause
+### `order by` clause
 
 Sorting can also be optimized by indexing:
 

diff --git a/...s/content/guides/functions/examples/auth-send-email-hook-react-email-resend.mdx b/...s/content/guides/functions/examples/auth-send-email-hook-react-email-resend.mdx
@@ -114,7 +114,7 @@ Deno.serve(async (req) => {
 })
 ```
 
-### 3. Create React Email Templates
+### 3. Create React Email templates
 
 Create a new folder `_templates` and create a new file `magic-link.tsx` with the following code:
 
@@ -296,7 +296,7 @@ supabase secrets set --env-file supabase/functions/.env
 
 That's it, now your Supabase Edge Function will be triggered anytime an Auth Email needs to be send to the user!
 
-## More Resources
+## More resources
 
 - [Send Email Hooks](/docs/guides/auth/auth-hooks/send-email-hook)
 - [Auth Hooks](/docs/guides/auth/auth-hooks)
diff --git a/apps/docs/content/guides/functions/examples/discord-bot.mdx b/apps/docs/content/guides/functions/examples/discord-bot.mdx
@@ -138,7 +138,7 @@ function hexToUint8Array(hex: string) {
 }
 ```
 
-## Deploy the Slash Command handler
+## Deploy the slash command handler
 
 ```bash
 supabase functions deploy discord-bot --no-verify-jwt
@@ -154,7 +154,7 @@ Navigate to your Function details in the Supabase Dashboard to get your Endpoint
 
 The application is now ready. Let's proceed to the next section to install it.
 
-## Install the Slash Command on your Discord server
+## Install the slash command on your Discord server
 
 So to use the `hello` Slash Command, we need to install our Greeter application on our Discord server. Here are the steps:
 

diff --git a/apps/docs/content/guides/functions/examples/push-notifications.mdx b/apps/docs/content/guides/functions/examples/push-notifications.mdx
@@ -18,14 +18,14 @@ Push notifications are an important part of any mobile app. They allow you to se
 
     Find the example code on [GitHub](https://github.com/supabase/supabase/blob/master/examples/user-management/expo-push-notifications/).
 
-    ## Supabase Setup
+    ## Supabase setup
 
     - [Create a new Supabase project](https://database.new).
     - Link your project: `supabase link --project-ref your-supabase-project-ref`
     - Start supabase locally: `supabase start`
     - Push up the schema: `supabase db push` (schema is defined in [supabase/migrations](https://github.com/supabase/supabase/blob/master/examples/user-management/expo-push-notifications/supabase/migrations/))
 
-    ## Expo Setup
+    ## Expo setup
 
     To utilize Expo's push notification service, you must configure your app by installing a set of libraries, implementing functions to handle notifications, and setting up credentials for Android and iOS. Follow the official [Expo Push Notifications Setup Guide](https://docs.expo.dev/push-notifications/push-notifications-setup/) to get the credentials for Android and iOS. This project uses [Expo's EAS build](https://docs.expo.dev/build/introduction/) service to simplify this part.
 
@@ -126,7 +126,7 @@ Push notifications are an important part of any mobile app. They allow you to se
 
     This guide will show you how to send push notifications to your app when a new row is inserted into a table using FCM, Supabase Edge Functions, and database web hooks.
 
-    ## Supabase Setup
+    ## Supabase setup
 
     We will create two tables. One to store the user's FCM token and a `notifications` table. The edge function will be triggered when a new row is inserted into the `notifications` table and sends a push notification to the user.
 
@@ -258,7 +258,7 @@ Push notifications are an important part of any mobile app. They allow you to se
     }
     ```
 
-    ## FCM Setup
+    ## FCM setup
 
     1. Follow the official [FCM Setup Guide](https://firebase.google.com/docs/cloud-messaging) to set up FCM for your client side application.
     1. Generate a new service account private key from the Firebase console `Project Settings > Service Accounts > Generate new private key`.

diff --git a/apps/docs/content/guides/functions/examples/semantic-search.mdx b/apps/docs/content/guides/functions/examples/semantic-search.mdx
@@ -61,7 +61,7 @@ Deno.serve(async (req) => {
 })
 ```
 
-## Create a Postgres Function and RPC
+## Create a Database Function and RPC
 
 With the embeddings now stored in your Postgres database table, you can query them from Supabase Edge Functions by utilizing [Remote Procedure Calls (RPC)](/docs/guides/database/functions?language=js).
 

diff --git a/apps/docs/content/guides/functions/examples/sentry-monitoring.mdx b/apps/docs/content/guides/functions/examples/sentry-monitoring.mdx
@@ -79,7 +79,7 @@ supabase functions deploy sentryfied --no-verify-jwt
 
 Find the complete example on [GitHub](https://github.com/supabase/supabase/tree/master/examples/edge-functions/supabase/functions/sentryfied/index.ts).
 
-## Working With Scopes
+## Working with scopes
 
 Sentry Deno SDK currently do not support `Deno.serve` instrumentation, which means that there is no scope separation between requests.
 Because of that, when the Edge Functions runtime is reused between multiple requests, all globally captured breadcrumbs and contextual data

diff --git a/apps/docs/content/guides/functions/import-maps.mdx b/apps/docs/content/guides/functions/import-maps.mdx
@@ -12,7 +12,7 @@ Developing with Edge Functions is similar to developing with Node.js, but with a
 
 There are two ways to manage your dependencies in Supabase Edge Functions:
 
-### Using deno.json (Recommended)
+### Using deno.json (recommended)
 
 <Admonition type="info">
 
@@ -50,7 +50,7 @@ The recommended file structure when using `deno.json`:
     └── config.toml
 ```
 
-### Using Import Maps (Legacy)
+### Using import maps (legacy)
 
 Import Maps are a legacy way to manage dependencies, similar to a `package.json` file. While still supported, we recommend using `deno.json`. If both exist, `deno.json` takes precedence.
 
@@ -112,15 +112,15 @@ Supabase Edge Functions support several ways to import dependencies:
 - Built-in [Node APIs](https://docs.deno.com/runtime/manual/node/compatibility)
 - Third party modules published to [JSR](https://jsr.io/) or [deno.land/x](https://deno.land/x)
 
-### NPM Modules
+### NPM modules
 
 You can import npm modules using the `npm:` specifier:
 
 ```ts
 import { createClient } from 'npm:@supabase/supabase-js@2'
 ```
 
-### Node.js Built-ins
+### Node.js built-ins
 
 For Node.js built-in APIs, use the `node:` specifier:
 
@@ -130,7 +130,7 @@ import process from 'node:process'
 
 Learn more about npm specifiers and Node built-in APIs in [Deno's documentation](https://docs.deno.com/runtime/manual/node/npm_specifiers).
 
-### Importing from Private Registries
+### Importing from private registries
 
 <Admonition type="info">
 

diff --git a/apps/docs/content/guides/functions/logging.mdx b/apps/docs/content/guides/functions/logging.mdx
@@ -61,9 +61,9 @@ Deno.serve(async (req) => {
 })
 ```
 
-## Logging Tips
+## Logging tips
 
-### Logging Request Headers
+### Logging request headers
 
 When debugging Edge Functions, a common mistake is to try to log headers to the developer console via code like this:
 
@@ -88,7 +88,7 @@ The reason behind this behavior is that [Headers](https://developer.mozilla.org/
 
 However, `Headers` objects are iterable. You can utilize this feature to craft a couple of succinct one-liners for debugging and printing headers.
 
-### Convert headers into an object with Object.fromEntries:
+### Convert headers into an object with `Object.fromEntries`:
 
 You can use `Object.fromEntries` which is a call to convert the headers into an object:
 

diff --git a/apps/docs/content/guides/functions/routing.mdx b/apps/docs/content/guides/functions/routing.mdx
@@ -15,7 +15,7 @@ To combine multiple endpoints into a single Edge Function, you can use web appli
 
 Let's dive into some examples.
 
-## Routing with Frameworks
+## Routing with frameworks
 
 Here's a simple hello world example using some popular web frameworks.
 
@@ -158,7 +158,7 @@ curl --request POST 'https://<project_ref>.supabase.co/functions/v1/hello-world'
 
 We should see a response printing `Hello Foo!`.
 
-## Using Route Parameters
+## Using route parameters
 
 We can use route parameters to capture values at specific URL segments (eg: `/tasks/:taskId/notes/:noteId`).
 
@@ -415,7 +415,7 @@ Deno.serve(async (req) => {
 </TabPanel>
 </Tabs>
 
-## URL Patterns API
+## URL patterns API
 
 If you prefer not to use a web framework, you can directly use [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API) within your Edge Functions to implement routing.
 This is ideal for small apps with only couple of routes and you want to have a custom matching algorithm.

diff --git a/apps/docs/content/guides/functions/status-codes.mdx b/apps/docs/content/guides/functions/status-codes.mdx
@@ -5,6 +5,8 @@ description: 'Edge Functions can return following status codes.'
 subtitle: 'Edge Functions can return following status codes.'
 ---
 
+{/* supa-mdx-lint-disable Rule001HeadingCase */}
+
 ## 2XX Success
 
 A successful Edge Function Response
-Original file line number
+Diff line change
@@ Expand Up / @@ -61,7 +61,7 @@ Deno.serve(async (req) => { @@
     })
     ```
-    ## Create a Postgres Function and RPC
+    ## Create a Database Function and RPC
     With the embeddings now stored in your Postgres database table, you can query them from Supabase Edge Functions by utilizing [Remote Procedure Calls (RPC)](/docs/guides/database/functions?language=js).
@@ Expand Down @@