sdocs 0.0.55 → 0.0.56

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.56] - 2026-07-05
+
+### Added
+
+- **`configSchema` in `sdocs/language`** — a structured description of the
+  `sdocs.config.*` shape (keys, documentation, and value enums) mirroring
+  `SdocsConfig`. Editor tooling reads it to complete the config file in
+  projects that don't install `sdocs`, so config completion can't drift from
+  the config type.
+
 ## [0.0.55] - 2026-07-05
 
 ### Changed

package/dist/language/config-schema.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A structured description of the `sdocs.config.*` shape, mirroring the
+ * `SdocsConfig` type. Editor tooling consumes this to offer key and value
+ * completions in projects that don't install `sdocs` (where the TypeScript
+ * type isn't resolvable). Keep it in step with `SdocsConfig` in `types.ts`.
+ */
+/** One config key: how to present, insert, and (for enums) value-complete it. */
+export interface ConfigFieldSchema {
+    /** Short type hint shown as the completion detail, e.g. `'string | string[]'`. */
+    detail: string;
+    /** Markdown documentation for the key. */
+    doc: string;
+    /** Snippet inserted after the key name — includes the `:` and a tabstop. */
+    insert: string;
+    /** Allowed values, for value-position completion. */
+    values?: string[];
+    /** Whether `values` are strings (quoted on insert) or literals (inserted bare). */
+    quoted?: boolean;
+    /** Nested object schema, when this key holds an object. */
+    object?: ConfigSchema;
+}
+/** A config object shape: its keys mapped to their field descriptions. */
+export type ConfigSchema = Record<string, ConfigFieldSchema>;
+/** The `sdocs.config.*` schema, rooted at the exported config object. */
+export declare const configSchema: ConfigSchema;

package/dist/language/config-schema.js

