obsidian-plugin-config 1.5.12 → 1.6.1

package/scripts/inject-options.ts

@@ -0,0 +1,139 @@
+#!/usr/bin/env tsx
+
+import type { Interface } from 'readline';
+
+export interface InjectionOptions {
+	scripts: boolean;
+	packageJson: boolean;
+	tsconfig: boolean;
+	eslint: boolean;
+	prettier: boolean;
+	editorconfig: boolean;
+	vscode: boolean;
+	github: boolean;
+	gitignore: boolean;
+	env: boolean;
+}
+
+export const DEFAULT_OPTIONS: InjectionOptions = {
+	scripts: true,
+	packageJson: true,
+	tsconfig: true,
+	eslint: true,
+	prettier: true,
+	editorconfig: true,
+	vscode: true,
+	github: true,
+	gitignore: true,
+	env: true
+};
+
+const OPTION_DESCRIPTIONS: Record<keyof InjectionOptions, string> = {
+	scripts: 'Scripts (esbuild.config.ts, acp.ts, utils.ts, etc.)',
+	packageJson: 'package.json (scripts & dependencies)',
+	tsconfig: 'tsconfig.json',
+	eslint: 'eslint.config.mts',
+	prettier: '.prettierrc & .prettierignore',
+	editorconfig: '.editorconfig',
+	vscode: '.vscode/ (settings.json, tasks.json, extensions.json)',
+	github: '.github/workflows/ (release workflow)',
+	gitignore: '.gitignore',
+	env: '.env (template)'
+};
+
+/**
+ * Ask user to select which files to inject
+ */
+export async function askInjectionOptions(
+	rl: Interface
+): Promise<InjectionOptions> {
+	const { askConfirmation } = await import('./utils.js');
+
+	console.log(`\n🎯 Injection Options`);
+	console.log(`Select what you want to inject (default: all)\n`);
+
+	const useDefaults = await askConfirmation(
+		'Use default options (inject everything)?',
+		rl
+	);
+
+	if (useDefaults) {
+		console.log(`✅ Using default options (all files will be injected)`);
+		return DEFAULT_OPTIONS;
+	}
+
+	console.log(`\n📋 Select individual options:\n`);
+
+	const options: InjectionOptions = { ...DEFAULT_OPTIONS };
+
+	for (const [key, description] of Object.entries(OPTION_DESCRIPTIONS)) {
+		const optionKey = key as keyof InjectionOptions;
+		const answer = await askConfirmation(`Inject ${description}?`, rl);
+		options[optionKey] = answer;
+	}
+
+	// Display summary
+	console.log(`\n📋 Selected options:`);
+	for (const [key, value] of Object.entries(options)) {
+		const optionKey = key as keyof InjectionOptions;
+		const icon = value ? '✅' : '❌';
+		console.log(`   ${icon} ${OPTION_DESCRIPTIONS[optionKey]}`);
+	}
+
+	const confirm = await askConfirmation('\nProceed with these options?', rl);
+	if (!confirm) {
+		console.log('❌ Injection cancelled');
+		process.exit(0);
+	}
+
+	return options;
+}
+
+/**
+ * Get quick preset options
+ */
+export function getPresetOptions(preset: string): InjectionOptions {
+	switch (preset) {
+		case 'minimal':
+			return {
+				scripts: true,
+				packageJson: true,
+				tsconfig: false,
+				eslint: false,
+				prettier: false,
+				editorconfig: false,
+				vscode: false,
+				github: false,
+				gitignore: false,
+				env: true
+			};
+		case 'scripts-only':
+			return {
+				scripts: true,
+				packageJson: false,
+				tsconfig: false,
+				eslint: false,
+				prettier: false,
+				editorconfig: false,
+				vscode: false,
+				github: false,
+				gitignore: false,
+				env: false
+			};
+		case 'config-only':
+			return {
+				scripts: false,
+				packageJson: false,
+				tsconfig: true,
+				eslint: true,
+				prettier: true,
+				editorconfig: true,
+				vscode: true,
+				github: false,
+				gitignore: true,
+				env: false
+			};
+		default:
+			return DEFAULT_OPTIONS;
+	}
+}

package/scripts/inject-path.ts

@@ -11,6 +11,7 @@ import {
 	showInjectionPlan
 } from './inject-core.js';
 import { createReadlineInterface, isValidPath } from './utils.js';
+import { askInjectionOptions, DEFAULT_OPTIONS, getPresetOptions } from './inject-options.js';
 
 const rl = createReadlineInterface();
 
