@typinghare/trick 2.0.1 → 2.1.1

package/src/error.ts

@@ -1,82 +1,95 @@
-import chalk from 'chalk'
+import { error, warning } from './console.js'
 
+/**
+ * Thrown when the root directory is not found.
+ */
+export class RootDirectoryNotFoundError extends Error {
+  public constructor() {
+    super('Root directory not found')
+  }
+}
+
+/**
+ * Thrown when fail to write the configuration file.
+ */
 export class WriteConfigError extends Error {
-    public constructor(err: any) {
-        super(`Fail to write the configuration file. ${err}`)
-    }
+  public constructor(err: any) {
+    super(`Fail to write the configuration file. ${err}`)
+  }
 }
 
+/**
+ * Thrown when fail to read the configuration file.
+ */
 export class ReadConfigError extends Error {
-    public constructor(err: any) {
-        super(`Fail to read the configuration file: ${err}`)
-    }
+  public constructor(err: any) {
+    super(`Fail to read the configuration file: ${err}`)
+  }
 }
 
+/**
+ * Thrown when the specified target is not found in the configuration.
+ */
 export class TargetNotFoundError extends Error {
-    public constructor(public readonly targetName: string) {
-        super(`Target not found: ${targetName}`)
-    }
+  public constructor(public readonly targetName: string) {
+    super(`Target not found: ${targetName}`)
+  }
 }
 
+/**
+ * Thrown when fail to encrypt the source file.
+ */
 export class FailToEncryptFileError extends Error {
-    public constructor(
-        public readonly srcFilePath: string,
-        public readonly opensslErrMessage?: string
-    ) {
-        super(`Fail to encrypt source file: ${srcFilePath}`)
-    }
+  public constructor(
+    public readonly srcFilePath: string,
+    public readonly opensslErrMessage?: string
+  ) {
+    super(`Fail to encrypt source file: ${srcFilePath}`)
+  }
 }
 
+/**
+ * Thrown when fail to decrypt the source file.
+ */
 export class FailToDecryptFileError extends Error {
-    public constructor(
-        public readonly destFilePath: string,
-        public readonly opensslErrMessage?: string
-    ) {
-        super(`Fail to decrypt destination file: ${destFilePath}`)
-    }
+  public constructor(
+    public readonly destFilePath: string,
+    public readonly opensslErrMessage?: string
+  ) {
+    super(`Fail to decrypt destination file: ${destFilePath}`)
+  }
 }
 
+/**
+ * Thrown when the passphrase file is not found.
+ */
 export class PassphraseFileNotFoundError extends Error {
-    public constructor(public readonly passphraseFilePath: string) {
-        super(`Passphrase file not found: ${passphraseFilePath}`)
-    }
+  public constructor(public readonly passphraseFilePath: string) {
+    super(`Passphrase file not found: ${passphraseFilePath}`)
+  }
 }
 
