obsidian-plugin-config 1.0.2

package/src/utils/SettingsHelper.ts

@@ -0,0 +1,180 @@
+import { Setting } from "obsidian";
+
+/**
+ * Helper for creating common setting types with consistent styling
+ */
+export class SettingsHelper {
+    
+    /**
+     * Create a text input setting
+     */
+    static createTextSetting(
+        containerEl: HTMLElement,
+        name: string,
+        desc: string,
+        value: string,
+        onChange: (value: string) => void,
+        placeholder?: string
+    ): Setting {
+        return new Setting(containerEl)
+            .setName(name)
+            .setDesc(desc)
+            .addText(text => text
+                .setPlaceholder(placeholder || "")
+                .setValue(value)
+                .onChange(onChange)
+            );
+    }
+
+    /**
+     * Create a toggle setting
+     */
+    static createToggleSetting(
+        containerEl: HTMLElement,
+        name: string,
+        desc: string,
+        value: boolean,
+        onChange: (value: boolean) => void
+    ): Setting {
+        return new Setting(containerEl)
+            .setName(name)
+            .setDesc(desc)
+            .addToggle(toggle => toggle
+                .setValue(value)
+                .onChange(onChange)
+            );
+    }
+
+    /**
+     * Create a dropdown setting
+     */
+    static createDropdownSetting(
+        containerEl: HTMLElement,
+        name: string,
+        desc: string,
+        options: Record<string, string>,
+        value: string,
+        onChange: (value: string) => void
+    ): Setting {
+        return new Setting(containerEl)
+            .setName(name)
+            .setDesc(desc)
+            .addDropdown(dropdown => {
+                Object.entries(options).forEach(([key, label]) => {
+                    dropdown.addOption(key, label);
+                });
+                dropdown
+                    .setValue(value)
+                    .onChange(onChange);
+            });
+    }
+
+    /**
+     * Create a number input setting
+     */
+    static createNumberSetting(
+        containerEl: HTMLElement,
+        name: string,
+        desc: string,
+        value: number,
+        onChange: (value: number) => void,
+        min?: number,
+        max?: number,
+        step?: number
+    ): Setting {
+        return new Setting(containerEl)
+            .setName(name)
+            .setDesc(desc)
+            .addText(text => {
+                text.inputEl.type = "number";
+                if (min !== undefined) text.inputEl.min = min.toString();
+                if (max !== undefined) text.inputEl.max = max.toString();
+                if (step !== undefined) text.inputEl.step = step.toString();
+                
+                text
+                    .setValue(value.toString())
+                    .onChange(val => {
+                        const num = parseFloat(val);
+                        if (!isNaN(num)) onChange(num);
+                    });
+            });
+    }
+
+    /**
+     * Create a button setting
+     */
+    static createButtonSetting(
+        containerEl: HTMLElement,
+        name: string,
+        desc: string,
+        buttonText: string,
+        onClick: () => void
+    ): Setting {
+        return new Setting(containerEl)
+            .setName(name)
+            .setDesc(desc)
+            .addButton(button => button
+                .setButtonText(buttonText)
+                .onClick(onClick)
+            );
+    }
+
+    /**
+     * Create a section header
+     */
+    static createHeader(
+        containerEl: HTMLElement,
+        title: string,
+        description?: string
+    ): void {
+        const headerEl = containerEl.createEl("h3", { text: title });
+        headerEl.style.marginTop = "20px";
+        headerEl.style.marginBottom = "10px";
+        headerEl.style.borderBottom = "1px solid var(--background-modifier-border)";
+        headerEl.style.paddingBottom = "5px";
+        
+        if (description) {
+            const descEl = containerEl.createEl("p", { text: description });
+            descEl.style.marginTop = "0";
+            descEl.style.marginBottom = "15px";
+            descEl.style.color = "var(--text-muted)";
+            descEl.style.fontSize = "0.9em";
+        }
+    }
+
+    /**
+     * Create a collapsible section
+     */
+    static createCollapsibleSection(
+        containerEl: HTMLElement,
+        title: string,
+        isOpen: boolean = false
+    ): { container: HTMLElement; toggle: () => void } {
+        const sectionEl = containerEl.createDiv("setting-item");
+        const headerEl = sectionEl.createDiv("setting-item-info");
+        const nameEl = headerEl.createDiv("setting-item-name");
+        nameEl.setText(title);
+        nameEl.style.cursor = "pointer";
+        nameEl.style.userSelect = "none";
+        
+        const contentEl = containerEl.createDiv("collapsible-content");
+        contentEl.style.display = isOpen ? "block" : "none";
+        contentEl.style.marginLeft = "20px";
+        contentEl.style.marginTop = "10px";
+        
+        const arrow = nameEl.createSpan("collapse-icon");
+        arrow.setText(isOpen ? "▼" : "▶");
+        arrow.style.marginRight = "8px";
+        arrow.style.fontSize = "0.8em";
+        
+        const toggle = () => {
+            const isCurrentlyOpen = contentEl.style.display !== "none";
+            contentEl.style.display = isCurrentlyOpen ? "none" : "block";
+            arrow.setText(isCurrentlyOpen ? "▶" : "▼");
+        };
+        
+        nameEl.addEventListener("click", toggle);
+        
+        return { container: contentEl, toggle };
+    }
+}