@@ -23,15 +24,19 @@ async function main(): Promise<void> {
 		const autoConfirm = args.includes('--yes') || args.includes('-y');
 		const dryRun = args.includes('--dry-run') || args.includes('--check');
 		const useSass = args.includes('--sass');
+		const interactive = args.includes('--interactive') || args.includes('-i');
+		const preset = args.find(arg => arg.startsWith('--preset='))?.split('=')[1];
 		const targetPath = args.find((arg) => !arg.startsWith('-'));
 
 		if (!targetPath) {
 			console.error(`❌ Usage: yarn inject-path <plugin-directory> [options]`);
 			console.error(`   Example: yarn inject-path ../my-obsidian-plugin`);
 			console.error(`   Options:`);
-			console.error(`     --yes, -y       Auto-confirm injection`);
-			console.error(`     --dry-run       Check only (no injection)`);
-			console.error(`     --sass          Add esbuild-sass-plugin dependency`);
+			console.error(`     --yes, -y           Auto-confirm injection`);
+			console.error(`     --dry-run           Check only (no injection)`);
+			console.error(`     --sass              Add esbuild-sass-plugin dependency`);
+			console.error(`     --interactive, -i   Choose what to inject`);
+			console.error(`     --preset=<name>     Use preset (minimal, scripts-only, config-only)`);
 			console.error(`   Shortcuts:`);
 			console.error(`     yarn check-plugin ../plugin    # Verification only`);
 			process.exit(1);
@@ -150,7 +155,16 @@ async function main(): Promise<void> {
 			process.exit(0);
 		}
 
-		await performInjection(resolvedPath, useSass);
+		// Get injection options
+		let options = DEFAULT_OPTIONS;
+		if (preset) {
+			options = getPresetOptions(preset);
+			console.log(`\n🎯 Using preset: ${preset}`);
+		} else if (interactive) {
+			options = await askInjectionOptions(rl);
+		}
+
+		await performInjection(resolvedPath, options, useSass);
 	} catch (error) {
 		console.error(
 			`💥 Error: ${error instanceof Error ? error.message : String(error)}`

package/scripts/inject-prompt.ts

@@ -14,6 +14,7 @@ import {
 	createReadlineInterface,
 	isValidPath
 } from './utils.js';
+import { DEFAULT_OPTIONS } from './inject-options.js';
 
 const rl = createReadlineInterface();
 
@@ -95,7 +96,7 @@ async function main(): Promise<void> {
 			process.exit(0);
 		}
 
-		await performInjection(targetPath, useSass);
+		await performInjection(targetPath, DEFAULT_OPTIONS, useSass);
 	} catch (error) {
 		console.error(
 			`💥 Error: ${error instanceof Error ? error.message : String(error)}`

package/scripts/update-version-config.ts

@@ -52,10 +52,7 @@ async function updateJsonFile(
 
 async function updateConfigVersions(targetVersion: string): Promise<void> {
 	try {
-		await Promise.all([
-			updateJsonFile('package.json', (json) => (json.version = targetVersion)),
-			updateJsonFile('versions.json', (json) => (json[targetVersion] = '1.8.9'))
-		]);
+		await updateJsonFile('package.json', (json) => (json.version = targetVersion));
 	} catch (error) {
 		console.error(
 			'Error updating config versions:',
@@ -81,7 +78,7 @@ async function updateVersion(): Promise<void> {
 			console.log(`Files updated to version ${targetVersion}`);
 
 			// Add files to git
-			gitExec('git add package.json versions.json');
+			gitExec('git add package.json');
 			gitExec(`git commit -m "Updated to version ${targetVersion}"`);
 			console.log('Changes committed');
 		} catch (error) {

package/templates/.gitattributes

@@ -0,0 +1,4 @@
+# On Windows, git defaults to core.autocrlf=true which converts LF to CRLF and creates false modifications
+* text=auto eol=lf
+*.ts text eol=lf
+*.json text eol=lf

package/templates/.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "20.x"
+          node-version: "22.x"
 
       # Setup Yarn
       - name: Setup Yarn

package/templates/.prettierignore

@@ -0,0 +1,6 @@
+# Build output
+dist/
+main.js
+
+# Dependencies
+node_modules/

package/templates/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "editorconfig.editorconfig",
+    "yzhang.markdown-all-in-one"
+  ]
+}

package/templates/.vscode/settings.json

@@ -1,6 +1,5 @@
 {
   "npm.packageManager": "yarn",
-  // "js/ts.preferences.includePackageJsonAutoImports": "off",
   "[typescript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },

package/templates/package.json

@@ -19,8 +19,8 @@
     "h": "tsx scripts/help.ts",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "prettier": "npx prettier --check '**/*.{ts,json}'",
-    "prettier:fix": "npx prettier --write '**/*.{ts,json}'"
+    "prettier": "prettier --check '**/*.{ts,json}'",
+    "prettier:fix": "prettier --write '**/*.{ts,json}'"
   },
   "devDependencies": {
     "@types/eslint": "latest",
@@ -38,6 +38,7 @@
     "obsidian": "*",
     "obsidian-typings": "latest",
     "prettier": "latest",
+    "tslib": "2.4.0",
     "semver": "latest",
     "tsx": "^4.21.0",
     "typescript": "^5.8.2"

package/templates/scripts/esbuild.config.ts

@@ -143,7 +143,16 @@ async function validateEnvironment(): Promise<void> {
 }
 
 async function getBuildPath(isProd: boolean): Promise<string> {
-	// Check if we should use real vault (either -r flag or "real" argument)
+	// Check if we're already inside an Obsidian plugins folder
+	const pluginsPath = path.join('.obsidian', 'plugins');
+	const isInPluginsFolder = pluginDir.includes(pluginsPath);
+
+	if (isInPluginsFolder) {
+		console.log('ℹ️  Building in Obsidian plugins folder (in-place development)');
+		return pluginDir;
+	}
+
+	// External development: check for vault paths
 	const useRealVault = process.argv.includes('-r') || process.argv.includes('real');
 
 	// If production build without redirection, return plugin directory
@@ -155,28 +164,14 @@ async function getBuildPath(isProd: boolean): Promise<string> {
 	const envKey = useRealVault ? 'REAL_VAULT' : 'TEST_VAULT';
 	const vaultPath = process.env[envKey]?.trim();
 
-	// If empty or undefined, we're already in the plugin folder
-	if (!vaultPath) {
-		// Check if we're in Obsidian plugins folder
-		const currentPath = process.cwd();
-		const isInObsidianPlugins =
-			currentPath.includes('.obsidian/plugins') ||
-			currentPath.includes('.obsidian\\plugins');
-
-		if (isInObsidianPlugins) {
-			// In obsidian/plugins: allow in-place development
-			console.log(`ℹ️  Building in Obsidian plugins folder (in-place development)`);
-			return pluginDir;
-		} else {
-			// External development: prompt for missing vault path
-			const newPath = await promptForVaultPath(envKey);
-			await updateEnvFile(envKey, newPath);
-			config();
-			return getVaultPath(newPath);
-		}
+	// If empty or undefined, prompt for vault path
+	if (!vaultPath || vaultPath.startsWith('/path/to/your/')) {
+		const newPath = await promptForVaultPath(envKey);
+		await updateEnvFile(envKey, newPath);
+		config();
+		return getVaultPath(newPath);
 	}
 
-	// If we reach here, use the vault path directly
 	return getVaultPath(vaultPath);
 }
 

package/tsconfig.json

@@ -1,12 +1,6 @@
 {
   "compilerOptions": {
-    "types": ["obsidian-typings"],
-    "paths": {
-      "obsidian-typings/implementations": [
-        "./node_modules/obsidian-typings/dist/cjs/implementations.d.cts",
-        "./node_modules/obsidian-typings/dist/esm/implementations.mjs"
-      ]
-    },
+    "types": ["node"],
     "inlineSourceMap": true,
     "inlineSources": true,
     "module": "NodeNext",
@@ -25,6 +19,6 @@
     "resolveJsonModule": true,
     "lib": ["DOM", "ES2021"]
   },
-  "include": ["./src/**/*.ts", "./scripts/**/*.ts"],
+  "include": ["./scripts/**/*.ts"],
   "exclude": ["node_modules", "eslint.config.ts"]
 }

package/.injection-info.json

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

package/docs/EXPORTS-EXPLAINED.md

@@ -1,164 +0,0 @@
-# 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/manifest.json

@@ -1,11 +0,0 @@
-{
-  "id": "obsidian-plugin-config",
-  "name": "Obsidian Plugin Config",
-  "version": "1.0.0",
-  "minAppVersion": "0.15.0",
-  "description": "Development and testing environment for obsidian-plugin-config NPM exports and injection system",
-  "author": "3C0D",
-  "authorUrl": "",
-  "fundingUrl": "",
-  "isDesktopOnly": false
-}