specra-cli 0.3.0

package/templates/jbrains-docs/docs/v2.0.0/tools/testing.mdx

@@ -0,0 +1,112 @@
+---
+title: Testing
+description: Verify your documentation builds and renders correctly
+sidebar_position: 2
+---
+
+This page covers strategies for testing your documentation site to ensure content renders correctly and the build succeeds.
+
+## Build Verification
+
+The simplest test is to run a production build and check for errors:
+
+<Tabs defaultValue="npm">
+  <Tab label="npm">
+```bash
+npm run build
+```
+  </Tab>
+  <Tab label="yarn">
+```bash
+yarn build
+```
+  </Tab>
+  <Tab label="pnpm">
+```bash
+pnpm build
+```
+  </Tab>
+</Tabs>
+
+The build will fail if:
+- MDX files have syntax errors
+- Frontmatter is malformed
+- Required fields are missing
+
+<Callout type="tip">
+  Run `npm run build` in your CI pipeline to catch documentation errors before they reach production.
+</Callout>
+
+## Type Checking
+
+Verify TypeScript types are correct:
+
+```bash
+npm run check
+```
+
+This catches type errors in your SvelteKit configuration and any custom components.
+
+## Content Checklist
+
+When reviewing documentation changes, verify:
+
+| Check | Description |
+|-------|-------------|
+| **Frontmatter** | All pages have `title`, and key pages have `description` |
+| **Links** | Internal links point to existing pages |
+| **Versions** | Content exists in all active version directories |
+| **Sidebar Order** | `sidebar_position` values create a logical reading flow |
+| **Categories** | Each folder has a `_category_.json` with `label` and `position` |
+
+## Visual Testing
+
+Preview the site locally and check:
+
+<Steps>
+  <Step title="Start Dev Server">
+    Run `npm run dev` and open the site in your browser.
+  </Step>
+
+  <Step title="Check Navigation">
+    Verify sidebar links work, breadcrumbs are correct, and previous/next navigation follows the expected order.
+  </Step>
+
+  <Step title="Check Themes">
+    Toggle between light and dark themes. Ensure all content is readable in both modes.
+  </Step>
+
+  <Step title="Check Responsive">
+    Test on different viewport sizes. The mobile sidebar should collapse into a menu.
+  </Step>
+</Steps>
+
+## Common Issues
+
+### Frontmatter Parsing Errors
+
+```
+Error: Invalid frontmatter in docs/v2.0.0/page.mdx
+```
+
+Ensure your frontmatter uses valid YAML syntax and is enclosed by `---` delimiters.
+
+### Missing Pages
+
+If a page doesn't appear in the sidebar:
+
+1. Check the file has the `.mdx` extension (not `.md`)
+2. Verify the file is in the correct version directory
+3. Check if `draft: true` is set in frontmatter
+
+### Broken Links
+
+If internal links return 404:
+
+1. Check the path matches the file structure
+2. Include the version prefix: `/docs/v2.0.0/page-name`
+3. Use the file's slug (filename without `.mdx`), not the title
+
+<Callout type="info">
+  The dev server shows detailed error messages in the browser overlay. Check the terminal output for build-time errors.
+</Callout>

package/templates/jbrains-docs/gitignore

@@ -0,0 +1,7 @@
+node_modules
+.svelte-kit
+build
+.env
+.env.*
+!.env.example
+vite.config.ts.timestamp-*

package/templates/jbrains-docs/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "my-docs",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite dev",
+    "build": "vite build",
+    "preview": "vite preview",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
+  },
+  "dependencies": {
+    "specra": "^0.2.4"
+  },
+  "devDependencies": {
+    "@sveltejs/adapter-static": "^3.0.0",
+    "@sveltejs/kit": "^2.0.0",
+    "@sveltejs/vite-plugin-svelte": "^6.0.0",
+    "@tailwindcss/postcss": "^4.1.9",
+    "@tailwindcss/typography": "^0.5.19",
+    "postcss": "^8.5",
+    "svelte": "^5.0.0",
+    "svelte-check": "^4.0.0",
+    "tailwindcss": "^4.1.9",
+    "typescript": "^5",
+    "vite": "^6.3.0"
+  }
+}

package/templates/jbrains-docs/postcss.config.mjs

@@ -0,0 +1,8 @@
+/** @type {import('postcss-load-config').Config} */
+const config = {
+  plugins: {
+    '@tailwindcss/postcss': {},
+  },
+}
+
+export default config

