feat: adding format ci

Author: sriramveeraghanta

.github/workflows/build.yml

@@ -7,6 +7,18 @@ on:
     branches: [preview, master]
 
 jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm format:check
+
   build:
     runs-on: ubuntu-latest
 

.oxfmtrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "printWidth": 120,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "sortPackageJson": false,
+  "ignorePatterns": ["node_modules", "docs/.vitepress/cache", "docs/.vitepress/dist", "pnpm-lock.yaml"]
+}

.prettierignore

@@ -91,7 +91,9 @@ function isExternal(href: string) {
   <div class="px-6 sm:px-12 min-[960px]:px-16 pt-12 pb-24">
     <div class="max-w-[1152px] mx-auto">
       <!-- Explore by Topic -->
-      <h2 class="!text-2xl !font-[640] !mb-6 !mt-0 !border-none !pt-0 tracking-tight text-[var(--vp-c-text-1)]">Explore by Topic</h2>
+      <h2 class="!text-2xl !font-[640] !mb-6 !mt-0 !border-none !pt-0 tracking-tight text-[var(--vp-c-text-1)]">
+        Explore by Topic
+      </h2>
       <div class="grid grid-cols-1 sm:grid-cols-2 min-[960px]:grid-cols-3 gap-4">
         <a
           v-for="topic in topics"
@@ -120,7 +122,9 @@ function isExternal(href: string) {
       </div>
 
       <!-- Get Plane -->
-      <h2 class="!text-2xl !font-[640] !mt-14 !mb-6 !border-none !pt-0 tracking-tight text-[var(--vp-c-text-1)]">Get Plane</h2>
+      <h2 class="!text-2xl !font-[640] !mt-14 !mb-6 !border-none !pt-0 tracking-tight text-[var(--vp-c-text-1)]">
+        Get Plane
+      </h2>
       <div class="grid grid-cols-1 sm:grid-cols-2 gap-5 mb-4">
         <!-- Plane Cloud -->
         <a
@@ -166,7 +170,9 @@ function isExternal(href: string) {
       </div>
 
       <!-- Resources -->
-      <h2 class="!text-2xl !font-[640] !mt-14 !mb-6 !border-none !pt-0 tracking-tight text-[var(--vp-c-text-1)]">Resources</h2>
+      <h2 class="!text-2xl !font-[640] !mt-14 !mb-6 !border-none !pt-0 tracking-tight text-[var(--vp-c-text-1)]">
+        Resources
+      </h2>
       <div class="grid grid-cols-1 sm:grid-cols-3 gap-4">
         <a
           v-for="resource in resources"

.prettierrc

@@ -100,6 +100,7 @@ Automate the creation and management of cycles according to predefined configura
 ![Autoschedule cycles](https://media.docs.plane.so/cycles/auto-schedule-cycles.webp#hero-br)
 
 #### Benefits
+
 - Maintain regular cycle rhythms automatically without manual intervention.
 - Keep future cycles pre-scheduled so teams can plan ahead with confidence.
 - Eliminate repetitive administrative work from cycle creation.

docs/.vitepress/theme/components/HomeLanding.vue

@@ -90,24 +90,24 @@ Unlock advanced filtering with additional operators including `is not`, `is not
 
 Filter work items by their title text to find specific work items.
 
-| Operator | Description | Use case |
-|----------|-------------|----------|
-| `is` | Exact title match | Title is exactly "Login bug" |
-| `is not` | Not exact title match | Title is not "Login bug" |
-| `contains` | Title contains text | Title contains "authentication" |
+| Operator           | Description                 | Use case                            |
+| ------------------ | --------------------------- | ----------------------------------- |
+| `is`               | Exact title match           | Title is exactly "Login bug"        |
+| `is not`           | Not exact title match       | Title is not "Login bug"            |
+| `contains`         | Title contains text         | Title contains "authentication"     |
 | `does not contain` | Title does not contain text | Title does not contain "deprecated" |
 
 ### Milestone
 
 Filter work items by their associated milestone to track progress toward major goals or releases.
 
-| Operator | Description | Use case |
-|----------|-------------|----------|
-| `is` | Exactly this milestone | Items in Q1 Launch milestone |
-| `is any of` | Any of these milestones | In Q1 Launch or Beta Release |
-| `is not` | Not this specific milestone | Not in Q1 Launch |
+| Operator        | Description                    | Use case                         |
+| --------------- | ------------------------------ | -------------------------------- |
+| `is`            | Exactly this milestone         | Items in Q1 Launch milestone     |
+| `is any of`     | Any of these milestones        | In Q1 Launch or Beta Release     |
+| `is not`        | Not this specific milestone    | Not in Q1 Launch                 |
 | `is not any of` | Not in any of these milestones | Not in Q1 Launch or Beta Release |
-| `is empty` | No milestone assigned | Items without any milestone |
+| `is empty`      | No milestone assigned          | Items without any milestone      |
 
 ### Type
 
@@ -146,13 +146,13 @@ View all, active or backlog work items.
 
 Focus on work items assigned to specific team members to track workloads or identify pending tasks.
 
-| Operator | Description | Use case |
-|----------|-------------|----------|
-| `is` | Exactly matches one person | Find work assigned to Sarah |
-| `is any of` | Matches any of multiple people | Show work for the frontend team |
-| `is not` | Excludes one person | Hide items assigned to John |
-| `is not any of` | Excludes multiple people | Not assigned to John or Sarah |
-| `is empty` | No assignee | Unassigned work items |
+| Operator        | Description                    | Use case                        |
+| --------------- | ------------------------------ | ------------------------------- |
+| `is`            | Exactly matches one person     | Find work assigned to Sarah     |
+| `is any of`     | Matches any of multiple people | Show work for the frontend team |
+| `is not`        | Excludes one person            | Hide items assigned to John     |
+| `is not any of` | Excludes multiple people       | Not assigned to John or Sarah   |
+| `is empty`      | No assignee                    | Unassigned work items           |
 
 ### Priority
 
@@ -169,25 +169,25 @@ Filter work items by their priority level (e.g., Urgent, High, Medium, Low) to f
 
 Filter tasks where you or another team member has been mentioned to ensure no critical tasks are missed.
 
-| Operator | Description | Use case |
-|----------|-------------|----------|
-| `is` | Exactly matches one person | Items mentioning Sarah |
-| `is any of` | Matches any of multiple people | Mentioning team leads |
-| `is not` | Excludes one person | Not mentioning John |
-| `is not any of` | Excludes multiple people | Not mentioning John or Sarah |
-| `is empty` | No mentions | Items with no mentions |
+| Operator        | Description                    | Use case                     |
+| --------------- | ------------------------------ | ---------------------------- |
+| `is`            | Exactly matches one person     | Items mentioning Sarah       |
+| `is any of`     | Matches any of multiple people | Mentioning team leads        |
+| `is not`        | Excludes one person            | Not mentioning John          |
+| `is not any of` | Excludes multiple people       | Not mentioning John or Sarah |
+| `is empty`      | No mentions                    | Items with no mentions       |
 
 ### Label
 
 Filter work items based on custom tags, such as "Frontend", or "Marketing".
 
-| Operator | Description | Use case |
-|----------|-------------|----------|
-| `is` | Exact label match | Label exactly "bug" |
-| `is any of` | Matches any of the Labels| frontend or backend |
-| `is not` | Not exact label match | Label not exactly "bug" |
-| `is not any of` | Excludes several labels | Not frontend or backend |
-| `is empty` | No labels | Items without any labels |
+| Operator        | Description               | Use case                 |
+| --------------- | ------------------------- | ------------------------ |
+| `is`            | Exact label match         | Label exactly "bug"      |
+| `is any of`     | Matches any of the Labels | frontend or backend      |
+| `is not`        | Not exact label match     | Label not exactly "bug"  |
+| `is not any of` | Excludes several labels   | Not frontend or backend  |
+| `is empty`      | No labels                 | Items without any labels |
 
 ### Cycle
 
@@ -199,39 +199,39 @@ View work items tied to specific cycles to monitor progress within a timeframe.
 | `is any of`     | Any of these cycles        | In Sprint 23 or 24     |
 | `is not`        | Not this specific cycle    | Not in Sprint 23       |
 | `is not any of` | Not in any of these cycles | Not in Sprint 23 or 24 |
-| `is empty` | No cycle assigned | Items not in any cycle |
+| `is empty`      | No cycle assigned          | Items not in any cycle |
 
 ### Module
 
 Filter work items by their associated module to analyze related tasks together.
 
-| Operator | Description | Use case |
-|----------|-------------|----------|
-| `is` | Exactly this module | Items in Authentication module |
-| `is any of` | Any of these modules | In API development or Data management modules |
-| `is not` | Not this specific module | Not in Authentication module |
-| `is not any of` | Not in any of these modules | Not in API or Data management |
-| `is empty` | No module assigned | Items not in any module |
+| Operator        | Description                 | Use case                                      |
+| --------------- | --------------------------- | --------------------------------------------- |
+| `is`            | Exactly this module         | Items in Authentication module                |
+| `is any of`     | Any of these modules        | In API development or Data management modules |
+| `is not`        | Not this specific module    | Not in Authentication module                  |
+| `is not any of` | Not in any of these modules | Not in API or Data management                 |
+| `is empty`      | No module assigned          | Items not in any module                       |
 
 ### Start date, Due date, Created at, and Updated at
 
 Filter work items by start dates to view tasks that are planned or already in progress, and by target dates to track upcoming deadlines or overdue tasks. For even more flexibility, you can specify a custom date range to focus on a specific timeframe.
 
-| Operator | Description | Use case |
-|----------|-------------|----------|
-| `is` | Exactly this date | Items due today |
-| `is not` | Not this specific date | Not due today |
-| `before` | Earlier than this date | Due before Monday |
-| `not before` | This date or later | Not due before Monday (due Monday or later) |
-| `before or on` | This date or earlier | Due Monday or earlier |
-| `not before or on` | Later than this date | Not due Monday or earlier (due after Monday) |
-| `after` | Later than this date | Due after Friday |
-| `not after` | This date or earlier | Not due after Friday (due Friday or earlier) |
-| `after or on` | This date or later | Due Friday or later |
-| `not after or on` | Earlier than this date | Not due Friday or later (due before Friday) |
-| `between` | Within date range | Due this week |
-| `not between` | Outside date range | Not due this week |
-| `is empty` | No date set | Items without start date or target date |
+| Operator           | Description            | Use case                                     |
+| ------------------ | ---------------------- | -------------------------------------------- |
+| `is`               | Exactly this date      | Items due today                              |
+| `is not`           | Not this specific date | Not due today                                |
+| `before`           | Earlier than this date | Due before Monday                            |
+| `not before`       | This date or later     | Not due before Monday (due Monday or later)  |
+| `before or on`     | This date or earlier   | Due Monday or earlier                        |
+| `not before or on` | Later than this date   | Not due Monday or earlier (due after Monday) |
+| `after`            | Later than this date   | Due after Friday                             |
+| `not after`        | This date or earlier   | Not due after Friday (due Friday or earlier) |
+| `after or on`      | This date or later     | Due Friday or later                          |
+| `not after or on`  | Earlier than this date | Not due Friday or later (due before Friday)  |
+| `between`          | Within date range      | Due this week                                |
+| `not between`      | Outside date range     | Not due this week                            |
+| `is empty`         | No date set            | Items without start date or target date      |
 
 ### Created by
 

docs/core-concepts/cycles.md

@@ -19,6 +19,7 @@ When you visit this URL, Plane authenticates you, redirects to your last active
 ## Build a URL with parameters
 
 Start with the base URL, add `?`, then append parameters in `name=value` format. Separate multiple parameters with `&`.
+
 ```bash
 https://app.plane.so/work-items/new?title=Fix+bug&priority=high&assignee=me
 ```
@@ -160,10 +161,10 @@ https://app.plane.so/work-items/new?title=Implement+dark+mode&description=Add+da
 ## Things to know
 
 - **Authentication required**  
-Users must be logged in. If they're not, Plane redirects them to sign in first, then continues to the work item modal.
-- **Invalid values are ignored**   
-If a project identifier or display name doesn't match an existing record, Plane skips that parameter and processes the rest.
-- **Case doesn't matter**   
-Values like priority and project identifier are case-insensitive.
-- **Users can still edit**   
-Pre-filled values aren't locked. After the modal opens, users can change any field before creating the work item.
+  Users must be logged in. If they're not, Plane redirects them to sign in first, then continues to the work item modal.
+- **Invalid values are ignored**  
+  If a project identifier or display name doesn't match an existing record, Plane skips that parameter and processes the rest.
+- **Case doesn't matter**  
+  Values like priority and project identifier are case-insensitive.
+- **Users can still edit**  
+  Pre-filled values aren't locked. After the modal opens, users can change any field before creating the work item.

docs/core-concepts/issues/visualise_filter.md

@@ -233,8 +233,8 @@ Ensure the correct Redirect URI is configured in your OAuth service:
   ```
 - For GitHub Sign-In: Add the following URL to the Callback URL section in your GitHub OAuth app:
   `bash
-  https://<plane.example.com>/auth/mobile/github/callback/
-  `
+https://<plane.example.com>/auth/mobile/github/callback/
+`
   Verify that the `<plane.example.com>` part of the URL matches your self-hosted instance's domain.
 
 ### Link not opening iOS app

docs/core-concepts/issues/work-item-url.md

@@ -14,7 +14,8 @@
     "dev": "vitepress dev docs",
     "build": "vitepress build docs",
     "preview": "vitepress preview docs",
-    "format": "prettier --write ."
+    "format": "oxfmt",
+    "format:check": "oxfmt --check"
   },
   "dependencies": {
     "lucide-vue-next": "^0.474.0",
@@ -25,8 +26,8 @@
   "devDependencies": {
     "@tailwindcss/postcss": "^4.0.6",
     "autoprefixer": "^10.4.20",
+    "oxfmt": "^0.35.0",
     "postcss": "^8.5.1",
-    "prettier": "^3.6.2",
     "tailwindcss": "^4.0.6"
   },
   "engines": {