obsidian-plugin-config 1.1.20 → 1.3.0

package/.injection-info.json

@@ -0,0 +1 @@
+{"injectorVersion": "1.1.20", "injectionDate": "2025-07-18T22:04:30.392Z", "injectorName": "obsidian-plugin-config"}

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+	"useTabs": true,
+	"tabWidth": 4,
+	"printWidth": 90,
+	"endOfLine": "lf",
+	"trailingComma": "none",
+	"semi": true,
+	"singleQuote": true,
+	"arrowParens": "always"
+}

package/.vscode/settings.json

@@ -1,4 +1,11 @@
 {
   "npm.packageManager": "yarn",
-  "typescript.preferences.includePackageJsonAutoImports": "off"
+  "js/ts.preferences.includePackageJsonAutoImports": "off",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "yzhang.markdown-all-in-one"
+  },
+  "editor.formatOnSave": true
 }

package/.vscode/tasks.json

@@ -0,0 +1,110 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"label": "Build",
+			"type": "shell",
+			"command": "yarn build",
+			"group": { "kind": "build", "isDefault": true },
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": ["$tsc"]
+		},
+		{
+			"label": "Dev (watch)",
+			"type": "shell",
+			"command": "yarn dev",
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": ["$tsc-watch"],
+			"isBackground": true
+		},
+		{
+			"label": "Real (build to vault)",
+			"type": "shell",
+			"command": "yarn real",
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": ["$tsc"]
+		},
+		{
+			"label": "Lint",
+			"type": "shell",
+			"command": "yarn lint",
+			"group": "test",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": ["$eslint-stylish"]
+		},
+		{
+			"label": "Lint: Fix",
+			"type": "shell",
+			"command": "yarn lint:fix",
+			"group": "test",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": ["$eslint-stylish"]
+		},
+		{
+			"label": "Prettier: Check",
+			"type": "shell",
+			"command": "npx prettier --check \"src/**/*.ts\"",
+			"group": "test",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		},
+		{
+			"label": "Prettier: Fix",
+			"type": "shell",
+			"command": "npx prettier --write \"src/**/*.ts\"",
+			"group": "test",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		},
+		{
+			"label": "Update Exports",
+			"type": "shell",
+			"command": "yarn update-exports",
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		},
+		{
+			"label": "ACP (add, commit, push)",
+			"type": "shell",
+			"command": "yarn acp",
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		},
+		{
+			"label": "BACP (build + acp)",
+			"type": "shell",
+			"command": "yarn bacp",
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		},
+		{
+			"label": "Version update",
+			"type": "shell",
+			"command": "yarn v",
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		},
+		{
+			"label": "NPM Publish",
+			"type": "shell",
+			"command": "yarn npm-publish",
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		},
+		{
+			"label": "Cleanup: Lint + Prettier + Build",
+			"dependsOrder": "sequence",
+			"dependsOn": ["Lint: Fix", "Prettier: Fix", "Build"],
+			"group": "build",
+			"presentation": { "reveal": "always", "panel": "shared" },
+			"problemMatcher": []
+		}
+	]
+}

package/README.md

