@typinghare/trick 2.1.0 → 2.1.2

package/dist/app.js

@@ -8,7 +8,7 @@ import path from 'path';
 import { colorFilePath, colorTargetName } from './color.js';
 import { success, warning } from './console.js';
 const program = new Command();
-program.version('2.1.0');
+program.version('2.1.2');
 program.description('Save credential files to remote safely and easily.');
 program
     .command('config')
@@ -113,13 +113,11 @@ program
             return;
         }
         const rootDirectory = getRootDirectory();
-        const trickRootDirectory = path.resolve(rootDirectory, config.trickRootDirectory);
         for (const targetName of targetNames) {
             const target = getTargetFromConfig(config, targetName);
             const passphrase = getPassphrase(config, targetName);
             const srcFilePaths = target.files;
-            fsExtra.ensureDir(trickRootDirectory);
-            encryptFiles(srcFilePaths, trickRootDirectory, passphrase, config.encryption.iterationCount);
+            encryptFiles(config, rootDirectory, srcFilePaths, passphrase);
         }
     });
 });
@@ -137,13 +135,11 @@ program
             return;
         }
         const rootDirectory = getRootDirectory();
-        const trickRootDirectory = path.resolve(rootDirectory, config.trickRootDirectory);
         for (const targetName of targetNames) {
             const target = getTargetFromConfig(config, targetName);
             const passphrase = getPassphrase(config, targetName);
             const srcFilePaths = target.files;
-            fsExtra.ensureDir(trickRootDirectory);
-            decryptFiles(srcFilePaths, trickRootDirectory, passphrase, config.encryption.iterationCount);
+            decryptFiles(config, rootDirectory, srcFilePaths, passphrase);
         }
     });
 });
@@ -172,7 +168,7 @@ program
 });
 program
     .command('list-defaults')