package/src/utils/index.ts

@@ -0,0 +1,3 @@
+// Centralized utils exports for Obsidian plugins
+export { NoticeHelper } from './NoticeHelper.js';
+export { SettingsHelper } from './SettingsHelper.js';

package/templates/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "npm.packageManager": "yarn",
+  "typescript.preferences.includePackageJsonAutoImports": "off"
+}

package/templates/eslint.config.ts

@@ -0,0 +1,48 @@
+import * as typescriptEslintParser from "@typescript-eslint/parser";
+import typescriptEslintPlugin from "@typescript-eslint/eslint-plugin";
+import "eslint-import-resolver-typescript";
+import type {
+  Linter
+} from "eslint";
+
+const configs: Linter.Config[] = [
+  {
+    files: ["**/*.ts"],
+    ignores: [
+      "dist/**",
+      "node_modules/**",
+      "main.js"
+    ],
+    languageOptions: {
+      parser: typescriptEslintParser,
+      sourceType: "module",
+      parserOptions: {
+        project: "./tsconfig.json",
+        ecmaVersion: 2023
+      }
+    },
+    plugins: {
+      "@typescript-eslint": typescriptEslintPlugin
+    },
+    rules: {
+      // Base rules
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": ["warn", { "args": "none" }],
+      "@typescript-eslint/ban-ts-comment": "off",
+      "no-prototype-builtins": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      
+      // Useful rules but not too strict
+      "semi": "error",
+      "@typescript-eslint/explicit-function-return-type": "warn",
+      
+      // Disable overly strict rules
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-argument": "off"
+    }
+  }
+];
+
+export default configs;

package/templates/help-plugin.ts

@@ -0,0 +1,39 @@
+#!/usr/bin/env tsx
+
+console.log(`
+Obsidian Plugin Development - Command Reference
+(Run these commands from your plugin directory)
+
+DEVELOPMENT:
+  yarn start                       Install dependencies and start development
+  yarn dev                         Build in development mode with hot reload
+  yarn build                       Build for production
+  yarn real                        Build and install in real Obsidian vault
+
+VERSION MANAGEMENT:
+  yarn update-version, v           Update plugin version in package.json and manifest.json
+  yarn release, r                  Create release with automated changelog
+
+GIT OPERATIONS:
+  yarn acp                         Add, commit, and push changes
+  yarn bacp                        Build + add, commit, and push
+
+USAGE EXAMPLES:
+  yarn start                       # First time setup
+  yarn dev                         # Daily development
+  yarn real                        # Build and test in real vault
+  yarn update-version              # Update version before release
+  yarn release                     # Publish new version
+
+ENVIRONMENT:
+  - Edit .env file to set TEST_VAULT and REAL_VAULT paths
+  - All scripts use centralized configuration from obsidian-plugin-config
+
+CENTRALIZED ARCHITECTURE:
+  - Scripts are centralized in obsidian-plugin-config repository
+  - Configuration files (tsconfig, eslint) extend centralized templates
+  - Dependencies are managed centrally for consistency
+  - Run 'cd ../obsidian-plugin-config && yarn help' for migration commands
+
+For detailed documentation: ../obsidian-plugin-config/ARCHITECTURE-SUMMARY.md
+`);

package/templates/package-versions.json

