@lapis-notes/source-editor 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Source Editor changelog
+
+## 0.1.0
+
+- Initial independent public package extracted from Lapis Notes without changing
+  the runtime plugin ID.

package/LICENSE.md

@@ -0,0 +1,8 @@
+# License
+
+Copyright (c) LapisMD contributors.
+
+This software is licensed under the GNU Affero General Public License, version
+3 or (at your option) any later version (`AGPL-3.0-or-later`). The complete
+license text is available from the
+[GNU Project](https://www.gnu.org/licenses/agpl-3.0.html).

package/README.md

@@ -0,0 +1,20 @@
+# Source Editor
+
+Source editing for text, JSON, and YAML files
+
+## Install for static composition
+
+```sh
+pnpm add @lapis-notes/source-editor
+```
+
+Register the exported plugin class in the application's `PluginProfile`. Import
+`@lapis-notes/source-editor/styles.css?inline` and pass the CSS through the static
+registration so the host owns its lifecycle.
+
+The runtime plugin ID is `lapis-source-editor`. A matching signed
+`lapis-source-editor-0.1.0.lapis-plugin` archive is attached to the
+package-scoped GitHub release for manual or registry installation.
+
+See the [repository README](https://github.com/lapismd/lapis-plugins#readme) for
+development, validation, and release-gate details.

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+import { Plugin, type App, type ExtType, type PluginManifest } from "@lapis-notes/api";
+import "./styles.css";
+export { default as manifest } from "../manifest.json";
+export declare const SOURCE_EDITOR_SETTING_FIELDS: ({
+    id: string;
+    type: "boolean";
+    title: string;
+    description: string;
+    default: false;
+    minimum?: undefined;
+    maximum?: undefined;
+} | {
+    id: string;
+    type: "boolean";
+    title: string;
+    description: string;
+    default: true;
+    minimum?: undefined;
+    maximum?: undefined;
+} | {
+    id: string;
+    type: "integer";
+    title: string;
+    description: string;
+    minimum: number;
+    maximum: number;
+    default: number;
+})[];
+export declare const SOURCE_EDITOR_SCHEMA: {
+    readonly id: "editor";
+    readonly title: "Editor";
+    readonly type: "object";
+    readonly properties: {
+        [k: string]: {
+            type: "boolean";
+            title: string;
+            description: string;
+            default: false;
+            minimum?: undefined;
+            maximum?: undefined;
+        } | {
+            type: "boolean";
+            title: string;
+            description: string;
+            default: true;
+            minimum?: undefined;
+            maximum?: undefined;
+        } | {
+            type: "integer";
+            title: string;
+            description: string;
+            minimum: number;
+            maximum: number;
+            default: number;
+        };
+    };
+};
+export interface SourceEditorViewDefinition {
+    type: "text" | "json" | "yaml";
+    label: string;
+    extensions: readonly string[];
+    patterns: readonly string[];
+    createExtension(app: App): ExtType;
+}
+export declare const SOURCE_EDITOR_VIEW_DEFINITIONS: readonly SourceEditorViewDefinition[];
+export declare class SourceEditorPlugin extends Plugin {
+    constructor(app: App, manifest?: PluginManifest);
+    onload(): Promise<void>;
+}
+export default SourceEditorPlugin;

package/dist/index.js

@@ -0,0 +1,137 @@
+import { json } from "@codemirror/lang-json";
+import { yaml } from "@codemirror/lang-yaml";
+import { Plugin, SourceTextFileView, } from "@lapis-notes/api";
+import { markupEditor } from "@lapis-notes/api/editor";
+import { getWorkspaceHostBinding } from "@lapis-notes/api/workspace-host";
+import manifestSpec from "../manifest.json";
+import "./styles.css";
+export { default as manifest } from "../manifest.json";
+export const SOURCE_EDITOR_SETTING_FIELDS = [
+    {
+        id: "editor.alwaysFocusNewTabs",
+        type: "boolean",
+        title: "Always focus new tabs",
+        description: "Switch to newly created tabs immediately. Turn this off to create them in the background.",
+        default: false,
+    },
+    {
+        id: "editor.display.showLineNumbers",
+        type: "boolean",
+        title: "Show line numbers",
+        description: "Show line numbers in the editor gutter.",
+        default: true,
+    },
+    {
+        id: "editor.display.foldIndent",
+        type: "boolean",
+        title: "Code folding",
+        description: "Show the fold gutter for language-defined ranges such as headings and objects.",
+        default: true,
+    },
+    {
+        id: "editor.display.wrapLines",
+        type: "boolean",
+        title: "Wrap lines",
+        description: "Wrap long source lines to the editor width.",
+        default: true,
+    },
+    {
+        id: "editor.display.showIndentationGuides",
+        type: "boolean",
+        title: "Show indentation guides",
+        description: "Show vertical guides for indented source.",
+        default: true,
+    },
+    {
+        id: "editor.behaviour.spellCheck",
+        type: "boolean",
+        title: "Spellcheck",
+        description: "Use the browser spellchecker in source editors.",
+        default: true,
+    },
+    {
+        id: "editor.behaviour.indentUsingTabs",
+        type: "boolean",
+        title: "Indent using tabs",
+        description: "Turn this off to insert spaces when indenting.",
+        default: true,
+    },
+    {
+        id: "editor.behaviour.indentVisualWidth",
+        type: "integer",
+        title: "Indent width",
+        description: "Number of columns used by a tab or space indent.",
+        minimum: 2,
+        maximum: 8,
+        default: 4,
+    },
+];
+export const SOURCE_EDITOR_SCHEMA = {
+    id: "editor",
+    title: "Editor",
+    type: "object",
+    properties: Object.fromEntries(SOURCE_EDITOR_SETTING_FIELDS.map(({ id, ...definition }) => [
+        id,
+        definition,
+    ])),
+};
+export const SOURCE_EDITOR_VIEW_DEFINITIONS = [
+    {
+        type: "text",
+        label: "Text",
+        extensions: ["txt", "text"],
+        patterns: [".txt", ".text", "*.txt", "*.text"],
+        createExtension: (app) => markupEditor({ language: "text", app }),
+    },
+    {
+        type: "json",
+        label: "JSON",
+        extensions: ["json", "data"],
+        patterns: [".json", ".data", "*.json", "*.data"],
+        createExtension: (app) => markupEditor({ language: "json", app }, json()),
+    },
+    {
+        type: "yaml",
+        label: "YAML",
+        extensions: ["yaml", "yml"],
+        patterns: [".yaml", ".yml", "*.yaml", "*.yml"],
+        createExtension: (app) => markupEditor({ language: "yaml", app }, yaml()),
+    },
+];
+export class SourceEditorPlugin extends Plugin {
+    constructor(app, manifest = manifestSpec) {
+        super(app, manifest);
+    }
+    async onload() {
+        this.app.configuration.schema.register(SOURCE_EDITOR_SCHEMA);
+        this.register(() => {
+            this.app.configuration.schema.unregister(SOURCE_EDITOR_SCHEMA);
+        });
+        const { controller } = getWorkspaceHostBinding(this.app.workspace);
+        this.register(controller.registerSettingsSection({
+            id: "lapis-source-editor",
+            title: "Editor",
+            description: "Source editor behavior shared by Markdown, text, JSON, and YAML files.",
+            icon: "file-pen-line",
+            order: 20,
+            navigationGroupId: "core-plugins",
+            sourcePluginId: this.id,
+            fields: SOURCE_EDITOR_SETTING_FIELDS.map((field) => ({ ...field })),
+        }));
+        for (const definition of SOURCE_EDITOR_VIEW_DEFINITIONS) {
+            this.registerView(definition.type, (leaf) => new SourceTextFileView(leaf, definition.type, definition.extensions), { kind: "file" });
+            this.registerEditorView({
+                id: definition.type,
+                viewType: definition.type,
+                label: definition.label,
+                description: `${definition.label} source editor`,
+                filenamePatterns: [...definition.patterns],
+                priority: "default",
+            });
+            this.registerExtensions([...definition.extensions], definition.type);
+            this.registerEditorExtension(definition.createExtension(this.app), definition.type);
+        }
+        await this.app.configuration.materializeSchemaDefaults();
+    }
+}
+export default SourceEditorPlugin;

package/dist/styles.css

@@ -0,0 +1 @@
+/* Source Editor currently uses host and component-scoped styles only. */

package/manifest.json

@@ -0,0 +1,30 @@
+{
+  "id": "lapis-source-editor",
+  "name": "Source Editor",
+  "version": "0.1.0",
+  "minAppVersion": "0.1.0",
+  "description": "Source editing for text, JSON, and YAML files",
+  "author": "Lapis Notes",
+  "authorUrl": "https://app.lapis.md",
+  "isDesktopOnly": false,
+  "lapis": {
+    "manifestVersion": 1,
+    "source": "official",
+    "locked": false,
+    "enabledByDefault": true,
+    "runtime": {
+      "entries": {
+        "workspace": {
+          "path": "main.mjs",
+          "format": "esm",
+          "sharedDependencies": [
+            "@lapis-notes/api",
+            "@lapis-notes/api/editor",
+            "@lapis-notes/api/workspace-host"
+          ],
+          "requiresReloadOnUpdate": false
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@lapis-notes/source-editor",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-or-later",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./manifest.json": "./manifest.json",
+    "./styles.css": "./styles.css"
+  },
+  "dependencies": {
+    "@codemirror/lang-json": "^6.0.2",
+    "@codemirror/lang-yaml": "^6.1.2",
+    "@lapis-notes/api": "^0.1.0",
+    "@lapismd/design-core": "^0.1.0"
+  },
+  "devDependencies": {
+    "@sveltejs/package": "^2.5.0",
+    "svelte": "^5.38.2",
+    "svelte-check": "^4.3.1",
+    "typescript": "~5.9.3",
+    "vite": "^6.4.2",
+    "vitest": "^4.1.8"
+  },
+  "description": "Source editing for text, JSON, and YAML files",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lapismd/lapis-plugins.git",
+    "directory": "packages/source-editor"
+  },
+  "homepage": "https://github.com/lapismd/lapis-plugins/tree/main/packages/source-editor#readme",
+  "bugs": {
+    "url": "https://github.com/lapismd/lapis-plugins/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "manifest.json",
+    "styles.css",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "svelte": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "pnpm run prepack",
+    "check": "pnpm check:types",
+    "check:types": "svelte-check --tsconfig ./tsconfig.json --fail-on-warnings --output human",
+    "test": "vitest run",
+    "publint": "publint",
+    "pack": "pnpm pack --pack-destination ../../.release/npm"
+  }
+}

package/styles.css

@@ -0,0 +1 @@
+@import "./dist/styles.css";