@@ -0,0 +1,131 @@
+/**
+ * A structured description of the `sdocs.config.*` shape, mirroring the
+ * `SdocsConfig` type. Editor tooling consumes this to offer key and value
+ * completions in projects that don't install `sdocs` (where the TypeScript
+ * type isn't resolvable). Keep it in step with `SdocsConfig` in `types.ts`.
+ */
+// Sizing knobs shared by the page/docs/layout content objects.
+const maxWidth = {
+    detail: 'string',
+    doc: 'Content column max width — any CSS length (`1200px`, `80ch`, `100%`).',
+    insert: ": '$0'",
+};
+const padding = {
+    detail: 'string',
+    doc: 'Space around the content — any CSS padding shorthand (`16px`, `1rem 2rem`).',
+    insert: ": '$0'",
+};
+// Stage-layout knobs shared by the docs preview/example stages.
+const direction = {
+    detail: "'row' | 'column'",
+    doc: 'Preview/example stage `flex-direction`. Default: `row`.',
+    insert: ": '${0:row}'",
+    values: ['row', 'column', 'row-reverse', 'column-reverse'],
+    quoted: true,
+};
+const gap = {
+    detail: 'string',
+    doc: 'Gap between stage items — any CSS length. Default: `16px`.',
+    insert: ": '$0'",
+};
+const contentX = {
+    detail: "'left' | 'center' | 'right' | 'justify'",
+    doc: 'Horizontal alignment of stage contents. Default: `left`.',
+    insert: ": '${0:left}'",
+    values: ['left', 'center', 'right', 'justify'],
+    quoted: true,
+};
+const contentY = {
+    detail: "'top' | 'middle' | 'bottom' | 'justify'",
+    doc: 'Vertical alignment of stage contents. Default: `top`.',
+    insert: ": '${0:top}'",
+    values: ['top', 'middle', 'bottom', 'justify'],
+    quoted: true,
+};
+/** The `sdocs.config.*` schema, rooted at the exported config object. */
+export const configSchema = {
+    include: {
+        detail: 'string | string[]',
+        doc: 'Glob pattern(s) locating your `.sdoc` files. Default: `./src/**/*.sdoc`.',
+        insert: ": ['$0']",
+    },
+    port: {
+        detail: 'number',
+        doc: 'Dev server port. Default: `3000`.',
+        insert: ': ${0:3000}',
+    },
+    open: {
+        detail: 'boolean',
+        doc: 'Open the browser when the dev server starts. Default: `false`.',
+        insert: ': ${0:false}',
+        values: ['true', 'false'],
+    },
+    css: {
+        detail: 'string | Record<string, string>',
+        doc: 'CSS loaded inside preview iframes — a single stylesheet path, or a map of named stylesheets to switch between.',
+        insert: ": '$0'",
+    },
+    logo: {
+        detail: 'string',
+        doc: 'Sidebar logo text. Default: `sdocs`.',
+        insert: ": '${0:sdocs}'",
+    },
+    icon: {
+        detail: 'string | false',
+        doc: "Sidebar logo icon: `'sdocs'` for the built-in mascot, an image URL, or `false` to hide it. Default: `'sdocs'`.",
+        insert: ": '${0:sdocs}'",
+        values: ['sdocs'],
+        quoted: true,
+    },
+    sidebar: {
+        detail: 'object',
+        doc: 'Sidebar ordering and default-expanded folders.',
+        insert: ': {\n\t$0\n}',
+        object: {
+            order: {
+                detail: 'Record<string, string[]>',
+                doc: "Per-folder sort overrides. Keys are folder paths (`'root'` for the top level); `'*'` stands for unlisted items.",
+                insert: ': {\n\t$0\n}',
+            },
+            open: {
+                detail: 'string[]',
+                doc: 'Folders expanded by default on load.',
+                insert: ': [$0]',
+            },
+        },
+    },
+    content: {
+        detail: 'object',
+        doc: 'Content presentation per entity kind. Entity and block attributes override these.',
+        insert: ': {\n\t$0\n}',
+        object: {
+            page: {
+                detail: 'object',
+                doc: '`[PAGE]` content. Defaults: `maxWidth` `1200px`, `padding` `32px`, `toc` `true`.',
+                insert: ': {\n\t$0\n}',
+                object: {
+                    maxWidth,
+                    padding,
+                    toc: {
+                        detail: 'boolean',
+                        doc: 'Show the page table of contents. Default: `true`.',
+                        insert: ': ${0:true}',
+                        values: ['true', 'false'],
+                    },
+                },
+            },
+            docs: {
+                detail: 'object',
+                doc: '`[DOCS]` pages. `maxWidth` is the content column; `padding`/`direction`/`gap`/`contentX`/`contentY` are the default preview & example stage layout.',
+                insert: ': {\n\t$0\n}',
+                object: { maxWidth, padding, direction, gap, contentX, contentY },
+            },
+            layout: {
+                detail: 'object',
+                doc: '`[LAYOUT]` stages. Defaults: `maxWidth` `100%`, `padding` `0px`.',
+                insert: ': {\n\t$0\n}',
+                object: { maxWidth, padding },
+            },
+        },
+    },
+};

package/dist/language/index.d.ts

@@ -1,4 +1,5 @@
 export { scanSdoc, offsetToPosition, ENTITY_KINDS, SUB_BLOCK_KINDS, type Span, type EntityKind, type SubBlockKind, type AttrValue, type Attrs, type SubBlock, type Entity, type TagBlock, type ScanError, type SdocFile, } from './scanner.js';
 export { projectSdoc, type SdocProjection, type ProjectedLineKind, } from './projection.js';
 export { segmentPageBody, type PageSegment, } from './page-islands.js';
+export { configSchema, type ConfigSchema, type ConfigFieldSchema, } from './config-schema.js';
 export { parseSdoc, parseArgsLiteral, slugifyTitle, normalizeBody, attributeRules, type AttrRule, type ArgValue, type Sizing, type PreviewBlock, type ExampleBlock, type DocsEntity, type PageEntity, type LayoutEntity, type SdocEntity, type SdocDocument, } from './parser.js';

package/dist/language/index.js

@@ -1,4 +1,5 @@
 export { scanSdoc, offsetToPosition, ENTITY_KINDS, SUB_BLOCK_KINDS, } from './scanner.js';
 export { projectSdoc, } from './projection.js';
 export { segmentPageBody, } from './page-islands.js';
+export { configSchema, } from './config-schema.js';
 export { parseSdoc, parseArgsLiteral, slugifyTitle, normalizeBody, attributeRules, } from './parser.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sdocs",
-	"version": "0.0.55",
+	"version": "0.0.56",
 	"description": "A lightweight documentation tool for Svelte 5 components",
 	"type": "module",
 	"license": "MIT",