@@ -23,7 +23,7 @@ npm update -g obsidian-plugin-config
 
 ```bash
 # Installation & Setup
-yarn i                   # Install dependencies
+yarn i, install                   # Install dependencies
 yarn update-exports      # Update package.json exports
 
 # Git & Version Management

package/bin/obsidian-inject.js

@@ -3,7 +3,7 @@
 /**
  * Obsidian Plugin Config - CLI Entry Point
  * Global command: obsidian-inject
- * Version: 1.1.20
+ * Version: 1.3.0
  */
 
 import { execSync } from 'child_process';

package/docs/EXPORTS-EXPLAINED.md

@@ -0,0 +1,164 @@
+# NPM Exports — How it works
+
+## The two roles of this repo
+
+### 1. Injection system (primary)
+
+The injection system copies scripts and config files
+**directly into target plugins**. After injection,
+the plugin is **100% standalone**.
+
+```
+templates/ → target-plugin/
+  scripts/utils.ts     → scripts/utils.ts
+  scripts/esbuild...   → scripts/esbuild...
+  tsconfig.json        → tsconfig.json
+  .gitignore           → .gitignore
+  ...
+```
+
+### 2. Exportable snippets (complementary)
+
+The `src/` directory contains reusable code
+(modals, helpers, utilities) that can be imported
+by other plugins via the NPM package.
+
+**These two systems are complementary, not opposed.**
+Injection provides the base infrastructure.
+Exports provide optional reusable components.
+
+---
+
+## How NPM exports work
+
+The `exports` field in `package.json`:
+```json
+{
+  "exports": {
+    ".": "./src/index.ts"
+  }
+}
+```
+
+This single entry is enough. `src/index.ts`
+re-exports everything from all submodules.
+
+### Importing in another plugin
+
+```ts
+// Import what you need
+import {
+  showConfirmModal,
+  NoticeHelper,
+  SettingsHelper
+} from "obsidian-plugin-config";
+```
+
+That's it. One import path covers everything.
+
+### What `update-exports` does
+
+Running `yarn update-exports` (or `yarn ue`):
+
+1. **Scans `src/` subdirectories** for folders
+   containing an `index.ts` file
+2. **Regenerates `src/index.ts`** with
+   `export * from` for each found module
+3. **Updates `package.json` `exports`** field
+
+Example: Adding `src/components/index.ts` and
+running `update-exports` will add:
+```ts
+// In src/index.ts:
+export * from './components/index.js';
+```
+
+---
+
+## Local development
+
+This repo also works as an Obsidian plugin for
+testing purposes. The `src/main.ts` loads a
+sample plugin that exercises the exportable code.
+
+### Why keep obsidian + obsidian-typings locally?
+
+The snippets in `src/` use Obsidian's API (modals,
+settings, notices). To develop and test these
+snippets, you need the Obsidian types available.
+
+You can:
+- Run `yarn build` to check for type errors
+- Run `yarn dev` to test in a vault
+- **Never** release this as a real plugin
+
+### Workflow for adding new snippets
+
+1. Create your module in `src/mymodule/`
+2. Add an `index.ts` that exports everything
+3. Run `yarn update-exports` to update the barrel
+4. Test locally with `yarn dev`
+5. When ready, publish via `yarn npm-publish`
+
+---
+
+## Injection scripts explained
+
+### `inject-path.ts` — Direct injection
+
+Options:
+- `--yes` / `-y` : Skip confirmation
+- `--sass` : Include SASS support
+- `--dry-run` / `--check` : Preview only
+
+### `inject-prompt.ts` — Interactive injection
+
+Prompts for target path and confirmation.
+
+### `obsidian-inject` CLI (global)
+
+```bash
+npm install -g obsidian-plugin-config
+obsidian-inject                     # Current dir
+obsidian-inject ../my-plugin        # By path
+obsidian-inject ../my-plugin --sass # With SASS
+```
+
+### `build-npm.ts` — NPM publish workflow
+
+Automates: version → commit → push → exports →
+bin → publish.
+
+> **Tip**: Run `npm login` first, or visit
+> https://www.npmjs.com/ to get your auth token.
+
+### `update-exports.js` — Refresh exports
+
+Scans `src/` and regenerates `src/index.ts` and
+the `exports` field in `package.json`.
+
+---
+
+## SASS support
+
+The template `esbuild.config.ts` handles SASS
+automatically via dynamic import:
+```ts
+const { sassPlugin } =
+  await import('esbuild-sass-plugin');
+```
+
+If `.scss` files are detected in `src/`, the SASS
+plugin is loaded. If not installed, it warns you.
+
+The `--sass` injection flag adds
+`esbuild-sass-plugin` to the target's dependencies.
+
+---
+
+## Svelte support (planned)
+
+Not yet implemented. Would require:
+- `esbuild-svelte` package
+- `svelte` compiler
+- Detection of `.svelte` files in esbuild config

package/docs/IMPROVEMENT-PLAN-FOR-LLM.md

@@ -0,0 +1,239 @@
+# Instructions for LLM — obsidian-plugin-config v2
+
+## Context
+
+This repo has TWO complementary roles:
+
+1. **Injection system**: copies scripts + configs
+   into Obsidian plugin repos via NPM global CLI
+2. **Snippet development**: local workspace to
+   create/test reusable code (modals, helpers)
+   exported via NPM for other plugins to import
+
+**Root**:
+`c:\Users\dd200\Documents\Mes_projets\Mes repo obsidian new\obsidian-plugin-config`
+
+---
+
+## Tasks to execute (in order)
+
+### Task 1: Create `scripts/inject-core.ts`
+
+Extract shared logic from `scripts/inject-path.ts`
+and `scripts/inject-prompt.ts`.
+
+**Critical**: Simplify `findPluginConfigRoot()`.
+Remove ALL sibling directory detection
+(`../obsidian-plugin-config`). The function should:
+1. Check `import.meta.url` to find the NPM
+   package root
+2. Fallback to `process.cwd()`
+3. Nothing else
+
+Shared functions to extract:
+- `InjectionPlan` interface
+- `analyzePlugin()`
+- `findPluginConfigRoot()` (simplified as above)
+- `copyFromLocal()`
+- `ensurePluginConfigClean()`
+- `showInjectionPlan()`
+- `cleanOldScripts()`
+- `cleanOldLintFiles()`
+- `injectScripts()` — use inject-path version
+  (more complete)
+- `updatePackageJson()` — use inject-path version
+- `analyzeCentralizedImports()`
+- `createRequiredDirectories()`
+- `createInjectionInfo()`
+- `readInjectionInfo()`
+- `cleanNpmArtifactsIfNeeded()`
+- `ensureTsxInstalled()`
+- `runYarnInstall()`
+- `performInjection()` — main orchestration
+
+**Remove**: All debug logging (lines with
+`CRITICAL DEBUG`, `FINAL CHECK`, `VERIFICATION`).
+
+### Task 2: Simplify `scripts/inject-path.ts`
+
+Keep only:
+- CLI argument parsing
+- Dry-run display logic
+- Call to inject-core functions
+- `main()` + script execution
+
+### Task 3: Simplify `scripts/inject-prompt.ts`
+
+Keep only:
+- Interactive prompting
+- Calls to inject-core functions
+- Add SASS support (currently missing)
+
+### Task 4: Fix ESLint configs
+
+**Both root AND template `eslint.config.mts`**:
+```diff
+-"@typescript-eslint/no-unused-vars": ["warn", { "args": "none" }],
+-"@typescript-eslint/ban-ts-comment": "off",
++"@typescript-eslint/no-unused-vars": ["error", { "args": "none", "varsIgnorePattern": "^_" }],
++"@typescript-eslint/ban-ts-comment": "warn",
+```
+
+### Task 5: Fix `tsconfig.json` (root)
+
+Remove nonexistent include:
+```diff
+ "include": [
+   "./src/**/*.ts",
+-  "./scripts/**/*.ts",
+-  "eslint.config.fix.d.ts"
++  "./scripts/**/*.ts"
+ ]
+```
+
+### Task 5b: Fix `templates/tsconfig.json`
+
+Fix obsidian-typings paths (the root tsconfig
+has the correct paths per official docs):
+```diff
+ "paths": {
+   "obsidian-typings/implementations": [
+-    "./node_modules/obsidian-typings/dist/cjs/implementations.cts",
+-    "./node_modules/obsidian-typings/dist/esm/implementations.mjs"
++    "./node_modules/obsidian-typings/dist/implementations.d.ts",
++    "./node_modules/obsidian-typings/dist/implementations.cjs"
+   ]
+ }
+```
+
+### Task 6: Fix `package.json`
+
+1. **Add prettier**: `"prettier": "^3.4.0"` to
+   `devDependencies`
+
+2. **Simplify exports** — replace entire exports:
+```json
+"exports": {
+  ".": "./src/index.ts"
+}
+```
+Remove `./scripts/*`, `./modals`, `./tools`,
+`./utils` — the root export covers everything.
+
+3. **Clean duplicate dependencies**:
+   Keep in `dependencies` only what the NPM CLI
+   needs at runtime:
+   - `tsx`, `fs-extra`, `esbuild`, `dotenv`,
+     `builtin-modules`, `dedent`, `semver`,
+     `@types/node`, `@types/semver`, `typescript`
+   Remove from `dependencies` (keep in devDeps):
+   - `obsidian`, `obsidian-typings`, `lodash`,
+     `@types/lodash`
+
+### Task 7: Remove path aliases from templates
+
+In `templates/scripts/esbuild.config.ts`, **delete
+the entire `path-alias` plugin**:
+```ts
+// DELETE THIS ENTIRE PLUGIN:
+{
+  name: "path-alias",
+  setup: (build) => {
+    build.onResolve({ filter: /^@config\// }, ...);
+    build.onResolve({ filter: /^@config-scripts\// }, ...);
+  }
+}
+```
+
+Do the same in the root `scripts/esbuild.config.ts`.
+
+### Task 8: Complete injection — add missing files
+
+In `inject-core.ts`, add to `configFiles`:
+- `templates/.editorconfig`
+- `templates/.prettierrc`
+- `templates/.npmrc`
+- `templates/.env`
+- `templates/.vscode/tasks.json`
+
+Add `prettier` to `requiredDeps` in
+`updatePackageJson()`.
+
+### Task 9: Delete obsolete files
+
+- `templates/package-versions.json`
+- `templates/package-versions-sass.json`
+- `templates/scripts/esbuild.config-sass.ts`
+
+### Task 10: Fix `build-npm.ts`
+
+Replace fragile echo piping:
+```diff
+-execSync('echo 1 | tsx scripts/update-version-config.ts', ...);
++execSync('tsx scripts/update-version-config.ts', ...);
+```
+
+Replace hardcoded `"1.8.9"` with:
+```ts
+const manifest = JSON.parse(
+  fs.readFileSync("manifest.json", "utf8")
+);
+versions[packageJson.version] =
+  manifest.minAppVersion;
+```
+
+### Task 11: Translate French comments
+
+All templates — replace French comments with
+English. Examples:
+```diff
+-// Plugin pour gérer les alias de chemin
++// Plugin to handle path aliases
+```
+(This specific one will be deleted with the
+path-alias plugin, but check all files)
+
+### Task 12: Update help scripts
+
+Update `scripts/help.ts` to document the
+simplified architecture.
+
+### Task 13: Align root `.vscode/settings.json`
+
+Add formatter settings from template:
+```json
+{
+  "npm.packageManager": "yarn",
+  "js/ts.preferences.includePackageJsonAutoImports": "off",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "yzhang.markdown-all-in-one"
+  },
+  "editor.formatOnSave": true
+}
+```
+
+### Task 14: Simplify `update-exports.js`
+
+Since exports are simplified to just `"."`,
+update-exports should:
+1. Still scan `src/` and regenerate `src/index.ts`
+2. Set exports to just `{ ".": "./src/index.ts" }`
+   (remove the loop that adds per-module exports)
+
+---
+
+## Important constraints
+
+- **Line length**: Max 100 characters per line
+- **Language**: All code and comments in English
+- **Verification**: After modifications, run:
+  - `yarn build` (TypeScript check)
+  - `yarn lint` (ESLint check)
+- Uses `yarn` — never `npm`
+- ESM (`"type": "module"`)
+- Templates are NOT linted (`templates/**` ignored)
+- Keep `obsidian` and `obsidian-typings` in
+  devDependencies for local snippet development

package/eslint.config.mts

@@ -33,14 +33,14 @@ const configs: Linter.Config[] = [
     rules: {
       // Base rules
       "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": ["warn", { "args": "none" }],
-      "@typescript-eslint/ban-ts-comment": "off",
+      "@typescript-eslint/no-unused-vars": ["error", { "args": "none", "varsIgnorePattern": "^_" }],
+      "@typescript-eslint/ban-ts-comment": "warn",
       "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",
+      "@typescript-eslint/explicit-function-return-type": ["warn", { "allowExpressions": true }],
 
       // Disable overly strict rules
       "@typescript-eslint/no-unsafe-assignment": "off",

package/manifest.json

@@ -4,7 +4,7 @@
   "version": "1.0.0",
   "minAppVersion": "0.15.0",
   "description": "Development and testing environment for obsidian-plugin-config NPM exports and injection system",
-  "author": "Your Name",
+  "author": "3C0D",
   "authorUrl": "",
   "fundingUrl": "",
   "isDesktopOnly": false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-plugin-config",
-  "version": "1.1.20",
+  "version": "1.3.0",
   "description": "Système d'injection pour plugins Obsidian autonomes",
   "type": "module",
   "main": "src/index.ts",
@@ -42,11 +42,7 @@
     "h": "tsx scripts/help.ts"
   },
   "exports": {
-    ".": "./src/index.ts",
-    "./scripts/*": "./scripts/*",
-    "./modals": "./src/modals/index.ts",
-    "./tools": "./src/tools/index.ts",
-    "./utils": "./src/utils/index.ts"
+    ".": "./src/index.ts"
   },
   "devDependencies": {
     "@types/eslint": "latest",
@@ -64,6 +60,7 @@
     "jiti": "latest",
     "obsidian": "*",
     "obsidian-typings": "^3.9.5",
+    "prettier": "^3.4.0",
     "semver": "^7.7.2",
     "tsx": "^4.19.4",
     "typescript": "^5.8.2"

package/scripts/build-npm.ts

@@ -204,7 +204,7 @@ function buildAndPublishNpm(): void {
   try {
     // Step 1: Update version and push to GitHub
     console.log(`📋 Step 1/6: Updating version...`);
-    execSync('echo 1 | tsx scripts/update-version-config.ts', { stdio: 'inherit' });
+    execSync('tsx scripts/update-version-config.ts', { stdio: 'inherit' });
 
     // Step 2: Commit and push any remaining changes
     console.log(`\n📤 Step 2/6: Committing and pushing changes...`);
@@ -289,7 +289,8 @@ function verifyPackage(): void {
   }
 
   if (!versions[packageJson.version]) {
-    versions[packageJson.version] = "1.8.9";
+    const manifest = JSON.parse(fs.readFileSync("manifest.json", "utf8"));
+    versions[packageJson.version] = manifest.minAppVersion;
     fs.writeFileSync(versionsPath, JSON.stringify(versions, null, "\t"), "utf8");
     console.log(`   ✅ Added version ${packageJson.version} to versions.json`);
   } else {

package/scripts/esbuild.config.ts

@@ -183,25 +183,6 @@ async function createBuildContext(buildPath: string, isProd: boolean, entryPoint
     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 => {