@@ -0,0 +1,28 @@
+{
+  "devDependencies": {
+    "@types/node": "^16.11.6",
+    "eslint": "^9.0.0",
+    "obsidian": "latest",
+    "obsidian-typings": "latest",
+    "typescript": "^5.8.2",
+    "tsx": "^4.19.4"
+  },
+  "engines": {
+    "npm": "please-use-yarn",
+    "yarn": ">=1.22.0"
+  },
+  "scripts": {
+    "start": "yarn install && yarn dev",
+    "dev": "tsx ../obsidian-plugin-config/scripts/esbuild.config.ts",
+    "build": "tsc -noEmit -skipLibCheck && tsx ../obsidian-plugin-config/scripts/esbuild.config.ts production",
+    "real": "tsx ../obsidian-plugin-config/scripts/esbuild.config.ts production real",
+    "acp": "tsx ../obsidian-plugin-config/scripts/acp.ts",
+    "bacp": "tsx ../obsidian-plugin-config/scripts/acp.ts -b",
+    "update-version": "tsx ../obsidian-plugin-config/scripts/update-version.ts",
+    "v": "tsx ../obsidian-plugin-config/scripts/update-version.ts",
+    "release": "tsx ../obsidian-plugin-config/scripts/release.ts",
+    "r": "tsx ../obsidian-plugin-config/scripts/release.ts",
+    "help": "tsx ../obsidian-plugin-config/templates/help-plugin.ts",
+    "h": "tsx ../obsidian-plugin-config/templates/help-plugin.ts"
+  }
+}

package/templates/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    "types": [
+      "obsidian-typings"
+    ],
+    "paths": {
+      "obsidian-typings/implementations": [
+        "./node_modules/obsidian-typings/dist/implementations.d.ts",
+        "./node_modules/obsidian-typings/dist/implementations.cjs"
+      ]
+    },
+    "inlineSourceMap": true,
+    "inlineSources": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "target": "ES2021",
+    "allowJs": true,
+    "noImplicitAny": true,
+    "importHelpers": true,
+    "isolatedModules": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "allowSyntheticDefaultImports": true,
+    "verbatimModuleSyntax": true,
+    "forceConsistentCasingInFileNames": true,
+    "strictNullChecks": true,
+    "resolveJsonModule": true,
+    "lib": [
+      "DOM",
+      "ES2021"
+    ]
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./scripts/**/*.ts"
+  ]
+}

package/test-plugin/manifest.json

@@ -0,0 +1,10 @@
+{
+  "id": "test-plugin",
+  "name": "Test Plugin",
+  "version": "1.0.0",
+  "minAppVersion": "0.15.0",
+  "description": "Plugin de test pour injection",
+  "author": "3C0D",
+  "authorUrl": "https://github.com/3C0D",
+  "isDesktopOnly": false
+}

package/test-plugin/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "test-plugin",
+  "version": "1.0.0",
+  "description": "Plugin de test pour injection",
+  "main": "main.js",
+  "scripts": {
+    "dev": "tsx scripts/esbuild.config.ts",
+    "build": "tsc -noEmit -skipLibCheck && tsx scripts/esbuild.config.ts production",
+    "start": "yarn install && yarn dev",
+    "real": "tsx scripts/esbuild.config.ts production real",
+    "acp": "tsx scripts/acp.ts",
+    "bacp": "tsx scripts/acp.ts -b",
+    "update-version": "tsx scripts/update-version.ts",
+    "v": "tsx scripts/update-version.ts",
+    "release": "tsx scripts/release.ts",
+    "r": "tsx scripts/release.ts",
+    "help": "tsx scripts/help.ts",
+    "h": "tsx scripts/help.ts"
+  },
+  "keywords": [],
+  "author": "3C0D",
+  "license": "MIT",
+  "devDependencies": {
+    "obsidian": "latest",
+    "typescript": "4.7.4",
+    "esbuild": "0.17.3",
+    "dedent": "^1.5.3",
+    "semver": "^7.6.3",
+    "@types/semver": "^7.5.8",
+    "dotenv": "^16.4.5",
+    "builtin-modules": "^4.0.0",
+    "tsx": "^4.19.4"
+  },
+  "engines": {
+    "npm": "please-use-yarn",
+    "yarn": ">=1.22.0"
+  }
+}

package/test-plugin/scripts/acp.ts

