obsidian-plugin-config 1.7.0 → 1.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/scripts/help.ts CHANGED
@@ -1,90 +1,87 @@
1
- #!/usr/bin/env tsx
2
-
3
- console.log(`
4
- 🎯 Obsidian Plugin Config - Quick Help
5
- Global CLI injection tool for Obsidian plugins
6
-
7
- ═══════════════════════════════════════════════════════════════════
8
-
9
- 📋 DEVELOPMENT COMMANDS
10
-
11
- GIT & VERSION:
12
- yarn acp # Add, commit, push
13
- yarn v, update-version # Update version
14
-
15
- LINTING:
16
- yarn lint, lint:fix # ESLint verification/correction
17
-
18
- INJECTION (local testing):
19
- yarn inject-prompt # Interactive injection
20
- yarn inject-path <path> # Direct injection
21
- yarn inject <path> --sass # Injection with SASS support
22
- yarn check-plugin <path> # Verification only (dry-run)
23
-
24
- NPM PUBLISHING:
25
- yarn npm-publish # Full workflow (5 steps):
26
- # 1. version bump
27
- # 2. generate bin
28
- # 3. verify package
29
- # 4. commit + push
30
- # 5. publish to NPM
31
-
32
- HELP:
33
- yarn h # This help
34
-
35
- ═══════════════════════════════════════════════════════════════════
36
-
37
- 🏗️ ARCHITECTURE
38
-
39
- PURE INJECTION TOOL:
40
- templates/ # Files to inject into target plugins
41
- scripts/inject-*.ts # Injection logic
42
- bin/obsidian-inject.js # Global CLI entry point
43
-
44
- templates/ what gets injected:
45
- templates/package.json # Base deps/scripts for target plugins
46
- templates/package-sass.json # Extra deps when --sass is used
47
- templates/tsconfig.json # TypeScript config
48
- templates/scripts/* # Scripts copied to target
49
- templates/eslint.config.mts # ESLint config
50
- templates/.github/workflows/* # GitHub Actions
51
-
52
- inject-core.ts shared injection logic:
53
- updatePackageJson() # Merges template package.json
54
- injectScripts() # Copies template files to target
55
- performInjection() # Main orchestration
56
-
57
- inject-path.ts — CLI entry point:
58
- Parses --yes, --dry-run, --sass flags
59
-
60
- inject-prompt.ts — interactive entry:
61
- Prompts for target path
62
-
63
- ═══════════════════════════════════════════════════════════════════
64
-
65
- 🔧 WORKFLOWS
66
-
67
- Development:
68
- 1. Make changes to templates/ or scripts/
69
- 2. yarn lint:fix # Fix code issues
70
- 3. yarn npm-publish # Version, commit, publish
71
-
72
- Global CLI Usage:
73
- obsidian-inject # Inject in current dir
74
- obsidian-inject ../my-plugin # Inject by path
75
- obsidian-inject ../my-plugin --sass # With SASS
76
- obsidian-inject --help # Show help
77
-
78
- Local Testing:
79
- yarn inject-prompt # Interactive
80
- yarn inject-path ../my-plugin # Direct
81
- yarn check-plugin ../my-plugin # Dry-run
82
-
83
- SASS Support (--sass flag):
84
- ✅ esbuild-sass-plugin dependency
85
- ✅ Automatic .scss detection (src/styles.scss priority)
86
- ✅ CSS cleanup after compilation
87
-
88
- ═══════════════════════════════════════════════════════════════════
89
-
90
- `);
1
+ #!/usr/bin/env tsx
2
+
3
+ console.log(`
4
+ 🎯 Obsidian Plugin Config - Quick Help
5
+ Global CLI injection tool for Obsidian plugins
6
+
7
+ ═══════════════════════════════════════════════════════════════════
8
+
9
+ 📋 DEVELOPMENT COMMANDS
10
+
11
+ GIT & VERSION:
12
+ yarn acp # Add, commit, push
13
+ yarn v, update-version # Update version
14
+
15
+ LINTING:
16
+ yarn lint, lint:fix # ESLint verification/correction
17
+
18
+ INJECTION (local testing):
19
+ yarn inject-prompt # Interactive injection
20
+ yarn inject-path <path> # Direct injection
21
+ yarn check-plugin <path> # Verification only (dry-run)
22
+
23
+ NPM PUBLISHING:
24
+ yarn npm-publish # Full workflow (5 steps):
25
+ # 1. version bump
26
+ # 2. generate bin
27
+ # 3. verify package
28
+ # 4. commit + push
29
+ # 5. publish to NPM
30
+
31
+ HELP:
32
+ yarn h # This help
33
+
34
+ ═══════════════════════════════════════════════════════════════════
35
+
36
+ 🏗️ ARCHITECTURE
37
+
38
+ PURE INJECTION TOOL:
39
+ templates/ # Files to inject into target plugins
40
+ scripts/inject-*.ts # Injection logic
41
+ bin/obsidian-inject.js # Global CLI entry point
42
+
43
+ templates/ → what gets injected:
44
+ templates/package.json # Base deps/scripts for target plugins
45
+ templates/tsconfig.json # TypeScript config
46
+ templates/scripts/* # Scripts copied to target
47
+ templates/eslint.config.mts # ESLint config
48
+ templates/.github/workflows/* # GitHub Actions
49
+
50
+ inject-core.ts shared injection logic:
51
+ updatePackageJson() # Merges template package.json
52
+ injectScripts() # Copies template files to target
53
+ performInjection() # Main orchestration
54
+
55
+ inject-path.ts CLI entry point:
56
+ Parses --yes, --dry-run flags
57
+
58
+ inject-prompt.ts interactive entry:
59
+ Prompts for target path
60
+
61
+ ═══════════════════════════════════════════════════════════════════
62
+
63
+ 🔧 WORKFLOWS
64
+
65
+ Development:
66
+ 1. Make changes to templates/ or scripts/
67
+ 2. yarn lint:fix # Fix code issues
68
+ 3. yarn npm-publish # Version, commit, publish
69
+
70
+ Global CLI Usage:
71
+ obsidian-inject # Inject in current dir
72
+ obsidian-inject ../my-plugin # Inject by path
73
+ obsidian-inject --help # Show help
74
+
75
+ Local Testing:
76
+ yarn inject-prompt # Interactive
77
+ yarn inject-path ../my-plugin # Direct
78
+ yarn check-plugin ../my-plugin # Dry-run
79
+
80
+ SASS Support (automatic):
81
+ Automatic .scss detection (src/styles.scss priority)
82
+ ✅ CSS cleanup after compilation
83
+ 💡 Install esbuild-sass-plugin manually if you use SCSS
84
+
85
+ ═══════════════════════════════════════════════════════════════════
86
+
87
+ `);