-export class PassphraseNotFoundError extends Error {
-    public constructor(
-        public readonly passphraseFilePath: string,
-        public readonly targetName: string
-    ) {
-        super(
-            `Passphrase for target ${targetName} is not found in the passphrase file: ${passphraseFilePath}`
-        )
-    }
-}
+export function resolveError(err: any): void {
+  if (!(err instanceof Error)) {
+    console.error(error(`Unknown error: ${err}`))
+    process.exit(2)
+  }
 
-export function resolve_error(err: any): void {
-    if (!(err instanceof Error)) {
-        console.error(`Unknown error: ${err}`)
-        process.exit(2)
-    }
+  if (err.message) {
+    console.error(error(err.message))
+  }
 
-    if (err.message) {
-        console.log(chalk.red(err.message))
-    }
-
-    if (
-        err instanceof FailToEncryptFileError ||
-        err instanceof FailToDecryptFileError
-    ) {
-        if (err.opensslErrMessage) {
-            console.error(chalk.red(err.opensslErrMessage))
-        }
+  if (err instanceof PassphraseFileNotFoundError) {
+    console.error(warning(`Use the "set-passphrase" command to set the passphrase file.`))
+  }
 
-        console.error(
-            chalk.yellow(
-                'Make sure the file exists and you have enough permission to access it.'
-            )
-        )
+  if (err instanceof FailToEncryptFileError || err instanceof FailToDecryptFileError) {
+    if (err.opensslErrMessage) {
+      console.error(error(err.opensslErrMessage))
     }
 
-    process.exit(1)
+    console.error(warning('Make sure the file exists and you have enough permission to access it.'))
+  }
+
+  process.exit(1)
 }

package/src/index.ts

@@ -1,4 +1,7 @@
 export * from './app.js'
+export * from './color.js'
 export * from './config.js'
+export * from './console.js'
 export * from './encrypt.js'
+export * from './error.js'
 export * from './passphrase.js'

package/src/passphrase.ts

@@ -1,39 +1,37 @@
 import { Config } from './config.js'
 import fsExtra from 'fs-extra'
-import {
-    PassphraseFileNotFoundError,
-    PassphraseNotFoundError,
-} from './error.js'
+import { PassphraseFileNotFoundError } from './error.js'
 import os from 'node:os'
+import path from 'node:path'
+
+/**
+ * Gets the passphrase directory from the configuration.
+ *
+ * This function replaces any tilde (`~`) in the directory path with the user's home directory.
+ *
+ * @param config The configuration to use.
+ * @return The resolved passphrase directory path.
+ */
+export function getPassphraseDirectory(config: Config): string {
+  return config.passphraseDirectory.replaceAll(/~/g, os.homedir())
+}
 
 /**
  * Retrieves the passphrase from the passphrase file.
  *
- * First, gets the passphrase object from the passphrase file path specified in
- * the configuration object. Second, gets and returns the passphrase associated
- * with the given target name.
+ * The passphrase file is located in the directory specified by `config.passphraseDirectory`
+ * and is named after the `targetName`.
  *
  * @param config The configuration to use.
  * @param targetName The name of the target.
  * @return The passphrase associated with the target name.
  */
 export function getPassphrase(config: Config, targetName: string): string {
-    const passphraseFilePath = config.passphrase_file_path.replaceAll(
-        /~/g,
-        os.homedir()
-    )
-    if (!fsExtra.existsSync(passphraseFilePath)) {
-        throw new PassphraseFileNotFoundError(passphraseFilePath)
-    }
-
-    const passphraseObject = fsExtra.readJsonSync(passphraseFilePath) as {
-        [name: string]: string
-    }
-    const passphrase = passphraseObject[targetName] || null
+  const passphraseFilePath = path.join(getPassphraseDirectory(config), targetName)
 
-    if (passphrase === null) {
-        throw new PassphraseNotFoundError(passphraseFilePath, targetName)
-    }
+  if (!fsExtra.existsSync(passphraseFilePath)) {
+    throw new PassphraseFileNotFoundError(passphraseFilePath)
+  }
 
-    return passphrase
+  return fsExtra.readFileSync(passphraseFilePath, 'utf-8').trim()
 }

package/test/resources/task_info.yml

@@ -0,0 +1,4 @@
+response:
+  message: Ok
+  taskId: 12345
+  taskStatus: "in_progress"

package/test/resources/user_info.json

@@ -0,0 +1,5 @@
+{
+  "message": "Ok",
+  "userId": 123456,
+  "username": "TypingHare"
+}

package/test/trick.config.json

@@ -1,13 +1,18 @@
 {
-    "targets": {
-        "MyTestTarget": {
-            "files": ["resources/really.json", "resources/task.yml"]
-        }
-    },
-    "default_target_name": "MyTestTarget",
-    "root_directory": ".trick",
-    "passphrase_file_path": "~/.config/trick_passphrase.json",
-    "encryption": {
-        "iteration_count": 100000
+  "targets": {
+    "TRICK_TEST_ONE": {
+      "files": [
+        "resources/task_info.yml",
+        "resources/user_info.json"
+      ]
     }
-}
+  },
+  "trickRootDirectory": ".trick",
+  "passphraseDirectory": "~/.config/trick/passphrases",
+  "defaultTargetNames": [
+    "TRICK_TEST_ONE"
+  ],
+  "encryption": {
+    "iterationCount": 100000
+  }
+}

package/test/resources/really.json

@@ -1,4 +0,0 @@
-{
-    "message": "Ok",
-    "userId": 123456
-}

package/test/resources/task.yml

@@ -1,3 +0,0 @@
-response:
-  message: Ok
-  userId: 123456