@@ -0,0 +1,71 @@
+import { execSync } from "child_process";
+import fs from "fs";
+import path from "path";
+import {
+  askQuestion,
+  cleanInput,
+  createReadlineInterface,
+  gitExec
+} from "./utils.ts";
+
+const rl = createReadlineInterface();
+
+// Check if we're in the centralized config repo
+function isInCentralizedRepo(): boolean {
+  const packageJsonPath = path.join(process.cwd(), "package.json");
+  if (!fs.existsSync(packageJsonPath)) return false;
+
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+  return packageJson.name === "obsidian-plugin-config";
+}
+
+async function main(): Promise<void> {
+  try {
+    if (process.argv.includes("-b")) {
+      console.log("Building...");
+      gitExec("yarn build");
+      console.log("Build successful.");
+    }
+
+    // Only update exports if we're in the centralized repo and not explicitly disabled
+    if (!process.argv.includes("-ne") && !process.argv.includes("--no-exports") && isInCentralizedRepo()) {
+      console.log("Updating exports...");
+      gitExec("yarn run update-exports");
+      console.log("Exports updated.");
+    }
+
+    const input: string = await askQuestion("Enter commit message: ", rl);
+
+    const cleanedInput = cleanInput(input);
+
+    try {
+      gitExec("git add -A");
+      gitExec(`git commit -m "${cleanedInput}"`);
+    } catch {
+      console.log("Commit already exists or failed.");
+      return;
+    }
+
+    // get current branch name
+    const currentBranch = execSync("git rev-parse --abbrev-ref HEAD").toString().trim();
+
+    try {
+      gitExec(`git push origin ${currentBranch}`);
+      console.log("Commit and push successful.");
+    } catch {
+      // new branch
+      console.log(`New branch detected. Setting upstream for ${currentBranch}...`);
+      gitExec(`git push --set-upstream origin ${currentBranch}`);
+      console.log("Upstream branch set and push successful.");
+    }
+  } catch (error) {
+    console.error("Error:", error instanceof Error ? error.message : String(error));
+  } finally {
+    rl.close();
+  }
+}
+
+main().catch(console.error).finally(() => {
+  console.log("Exiting...");
+  process.exit();
+});

package/test-plugin/scripts/esbuild.config.ts

