Merge branch 'release/0.2.3'

.nycrc.json

@@ -3,14 +3,8 @@
   "extends": "@istanbuljs/nyc-config-typescript",
   "all": true,
   "check-coverage": false,
-  "extensions": [
-    ".ts"
-  ],
-  "reporter": [
-    "text",
-    "html",
-    "lcov"
-  ],
+  "extensions": [".ts"],
+  "reporter": ["text", "html", "lcov"],
   "exclude": [
     "eslint.config.cjs",
     "coverage/**",

README.md

@@ -47,7 +47,7 @@ Install plugins in specified vaults.
 
 ### `ovm plugins prune`
 
-Prune plugins from specified vaults.
+Prune plugin/s from specified vaults.
 
 - _Usage:_ `ovm help plugins prune`
 - _See code:_ [src/commands/plugins/prune.ts](src/commands/plugins/prune.ts)

package.json

@@ -2,7 +2,7 @@
   "name": "ovm",
   "description": "Obsidian Vaults Manager",
   "type": "commonjs",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "license": "MIT",
   "author": "Masoud Ghorbani",
   "homepage": "https://github.com/msudgh/ovm",
@@ -41,8 +41,7 @@
     "dirname": "ovm",
     "commands": "./dist/commands",
     "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-not-found"
+      "@oclif/plugin-help"
     ],
     "topicSeparator": " ",
     "topics": {
@@ -64,7 +63,6 @@
     "@inquirer/prompts": "^5.2.1",
     "@oclif/core": "^4.0.12",
     "@oclif/plugin-help": "^6.2.6",
-    "@oclif/plugin-not-found": "^3.2.12",
     "async": "^3.2.5",
     "glob": "^11.0.0",
     "inquirer": "^10.0.4",

src/commands/config/init.ts

@@ -45,7 +45,7 @@ export default class Init extends FactoryCommand {
     flags: FactoryFlags<CommonFlags>,
   ): Promise<void> {
     try {
-      const { data: config, error } = await safeLoadConfig()
+      const { data: config, error } = await safeLoadConfig(flags.config)
 
       if (config) {
         logger.error('File already exists!', { config: flags.config })

src/commands/plugins/install.ts

@@ -6,7 +6,7 @@ import {
   Vault,
 } from 'obsidian-utils'
 import FactoryCommand, { FactoryFlags } from '../../providers/command'
-import { Config, Plugin, safeLoadConfig, writeConfig } from '../../providers/config'
+import { Config, safeLoadConfig, writeConfig } from '../../providers/config'
 import {
   findPluginInRegistry,
   handleExceedRateLimitError,
@@ -95,7 +95,7 @@ export default class Install extends FactoryCommand {
       success: loadConfigSuccess,
       data: config,
       error: loadConfigError,
-    } = await safeLoadConfig()
+    } = await safeLoadConfig(flags.config)
 
     if (!loadConfigSuccess) {
       logger.error('Failed to load config', { error: loadConfigError })
@@ -108,24 +108,24 @@ export default class Install extends FactoryCommand {
     // Check if pluginId is provided and install only that plugin
     const { pluginId } = args
     if (pluginId) {
-      await this.installPluginInVaults(selectedVaults, pluginId, enable)
+      await this.installPluginInVaults(selectedVaults, config, flags, pluginId)
     } else {
-      await this.installPluginsInVaults(selectedVaults, config.plugins, enable)
+      await this.installPluginsInVaults(selectedVaults, config, flags, enable)
     }
   }
 
   private async installPluginsInVaults(
     vaults: Vault[],
-    plugins: Plugin[],
-    enable: boolean,
+    config: Config,
+    flags: FactoryFlags<InstallFlags>,
     specific = false,
   ) {
     const installVaultIterator = async (vault: Vault) => {
       logger.debug(`Install plugins for vault`, { vault })
       const installedPlugins = []
       const failedPlugins = []
 
-      for (const stagePlugin of plugins) {
+      for (const stagePlugin of config.plugins) {
         const childLogger = logger.child({ stagePlugin, vault })
 
         const pluginInRegistry = await findPluginInRegistry(stagePlugin.id)
@@ -138,7 +138,7 @@ export default class Install extends FactoryCommand {
           continue
         }
 
-       stagePlugin.version = stagePlugin.version ?? 'latest';
+        stagePlugin.version = stagePlugin.version ?? 'latest'
 
         try {
           await installPluginFromGithub(
@@ -151,15 +151,16 @@ export default class Install extends FactoryCommand {
             version: stagePlugin.version,
           })
 
-          if (enable) {
+          if (flags.enable) {
             // Enable the plugin
             await modifyCommunityPlugins(stagePlugin, vault.path, 'enable')
           }
 
           if (specific) {
             // Add the plugin to the config
-            const newPlugins = new Set([...plugins])
-            await writeConfig({ plugins: [...newPlugins] })
+            const newPlugins = new Set([...config.plugins])
+            const updatedConfig = { ...config, plugins: [...newPlugins] }
+            await writeConfig(updatedConfig, flags.config)
           }
 
           childLogger.debug(`Installed plugin`)
@@ -190,12 +191,22 @@ export default class Install extends FactoryCommand {
     })
   }
 
-  private async installPluginInVaults(vaults: Vault[], id: string, enable: boolean) {
-    const pluginInRegistry = await findPluginInRegistry(id)
+  private async installPluginInVaults(
+    vaults: Vault[],
+    config: Config,
+    flags: FactoryFlags<InstallFlags>,
+    pluginId: string,
+  ) {
+    const pluginInRegistry = await findPluginInRegistry(pluginId)
     if (!pluginInRegistry) {
-      throw new PluginNotFoundInRegistryError(id)
+      throw new PluginNotFoundInRegistryError(pluginId)
     }
 
-    await this.installPluginsInVaults(vaults, [{ id }], enable, true)
+    await this.installPluginsInVaults(
+      vaults,
+      { ...config, plugins: [{ id: pluginId }] },
+      flags,
+      true,
+    )
   }
 }

src/commands/plugins/prune.ts

@@ -22,7 +22,7 @@ interface PrunePluginVaultOpts {
  */
 export default class Prune extends FactoryCommand {
   static readonly aliases = ['pp', 'plugins:prune']
-  static override readonly description = `Prune plugins from specified vaults.`
+  static override readonly description = `Prune plugin/s from specified vaults.`
   static override readonly examples = [
     '<%= config.bin %> <%= command.id %> --path=/path/to/vaults',
     '<%= config.bin %> <%= command.id %> --path=/path/to/vaults/*/.obsidian',
@@ -70,7 +70,7 @@ export default class Prune extends FactoryCommand {
       success: loadConfigSuccess,
       data: config,
       error: loadConfigError,
-    } = await safeLoadConfig()
+    } = await safeLoadConfig(flags.config)
 
     if (!loadConfigSuccess) {
       logger.error('Failed to load config', { error: loadConfigError })

src/commands/plugins/uninstall.ts

@@ -80,7 +80,7 @@ export default class Uninstall extends FactoryCommand {
       success: loadConfigSuccess,
       data: config,
       error: loadConfigError,
-    } = await safeLoadConfig()
+    } = await safeLoadConfig(flags.config)
 
     if (!loadConfigSuccess) {
       logger.error('Failed to load config', { error: loadConfigError })

src/commands/reports/stats.ts

@@ -69,7 +69,7 @@ export default class Stats extends FactoryCommand {
       success: loadConfigSuccess,
       data: config,
       error: loadConfigError,
-    } = await safeLoadConfig()
+    } = await safeLoadConfig(flags.config)
     if (!loadConfigSuccess) {
       logger.error('Failed to load config', { error: loadConfigError })
       process.exit(1)

src/providers/config.test.ts

@@ -1,4 +1,4 @@
-import { createDefaultConfig, safeLoadConfig } from './config'
+import { ConfigSchema, safeLoadConfig } from './config'
 
 import { expect } from 'chai'
 import mock from 'mock-fs'
@@ -9,7 +9,7 @@ describe('Config', () => {
     const userHome = '/home/user'
     const configPath = `${userHome}/${OVM_CONFIG_FILENAME}`
 
-    const sampleDefaultConfig = await createDefaultConfig()
+    const sampleDefaultConfig = ConfigSchema.parse({})
 
     mock({
       [userHome]: {
@@ -20,8 +20,8 @@ describe('Config', () => {
     const config = await safeLoadConfig(configPath)
 
     expect(config.success).to.be.true
-    expect(config.data).to.deep.equal(config.data)
     expect(config.error).to.be.undefined
+    expect(config.data).to.deep.equal(sampleDefaultConfig)
     mock.restore()
   })
 

src/providers/config.ts

@@ -1,7 +1,6 @@
 import { readFileSync, writeFileSync } from 'fs'
 import { GitHubPluginVersion } from 'obsidian-utils'
 import z from 'zod'
-import { DEFAULT_CONFIG_PATH } from '../constants'
 import { logger } from '../utils/logger'
 
 const PluginSchema = z.object({
@@ -35,9 +34,7 @@ type SafeLoadConfigResult =
     } & SafeLoadConfigResultSuccess)
   | SafeLoadConfigResultError
 
-export const safeLoadConfig = (
-  configPath = DEFAULT_CONFIG_PATH,
-): Promise<SafeLoadConfigResult> => {
+export const safeLoadConfig = (configPath: string): Promise<SafeLoadConfigResult> => {
   return new Promise((resolve) => {
     try {
       const config = readFileSync(configPath)
@@ -70,14 +67,14 @@ export const safeLoadConfig = (
 
 export const writeConfig = (
   config: Config,
-  configPath = DEFAULT_CONFIG_PATH,
+  configPath: string,
 ): Promise<void | Error> => {
   logger.debug('Writing config', { configPath })
   return new Promise((resolve, reject) => {
     try {
       const content = JSON.stringify(config, null, 2)
       writeFileSync(configPath, content)
-      logger.debug('Config written', { configPath })  
+      logger.debug('Config written', { configPath })
       resolve()
     } catch (error) {
       reject(error as Error)
@@ -86,12 +83,12 @@ export const writeConfig = (
 }
 
 export const createDefaultConfig = (
-  configPath = DEFAULT_CONFIG_PATH,
+  configPath: string,
 ): Promise<Config | Error> => {
   return new Promise((resolve, reject) => {
     try {
       const defaultConfig = ConfigSchema.parse({})
-      writeConfig(defaultConfig)
+      writeConfig(defaultConfig, configPath)
 
       logger.debug('Default config created', { configPath })
 

tsconfig.json

@@ -8,16 +8,11 @@
     "rootDir": "src",
     "strict": true,
     "esModuleInterop": true,
-    "types": [
-      "node",
-      "mocha"
-    ],
+    "types": ["node", "mocha"],
     "noImplicitAny": true,
     "skipLibCheck": false,
     "sourceMap": true,
     "forceConsistentCasingInFileNames": true
   },
-  "include": [
-    "src/**/*"
-  ]
+  "include": ["src/**/*"]
 }