-    .description('Display  the default target name.')
+    .description('Display the default target name.')
     .action(function () {
     updateConfig((config) => {
         for (const targetName of config.defaultTargetNames) {
@@ -202,17 +198,17 @@ program
         const passphraseDirectory = getPassphraseDirectory(config);
         if (!fsExtra.existsSync(passphraseDirectory)) {
             fsExtra.ensureDirSync(passphraseDirectory);
-            console.log(success(`Created passphrase directory: ${passphraseDirectory}`));
+            console.log(success(`Created passphrase directory: ${colorFilePath(passphraseDirectory)}`));
         }
         const passphraseFile = path.join(passphraseDirectory, targetName);
         if (!fsExtra.existsSync(passphraseFile)) {
             fsExtra.createFileSync(passphraseFile);
             fsExtra.chmodSync(passphraseFile, 0o600);
-            console.log(success(`Created passphrase file: ${passphraseFile}`));
+            console.log(success(`Created passphrase file: ${colorFilePath(passphraseFile)}`));
             console.log(success(`You have to edit the file to set the passphrase.`));
         }
         else {
-            console.log(warning(`Passphrase file already exists: ${passphraseFile}`));
+            console.log(warning(`Passphrase file already exists: ${colorFilePath(passphraseFile)}`));
         }
     });
 });

package/dist/color.d.ts

@@ -1,2 +1,4 @@
 export declare function colorTargetName(targetName: string): string;
 export declare function colorFilePath(filePath: string): string;
+export declare function colorSourceFilePath(filePath: string): string;
+export declare function colorTargetFilePath(message: string): string;

package/dist/color.js

@@ -5,3 +5,9 @@ export function colorTargetName(targetName) {
 export function colorFilePath(filePath) {
     return chalk.yellow(filePath);
 }
+export function colorSourceFilePath(filePath) {
+    return chalk.italic.green(filePath);
+}
+export function colorTargetFilePath(message) {
+    return chalk.italic.magenta(message);
+}

package/dist/encrypt.d.ts

@@ -1,3 +1,4 @@
+import { Config } from './config.js';
 /**
  * Encrypts a file using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
  *
@@ -36,25 +37,24 @@ export declare function decryptFile(srcFilePath: string, destFilePath: string, p
  * For each source file path provided, this function constructs the destination file path by
  * appending `.enc`, then calls `encryptFile` and logs the operation.
  *
+ * @param config The configuration object.
+ * @param rootDir The root directory where the trick configuration is located.
  * @param srcFilePaths An array of file paths to be encrypted.
- * @param destDir The directory where the encrypted files will be saved.
  * @param passphrase The passphrase used for encryption.
- * @param iterationCount The number of iterations to use for PBKDF2.
  * @returns Resolves when all files are successfully encrypted.
  * @throws {FailToEncryptFileError} If any file fails to encrypt.
  */
-export declare function encryptFiles(srcFilePaths: string[], destDir: string, passphrase: string, iterationCount: number): Promise<void>;
-/**
+export declare function encryptFiles(config: Config, rootDir: string, srcFilePaths: string[], passphrase: string): Promise<void>; /**
  * Decrypts multiple files using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
  *
  * For each source file path provided, this function assumes the corresponding encrypted file has
  * the `.enc` extension and calls `decryptFile`, logging the operation.
  *
+ * @param config The configuration object.
+ * @param rootDir The root directory where the trick configuration is located.
  * @param srcFilePaths An array of original file paths that were encrypted.
- * @param destDir The directory containing the encrypted files.
  * @param passphrase The passphrase used for decryption.
- * @param iterationCount The number of iterations used for PBKDF2.
  * @returns Resolves when all files are successfully decrypted.
  * @throws {FailToDecryptFileError} If any file fails to decrypt.
  */
-export declare function decryptFiles(srcFilePaths: string[], destDir: string, passphrase: string, iterationCount: number): Promise<void>;
+export declare function decryptFiles(config: Config, rootDir: string, srcFilePaths: string[], passphrase: string): Promise<void>;

package/dist/encrypt.js

@@ -3,6 +3,7 @@ import * as path from 'node:path';
 import fsExtra from 'fs-extra';
 import { FailToDecryptFileError, FailToEncryptFileError } from './error.js';
 import { success } from './console.js';
+import { colorSourceFilePath, colorTargetFilePath } from './color.js';
 /**
  * Encrypts a file using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
  *
@@ -106,37 +107,45 @@ export async function decryptFile(srcFilePath, destFilePath, passphrase, iterati
  * For each source file path provided, this function constructs the destination file path by
  * appending `.enc`, then calls `encryptFile` and logs the operation.
  *
+ * @param config The configuration object.
+ * @param rootDir The root directory where the trick configuration is located.
  * @param srcFilePaths An array of file paths to be encrypted.
- * @param destDir The directory where the encrypted files will be saved.
  * @param passphrase The passphrase used for encryption.
- * @param iterationCount The number of iterations to use for PBKDF2.
  * @returns Resolves when all files are successfully encrypted.
  * @throws {FailToEncryptFileError} If any file fails to encrypt.
  */
-export async function encryptFiles(srcFilePaths, destDir, passphrase, iterationCount) {
+export async function encryptFiles(config, rootDir, srcFilePaths, passphrase) {
+    const iterationCount = config.encryption.iterationCount;
+    const trickRootDirectory = config.trickRootDirectory;
+    fsExtra.ensureDir(path.join(rootDir, trickRootDirectory));
     for (const srcFilePath of srcFilePaths) {
-        const destFilePath = path.join(destDir, srcFilePath + '.enc');
-        await encryptFile(srcFilePath, destFilePath, passphrase, iterationCount);
-        console.log(success(`Encrypted: ${srcFilePath} -> ${destFilePath}`));
+        const destFilePath = path.join(trickRootDirectory, srcFilePath + '.enc');
+        const absoluteDestFilePath = path.join(rootDir, destFilePath);
+        const absoluteSrcFilePath = path.resolve(rootDir, srcFilePath);
+        await encryptFile(absoluteSrcFilePath, absoluteDestFilePath, passphrase, iterationCount);
+        console.log(success(`Encrypted: ${colorSourceFilePath(srcFilePath)} -> ${colorTargetFilePath(destFilePath)}`));
     }
-}
-/**
+} /**
  * Decrypts multiple files using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
  *
  * For each source file path provided, this function assumes the corresponding encrypted file has
  * the `.enc` extension and calls `decryptFile`, logging the operation.
  *
+ * @param config The configuration object.
+ * @param rootDir The root directory where the trick configuration is located.
  * @param srcFilePaths An array of original file paths that were encrypted.
- * @param destDir The directory containing the encrypted files.
  * @param passphrase The passphrase used for decryption.
- * @param iterationCount The number of iterations used for PBKDF2.
  * @returns Resolves when all files are successfully decrypted.
  * @throws {FailToDecryptFileError} If any file fails to decrypt.
  */
-export async function decryptFiles(srcFilePaths, destDir, passphrase, iterationCount) {
+export async function decryptFiles(config, rootDir, srcFilePaths, passphrase) {
+    const iterationCount = config.encryption.iterationCount;
+    const trickRootDirectory = config.trickRootDirectory;
     for (const srcFilePath of srcFilePaths) {
-        const destFilePath = path.join(destDir, srcFilePath + '.enc');
-        await decryptFile(srcFilePath, destFilePath, passphrase, iterationCount);
-        console.log(success(`Decrypted: ${destFilePath} -> ${srcFilePath}`));
+        const destFilePath = path.join(trickRootDirectory, srcFilePath + '.enc');
+        const absoluteDestFilePath = path.join(rootDir, destFilePath);
+        const absoluteSrcFilePath = path.resolve(rootDir, srcFilePath);
+        await decryptFile(absoluteSrcFilePath, absoluteDestFilePath, passphrase, iterationCount);
+        console.log(success(`Decrypted: ${colorTargetFilePath(destFilePath)} -> ${colorSourceFilePath(srcFilePath)}`));
     }
 }

package/package.json

@@ -1,19 +1,37 @@
 {
   "name": "@typinghare/trick",
   "description": "Save credential files to remote safely and easily.",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "bin": {
     "trick": "bin/trick"
   },
+  "scripts": {
+    "build": "node_modules/typescript/bin/tsc"
+  },
   "author": {
     "name": "James Chen",
     "email": "jameschan312.cn@gmail.com"
   },
   "homepage": "https://github.com/typinghare/trick",
   "license": "MIT",
+  "keywords": [
+    "cli",
+    "credentials",
+    "secrets",
+    "secret-management",
+    "config",
+    "dotenv",
+    "security",
+    "encryption",
+    "remote-storage",
+    "backup",
+    "sync",
+    "devops",
+    "tool"
+  ],
   "dependencies": {
     "chalk": "^5.6.2",
     "commander": "^14.0.2",
@@ -36,7 +54,5 @@
     "endOfLine": "lf",
     "printWidth": 100
   },
-  "scripts": {
-    "build": "node_modules/typescript/bin/tsc"
-  }
-}
+  "packageManager": "pnpm@10.27.0"
+}

package/src/app.ts

@@ -15,7 +15,7 @@ import { colorFilePath, colorTargetName } from './color.js'
 import { success, warning } from './console.js'
 
 const program = new Command()
-program.version('2.1.0')
+program.version('2.1.2')
 program.description('Save credential files to remote safely and easily.')
 
 program
@@ -136,14 +136,12 @@ program
       }
 
       const rootDirectory = getRootDirectory()
-      const trickRootDirectory = path.resolve(rootDirectory, config.trickRootDirectory)
       for (const targetName of targetNames) {
         const target: Target = getTargetFromConfig(config, targetName)
         const passphrase: string = getPassphrase(config, targetName)
         const srcFilePaths: string[] = target.files
 
-        fsExtra.ensureDir(trickRootDirectory)
-        encryptFiles(srcFilePaths, trickRootDirectory, passphrase, config.encryption.iterationCount)
+        encryptFiles(config, rootDirectory, srcFilePaths, passphrase)
       }
     })
   })