@@ -0,0 +1,165 @@
+import esbuild from "esbuild";
+import process from "process";
+import builtins from "builtin-modules";
+import { config } from "dotenv";
+import path from "path";
+import { readFileSync } from "fs";
+import { rm } from "fs/promises";
+import { isValidPath, copyFilesToTargetDir } from "./utils.ts";
+
+// Determine the plugin directory (where the script is called from)
+const pluginDir = process.cwd();
+const manifestPath = path.join(pluginDir, "manifest.json");
+const manifest = JSON.parse(readFileSync(manifestPath, "utf-8"));
+
+config();
+
+const EXTERNAL_DEPS = [
+  "obsidian",
+  "electron",
+  "@codemirror/autocomplete",
+  "@codemirror/collab",
+  "@codemirror/commands",
+  "@codemirror/language",
+  "@codemirror/lint",
+  "@codemirror/search",
+  "@codemirror/state",
+  "@codemirror/view",
+  "@lezer/common",
+  "@lezer/highlight",
+  "@lezer/lr",
+  ...builtins
+];
+
+const BANNER = `/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/`;
+
+async function validateEnvironment(): Promise<void> {
+  const srcMainPath = path.join(pluginDir, "src/main.ts");
+  if (!await isValidPath(srcMainPath)) {
+    throw new Error("Invalid path for src/main.ts. main.ts must be in the src directory");
+  }
+  if (!await isValidPath(manifestPath)) {
+    throw new Error("Invalid path for manifest.json");
+  }
+}
+
+function getBuildPath(isProd: boolean): string {
+  // If production build without redirection, return plugin directory
+  if (isProd && !process.argv.includes("-r")) {
+    return pluginDir;
+  }
+
+  // Determine which path to use
+  const envKey = process.argv.includes("-r") ? "REAL_VAULT" : "TEST_VAULT";
+  const vaultPath = process.env[envKey]?.trim();
+
+  // If empty or undefined, we're already in the plugin folder
+  if (!vaultPath) {
+    return pluginDir;
+  }
+
+  // Check if the path already contains the plugins directory path
+  const pluginsPath = path.join(".obsidian", "plugins");
+  if (vaultPath.includes(pluginsPath)) {
+    // Just add the manifest id to complete the path
+    return path.join(vaultPath, manifest.id);
+  }
+
+  // Otherwise, complete the full path
+  return path.join(vaultPath, ".obsidian", "plugins", manifest.id);
+}
+
+async function createBuildContext(buildPath: string, isProd: boolean, entryPoints: string[]): Promise<esbuild.BuildContext> {
+  return await esbuild.context({
+    banner: { js: BANNER },
+    minify: isProd,
+    entryPoints,
+    bundle: true,
+    external: EXTERNAL_DEPS,
+    format: "cjs",
+    target: "esNext",
+    platform: "node",
+    logLevel: "info",
+    sourcemap: isProd ? false : "inline",
+    treeShaking: true,
+    outdir: buildPath,
+    outbase: path.join(pluginDir, "src"),
+    plugins: [
+      // Plugin pour gérer les alias de chemin
+      {
+        name: "path-alias",
+        setup: (build): void => {
+          build.onResolve({ filter: /^@config\// }, (args) => {
+            const relativePath = args.path.replace(/^@config\//, "");
+            return {
+              path: path.resolve("../obsidian-plugin-config/src", relativePath)
+            };
+          });
+
+          build.onResolve({ filter: /^@config-scripts\// }, (args) => {
+            const relativePath = args.path.replace(/^@config-scripts\//, "");
+            return {
+              path: path.resolve("../obsidian-plugin-config/scripts", relativePath)
+            };
+          });
+        }
+      },
+      {
+        name: "copy-to-plugins-folder",
+        setup: (build): void => {
+          build.onEnd(async () => {
+            // if real or build
+            if (isProd) {
+              if (process.argv.includes("-r")) {
+                await copyFilesToTargetDir(buildPath);
+                console.log(`Successfully installed in ${buildPath}`);
+              } else {
+                const folderToRemove = path.join(buildPath, "_.._");
+                if (await isValidPath(folderToRemove)) {
+                  await rm(folderToRemove, { recursive: true });
+                }
+                console.log("Built done in initial folder");
+              }
+            }
+            // if watch (dev)
+            else {
+              await copyFilesToTargetDir(buildPath);
+            }
+          });
+        }
+      }
+    ]
+  });
+}
+
+async function main(): Promise<void> {
+  try {
+    await validateEnvironment();
+    const isProd = process.argv[2] === "production";
+    const buildPath = getBuildPath(isProd);
+    console.log(buildPath === pluginDir
+      ? "Building in initial folder"
+      : `Building in ${buildPath}`);
+    const srcStylesPath = path.join(pluginDir, "src/styles.css");
+    const rootStylesPath = path.join(pluginDir, "styles.css");
+    const stylePath = await isValidPath(srcStylesPath) ? srcStylesPath : await isValidPath(rootStylesPath) ? rootStylesPath : "";
+    const mainTsPath = path.join(pluginDir, "src/main.ts");
+    const entryPoints = stylePath ? [mainTsPath, stylePath] : [mainTsPath];
+    const context = await createBuildContext(buildPath, isProd, entryPoints);
+
+    if (isProd) {
+      await context.rebuild();
+      process.exit(0);
+    } else {
+      await context.watch();
+    }
+  } catch (error) {
+    console.error("Build failed:", error);
+    process.exit(1);
+  }
+}
+
+main().catch(console.error);

package/test-plugin/scripts/help.ts

@@ -0,0 +1,29 @@
+#!/usr/bin/env tsx
+
+console.log(`
+Obsidian Plugin Config - Command Reference
+(Run these commands from obsidian-plugin-config directory)
+
+MIGRATION:
+  yarn migrate, m <path>           Migrate plugin to centralized architecture
+  yarn migrate --dry-run           Preview changes without applying (debugging)
+  yarn migrate -i, --interactive   Interactive plugin selection
+
+MAINTENANCE:
+  yarn start                       Install dependencies and update exports
+  yarn acp                         Add, commit, and push changes (with exports update)
+  yarn acp -ne, --no-exports       Add, commit, and push without updating exports
+  yarn update-version, v           Update version in centralized config
+  yarn help, h                     Show this help
+
+USAGE EXAMPLES:
+  yarn migrate "C:\\Users\\dev\\plugins\\my-plugin"
+  yarn migrate ../existing-plugin --dry-run
+  yarn m -i                        # Short interactive mode
+
+PATH CONVENTIONS:
+  - Windows absolute paths: Use quotes "C:\\path\\to\\plugin"
+  - Relative paths: No quotes needed ../plugin-name
+
+For detailed documentation: ARCHITECTURE-SUMMARY.md
+`);