package/templates/jbrains-docs/public/api-specs/openapi-example.json

@@ -0,0 +1,259 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "User Management API",
+    "version": "1.0.0",
+    "description": "A simple API for managing users (OpenAPI format example)"
+  },
+  "servers": [
+    {
+      "url": "https://api.example.com/v1",
+      "description": "Production server"
+    }
+  ],
+  "components": {
+    "securitySchemes": {
+      "bearerAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "description": "JWT Bearer token authentication"
+      }
+    },
+    "schemas": {
+      "User": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "example": "user_123"
+          },
+          "name": {
+            "type": "string",
+            "example": "John Doe"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "example": "john@example.com"
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2024-01-15T10:30:00Z"
+          }
+        }
+      },
+      "Error": {
+        "type": "object",
+        "properties": {
+          "error": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "security": [
+    {
+      "bearerAuth": []
+    }
+  ],
+  "paths": {
+    "/users": {
+      "get": {
+        "summary": "List all users",
+        "description": "Retrieve a paginated list of all users",
+        "operationId": "listUsers",
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Page number for pagination",
+            "schema": {
+              "type": "integer",
+              "default": 1,
+              "example": 1
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Number of items per page",
+            "schema": {
+              "type": "integer",
+              "default": 10,
+              "example": 10
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of users retrieved successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/User"
+                  }
+                },
+                "example": [
+                  {
+                    "id": "user_123",
+                    "name": "John Doe",
+                    "email": "john@example.com",
+                    "createdAt": "2024-01-15T10:30:00Z"
+                  },
+                  {
+                    "id": "user_456",
+                    "name": "Jane Smith",
+                    "email": "jane@example.com",
+                    "createdAt": "2024-01-16T14:20:00Z"
+                  }
+                ]
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "summary": "Create a new user",
+        "description": "Create a new user account",
+        "operationId": "createUser",
+        "requestBody": {
+          "description": "User data to create",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": ["name", "email"],
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "example": "John Doe"
+                  },
+                  "email": {
+                    "type": "string",
+                    "format": "email",
+                    "example": "john@example.com"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "User created successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request data",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                },
+                "example": {
+                  "error": "Email already exists",
+                  "code": "DUPLICATE_EMAIL"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/users/{id}": {
+      "get": {
+        "summary": "Get user by ID",
+        "description": "Retrieve a single user by their unique identifier",
+        "operationId": "getUserById",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "The user's unique identifier",
+            "schema": {
+              "type": "string",
+              "example": "user_123"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "User retrieved successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "User not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                },
+                "example": {
+                  "error": "User not found",
+                  "code": "USER_NOT_FOUND"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "summary": "Delete a user",
+        "description": "Permanently delete a user account",
+        "operationId": "deleteUser",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "The user's unique identifier",
+            "schema": {
+              "type": "string",
+              "example": "user_123"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "User deleted successfully"
+          },
+          "404": {
+            "description": "User not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                },
+                "example": {
+                  "error": "User not found",
+                  "code": "USER_NOT_FOUND"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/templates/jbrains-docs/public/api-specs/postman-example.json

@@ -0,0 +1,205 @@
+{
+  "info": {
+    "name": "Product API",
+    "description": "API for managing products in an e-commerce system (Postman Collection example)",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
+    "version": "1.0.0"
+  },
+  "auth": {
+    "type": "bearer"
+  },
+  "variable": [
+    {
+      "key": "baseUrl",
+      "value": "https://api.store.com/v1",
+      "type": "string"
+    }
+  ],
+  "item": [
+    {
+      "name": "Products",
+      "item": [
+        {
+          "name": "Get All Products",
+          "request": {
+            "method": "GET",
+            "header": [
+              {
+                "key": "Accept",
+                "value": "application/json"
+              }
+            ],
+            "url": {
+              "raw": "{{baseUrl}}/products?category=electronics&limit=10",
+              "host": ["{{baseUrl}}"],
+              "path": ["products"],
+              "query": [
+                {
+                  "key": "category",
+                  "value": "electronics",
+                  "description": "Filter by product category"
+                },
+                {
+                  "key": "limit",
+                  "value": "10",
+                  "description": "Maximum number of products to return"
+                }
+              ]
+            },
+            "description": "Retrieve a list of products with optional filtering"
+          },
+          "response": [
+            {
+              "name": "Success Response",
+              "code": 200,
+              "body": "[\n  {\n    \"id\": \"prod_123\",\n    \"name\": \"Laptop\",\n    \"price\": 999.99,\n    \"category\": \"electronics\",\n    \"inStock\": true\n  },\n  {\n    \"id\": \"prod_456\",\n    \"name\": \"Mouse\",\n    \"price\": 29.99,\n    \"category\": \"electronics\",\n    \"inStock\": true\n  }\n]"
+            }
+          ]
+        },
+        {
+          "name": "Get Product by ID",
+          "request": {
+            "method": "GET",
+            "header": [
+              {
+                "key": "Accept",
+                "value": "application/json"
+              }
+            ],
+            "url": {
+              "raw": "{{baseUrl}}/products/:id",
+              "host": ["{{baseUrl}}"],
+              "path": ["products", ":id"],
+              "variable": [
+                {
+                  "key": "id",
+                  "value": "prod_123",
+                  "description": "Product ID"
+                }
+              ]
+            },
+            "description": "Get a single product by its ID"
+          },
+          "response": [
+            {
+              "name": "Success",
+              "code": 200,
+              "body": "{\n  \"id\": \"prod_123\",\n  \"name\": \"Laptop\",\n  \"price\": 999.99,\n  \"category\": \"electronics\",\n  \"description\": \"High-performance laptop\",\n  \"inStock\": true\n}"
+            },
+            {
+              "name": "Not Found",
+              "code": 404,
+              "body": "{\n  \"error\": \"Product not found\",\n  \"code\": \"PRODUCT_NOT_FOUND\"\n}"
+            }
+          ]
+        },
+        {
+          "name": "Create Product",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              },
+              {
+                "key": "Accept",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"name\": \"Wireless Keyboard\",\n  \"price\": 79.99,\n  \"category\": \"electronics\",\n  \"description\": \"Ergonomic wireless keyboard\",\n  \"inStock\": true\n}"
+            },
+            "url": {
+              "raw": "{{baseUrl}}/products",
+              "host": ["{{baseUrl}}"],
+              "path": ["products"]
+            },
+            "description": "Create a new product in the catalog"
+          },
+          "response": [
+            {
+              "name": "Created",
+              "code": 201,
+              "body": "{\n  \"id\": \"prod_789\",\n  \"name\": \"Wireless Keyboard\",\n  \"price\": 79.99,\n  \"category\": \"electronics\",\n  \"description\": \"Ergonomic wireless keyboard\",\n  \"inStock\": true,\n  \"createdAt\": \"2024-01-15T10:30:00Z\"\n}"
+            },
+            {
+              "name": "Validation Error",
+              "code": 400,
+              "body": "{\n  \"error\": \"Invalid product data\",\n  \"details\": {\n    \"price\": \"Price must be a positive number\"\n  }\n}"
+            }
+          ]
+        },
+        {
+          "name": "Update Product",
+          "request": {
+            "method": "PATCH",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"price\": 89.99,\n  \"inStock\": false\n}"
+            },
+            "url": {
+              "raw": "{{baseUrl}}/products/:id",
+              "host": ["{{baseUrl}}"],
+              "path": ["products", ":id"],
+              "variable": [
+                {
+                  "key": "id",
+                  "value": "prod_123",
+                  "description": "Product ID to update"
+                }
+              ]
+            },
+            "description": "Update specific fields of a product"
+          },
+          "response": [
+            {
+              "name": "Updated",
+              "code": 200,
+              "body": "{\n  \"id\": \"prod_123\",\n  \"name\": \"Laptop\",\n  \"price\": 89.99,\n  \"category\": \"electronics\",\n  \"description\": \"High-performance laptop\",\n  \"inStock\": false,\n  \"updatedAt\": \"2024-01-16T15:45:00Z\"\n}"
+            }
+          ]
+        },
+        {
+          "name": "Delete Product",
+          "request": {
+            "method": "DELETE",
+            "header": [],
+            "url": {
+              "raw": "{{baseUrl}}/products/:id",
+              "host": ["{{baseUrl}}"],
+              "path": ["products", ":id"],
+              "variable": [
+                {
+                  "key": "id",
+                  "value": "prod_123",
+                  "description": "Product ID to delete"
+                }
+              ]
+            },
+            "description": "Delete a product from the catalog"
+          },
+          "response": [
+            {
+              "name": "Deleted",
+              "code": 204,
+              "body": ""
+            },
+            {
+              "name": "Not Found",
+              "code": 404,
+              "body": "{\n  \"error\": \"Product not found\"\n}"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}