@@ -164,14 +162,12 @@ program
       }
 
       const rootDirectory = getRootDirectory()
-      const trickRootDirectory = path.resolve(rootDirectory, config.trickRootDirectory)
       for (const targetName of targetNames) {
         const target: Target = getTargetFromConfig(config, targetName)
         const passphrase: string = getPassphrase(config, targetName)
         const srcFilePaths: string[] = target.files
 
-        fsExtra.ensureDir(trickRootDirectory)
-        decryptFiles(srcFilePaths, trickRootDirectory, passphrase, config.encryption.iterationCount)
+        decryptFiles(config, rootDirectory, srcFilePaths, passphrase)
       }
     })
   })
@@ -205,7 +201,7 @@ program
 
 program
   .command('list-defaults')
-  .description('Display  the default target name.')
+  .description('Display the default target name.')
   .action(function (): void {
     updateConfig((config) => {
       for (const targetName of config.defaultTargetNames) {
@@ -237,17 +233,17 @@ program
       const passphraseDirectory = getPassphraseDirectory(config)
       if (!fsExtra.existsSync(passphraseDirectory)) {
         fsExtra.ensureDirSync(passphraseDirectory)
-        console.log(success(`Created passphrase directory: ${passphraseDirectory}`))
+        console.log(success(`Created passphrase directory: ${colorFilePath(passphraseDirectory)}`))
       }
 
       const passphraseFile = path.join(passphraseDirectory, targetName)
       if (!fsExtra.existsSync(passphraseFile)) {
         fsExtra.createFileSync(passphraseFile)
         fsExtra.chmodSync(passphraseFile, 0o600)
-        console.log(success(`Created passphrase file: ${passphraseFile}`))
+        console.log(success(`Created passphrase file: ${colorFilePath(passphraseFile)}`))
         console.log(success(`You have to edit the file to set the passphrase.`))
       } else {
-        console.log(warning(`Passphrase file already exists: ${passphraseFile}`))
+        console.log(warning(`Passphrase file already exists: ${colorFilePath(passphraseFile)}`))
       }
     })
   })

package/src/color.ts

@@ -7,3 +7,11 @@ export function colorTargetName(targetName: string): string {
 export function colorFilePath(filePath: string): string {
   return chalk.yellow(filePath)
 }
+
+export function colorSourceFilePath(filePath: string): string {
+  return chalk.italic.green(filePath)
+}
+
+export function colorTargetFilePath(message: string): string {
+  return chalk.italic.magenta(message)
+}

package/src/encrypt.ts

@@ -3,6 +3,8 @@ import * as path from 'node:path'
 import fsExtra from 'fs-extra'
 import { FailToDecryptFileError, FailToEncryptFileError } from './error.js'
 import { success } from './console.js'
+import { colorSourceFilePath, colorTargetFilePath } from './color.js'
+import { Config } from './config.js'
 
 /**
  * Encrypts a file using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
@@ -121,48 +123,65 @@ export async function decryptFile(
  * For each source file path provided, this function constructs the destination file path by
  * appending `.enc`, then calls `encryptFile` and logs the operation.
  *
+ * @param config The configuration object.
+ * @param rootDir The root directory where the trick configuration is located.
  * @param srcFilePaths An array of file paths to be encrypted.
- * @param destDir The directory where the encrypted files will be saved.
  * @param passphrase The passphrase used for encryption.
- * @param iterationCount The number of iterations to use for PBKDF2.
  * @returns Resolves when all files are successfully encrypted.
  * @throws {FailToEncryptFileError} If any file fails to encrypt.
  */
 export async function encryptFiles(
+  config: Config,
+  rootDir: string,
   srcFilePaths: string[],
-  destDir: string,
-  passphrase: string,
-  iterationCount: number
+  passphrase: string
 ): Promise<void> {
+  const iterationCount: number = config.encryption.iterationCount
+  const trickRootDirectory: string = config.trickRootDirectory
+
+  fsExtra.ensureDir(path.join(rootDir, trickRootDirectory))
   for (const srcFilePath of srcFilePaths) {
-    const destFilePath: string = path.join(destDir, srcFilePath + '.enc')
-    await encryptFile(srcFilePath, destFilePath, passphrase, iterationCount)
-    console.log(success(`Encrypted: ${srcFilePath} -> ${destFilePath}`))
+    const destFilePath: string = path.join(trickRootDirectory, srcFilePath + '.enc')
+    const absoluteDestFilePath: string = path.join(rootDir, destFilePath)
+    const absoluteSrcFilePath: string = path.resolve(rootDir, srcFilePath)
+    await encryptFile(absoluteSrcFilePath, absoluteDestFilePath, passphrase, iterationCount)
+    console.log(
+      success(
+        `Encrypted: ${colorSourceFilePath(srcFilePath)} -> ${colorTargetFilePath(destFilePath)}`
+      )
+    )
   }
-}
-
-/**
+} /**
  * Decrypts multiple files using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
  *
  * For each source file path provided, this function assumes the corresponding encrypted file has
  * the `.enc` extension and calls `decryptFile`, logging the operation.
  *
+ * @param config The configuration object.
+ * @param rootDir The root directory where the trick configuration is located.
  * @param srcFilePaths An array of original file paths that were encrypted.
- * @param destDir The directory containing the encrypted files.
  * @param passphrase The passphrase used for decryption.
- * @param iterationCount The number of iterations used for PBKDF2.
  * @returns Resolves when all files are successfully decrypted.
  * @throws {FailToDecryptFileError} If any file fails to decrypt.
  */
 export async function decryptFiles(
+  config: Config,
+  rootDir: string,
   srcFilePaths: string[],
-  destDir: string,
-  passphrase: string,
-  iterationCount: number
+  passphrase: string
 ): Promise<void> {
+  const iterationCount: number = config.encryption.iterationCount
+  const trickRootDirectory: string = config.trickRootDirectory
+
   for (const srcFilePath of srcFilePaths) {
-    const destFilePath: string = path.join(destDir, srcFilePath + '.enc')
-    await decryptFile(srcFilePath, destFilePath, passphrase, iterationCount)
-    console.log(success(`Decrypted: ${destFilePath} -> ${srcFilePath}`))
+    const destFilePath: string = path.join(trickRootDirectory, srcFilePath + '.enc')
+    const absoluteDestFilePath: string = path.join(rootDir, destFilePath)
+    const absoluteSrcFilePath: string = path.resolve(rootDir, srcFilePath)
+    await decryptFile(absoluteSrcFilePath, absoluteDestFilePath, passphrase, iterationCount)
+    console.log(
+      success(
+        `Decrypted: ${colorTargetFilePath(destFilePath)} -> ${colorSourceFilePath(srcFilePath)}`
+      )
+    )
   }
 }