@typinghare/trick 1.0.4 → 1.0.7

package/README.md

@@ -3,5 +3,91 @@
 # Install
 
 ```shell
+# npm
+npm install -g @typinghare/trick
+
+# pnpm
 pnpm add -g @typinghare/trick
+
+# yarn
+yarn add -g @typinghare/trick
+```
+
+## Philosophy
+
+We often add sensitive files, such as `.env` and `api_key.conf`, to `.gitignore`, preventing them from being committed or even pushed to remote depots for safety reasons. Then, we have to manually copy the file to the server. It could be effortless if we have only one file, but imagine we have more in a bigger project. Even worse, some careless people (me) even lost their sensitive files after they changed their computers!
+
+**Trick** helps you to encrypt sensitive files with a secret so that you can upload the file to Git platforms. Later on the server, just use the same secret to decrypt the files with ease.
+
+## Quick Example
+
+Set up the **secret name** and the files needed to be encrypted:
+
+```bash
+# This will create a trick.config.json at the first time
+# trick add <secret-name> [files...]
+$ trick add AN_EXAMPLE_SECRET .env api_key.conf
+
+# Display the list of secret names and the files bound
+$ trick list
+```
+
+Set up the `AN_EXAMPLE_SECRET` using `export` or put it in the login file:
+
+```bash
+$ export AN_EXAMPLE_SECRET="fQyX5O59MJuFD4l/tf2FYApqZY12N+UatEC6FC6mN7k="
+# Alternatively, put the above command to login files like `.bashrc` and `.zshrc`
+```
+
+Encrypt the files:
+
+```bash
+$ trick encrypt AN_EXAMPLE_SECRET
+```
+
+You will see the following output:
+
+```text
+[ENCRYPTED] .env -> .trick/encrypted/.env.enc
+[ENCRYPTED] api_key.conf -> .trick/encrypted/api_key.conf.enc
+```
+
+Encrypted files are all saved to `.trick`. On the server side, you can encrypt the files effortlessly:
+
+```bash
+$ export AN_EXAMPLE_SECRET="fQyX5O59MJuFD4l/tf2FYApqZY12N+UatEC6FC6mN7k="
+$ trick decrypt AN_EXAMPLE_SECRET
+```
+
+And you will see that the files are restored:
+
+```text
+[DECRYPTED] .trick/encrypted/.env.enc -> .env
+[DECRYPTED] .trick/encrypted/api_key.conf.enc -> api_key.conf
+```
+
+> [!IMPORTANT]
+>
+> You need to keep the secret to yourself! Make a copy on Cloud or write it down!
+
+## More Features
+
+### Default Secret Name
+
+You can set the default secret name so that you don't need to input it every time:
+
+```bash
+# Set the default secret name
+$ trick set-default AN_EXAMPLE_SECRET
+
+# Display the default secret name
+$ trick get-default
 ```
+
+Now you can encrypt and decrypt more easily:
+
+```bash
+$ trick encrypt
+$ trick decrypt
+```
+

package/dist/app.js

@@ -6,29 +6,65 @@ import { TRICK_ENCRYPTED_DIR } from './constant.js';
 import fsExtra from 'fs-extra';
 import chalk from 'chalk';
 const program = new Command();
-program.version('Trick v1.0.3 \nby James Chen (jameschan312.cn@gmail.com)');
+program.version('1.0.7');
 program.description('Save credential files to remote safely.');
 program
     .command('add')
-    .description('Adds a target.')
+    .description('Add a target or add files to an existing target.')
     .argument('<secret-name>', 'The name of secret in the environment')
     .argument('[files...]', 'Files this target will encrypt')
     .action(async (secretName, files) => {
     await updateConfig((config) => {
         try {
-            getTargetFromConfig(config, secretName);
+            const target = getTargetFromConfig(config, secretName);
+            target.files.push(...files);
+            return true;
         }
         catch (err) {
             config.default_secret_name = secretName;
-            config.targets.push({
-                secret_name: secretName,
-                files,
-            });
+            config.targets.push({ secret_name: secretName, files });
             return true;
         }
-        console.error(`Target with the secret name already exists: ${secretName}`);
-        console.error('Abort adding target');
-        process.exit(1);
+    });
+});
+program
+    .command('remove')
+    .description('Remove files from a specific target.')
+    .argument('<secret-name>', 'The name of secret in the environment.')
+    .argument('[files...]', 'Files to remove.')
+    .option('-t, --target', 'Remove the target instead.')
+    .action(async (secretName, files, options) => {
+    if (options.target) {
+        await updateConfig((config) => {
+            const index = config.targets.findIndex((target) => target.secret_name === secretName);
+            if (index == -1) {
+                console.log(chalk.yellow(`[WARNING] Target not found: ${secretName}`));
+                return false;
+            }
+            config.targets.splice(index, 1);
+            console.log(`[SUCCESS] Removed target: ${secretName}`);
+            return true;
+        });
+        return;
+    }
+    await updateConfig((config) => {
+        try {
+            const target = getTargetFromConfig(config, secretName);
+            const target_files = target.files;
+            for (const file of files) {
+                const index = target_files.indexOf(file);
+                if (index != -1) {
+                    target_files.splice(index, 1);
+                    console.log(`[SUCCESS] Removed file: ${file}`);
+                    continue;
+                }
+                console.log(chalk.yellow(`[WARNING] File does not exist in the target: ${file}`));
+            }
+        }
+        catch (err) {
+            config.default_secret_name = secretName;
+        }
+        return true;
     });
 });
 function checkSecretName(secretName, defaultSecretName) {

package/dist/config.js

@@ -10,7 +10,7 @@ export class ReadConfigError extends Error {
 }
 export async function writeConfig(config) {
     try {
-        await fsExtra.writeJson(CONFIG_FILE_NAME, config);
+        await fsExtra.writeFile(CONFIG_FILE_NAME, JSON.stringify(config, null, 2));
     }
     catch (err) {
         throw new WriteConfigError();

package/dist/encrypt.js

@@ -36,7 +36,7 @@ export async function encryptFile(srcFilePath, destFilePath, secret, iteration_c
         '-out',
         destFilePath,
         '-pass',
-        `pass:${secret}`,
+        `'pass:${secret}'`,
     ].join(' ');
     await fsExtra.ensureDir(path.dirname(destFilePath));
     try {
@@ -69,7 +69,7 @@ export async function decryptFile(srcFilePath, destFilePath, secret, iteration_c
         '-out',
         srcFilePath,
         '-pass',
-        `pass:${secret}`,
+        `'pass:${secret}'`,
     ].join(' ');
     await fsExtra.ensureDir(path.dirname(srcFilePath));
     try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@typinghare/trick",
   "description": "Save credential files to remote safely.",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -22,9 +22,18 @@
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
-    "prettier": "^3.3.3"
+    "prettier": "^3.3.3",
+    "typescript": "^5.8.2"
+  },
+  "prettier": {
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": false,
+    "singleQuote": true,
+    "endOfLine": "lf",
+    "printWidth": 80
   },
   "scripts": {
-    "build": "tsc"
+    "build": "node_modules/typescript/bin/tsc"
   }
 }

package/src/app.ts

@@ -20,35 +20,95 @@ import chalk from 'chalk'
 
 const program = new Command()
 
-program.version('Trick v1.0.3 \nby James Chen (jameschan312.cn@gmail.com)')
+program.version('1.0.7')
 program.description('Save credential files to remote safely.')
 
 program
     .command('add')
-    .description('Adds a target.')
+    .description('Add a target or add files to an existing target.')
     .argument('<secret-name>', 'The name of secret in the environment')
     .argument('[files...]', 'Files this target will encrypt')
     .action(async (secretName: string, files: string[]): Promise<void> => {
         await updateConfig((config) => {
             try {
-                getTargetFromConfig(config, secretName)
+                const target = getTargetFromConfig(config, secretName)
+                target.files.push(...files)
+
+                return true
             } catch (err) {
                 config.default_secret_name = secretName
-                config.targets.push({
-                    secret_name: secretName,
-                    files,
-                })
+                config.targets.push({ secret_name: secretName, files })
+
                 return true
             }
-
-            console.error(
-                `Target with the secret name already exists: ${secretName}`
-            )
-            console.error('Abort adding target')
-            process.exit(1)
         })
     })
 
+program
+    .command('remove')
+    .description('Remove files from a specific target.')
+    .argument('<secret-name>', 'The name of secret in the environment.')
+    .argument('[files...]', 'Files to remove.')
+    .option('-t, --target', 'Remove the target instead.')
+    .action(
+        async (
+            secretName: string,
+            files: string[],
+            options: {
+                target: boolean
+            }
+        ): Promise<void> => {
+            if (options.target) {
+                await updateConfig((config) => {
+                    const index: number = config.targets.findIndex(
+                        (target) => target.secret_name === secretName
+                    )
+
+                    if (index == -1) {
+                        console.log(
+                            chalk.yellow(
+                                `[WARNING] Target not found: ${secretName}`
+                            )
+                        )
+
+                        return false
+                    }
+
+                    config.targets.splice(index, 1)
+                    console.log(`[SUCCESS] Removed target: ${secretName}`)
+
+                    return true
+                })
+                return
+            }
+
+            await updateConfig((config) => {
+                try {
+                    const target = getTargetFromConfig(config, secretName)
+                    const target_files = target.files
+                    for (const file of files) {
+                        const index = target_files.indexOf(file)
+                        if (index != -1) {
+                            target_files.splice(index, 1)
+                            console.log(`[SUCCESS] Removed file: ${file}`)
+                            continue
+                        }
+
+                        console.log(
+                            chalk.yellow(
+                                `[WARNING] File does not exist in the target: ${file}`
+                            )
+                        )
+                    }
+                } catch (err: unknown) {
+                    config.default_secret_name = secretName
+                }
+
+                return true
+            })
+        }
+    )
+
 function checkSecretName(
     secretName?: string,
     defaultSecretName?: string

package/src/config.ts

@@ -18,15 +18,16 @@ const defaultConfig: Config = {
     targets: [],
 }
 
-export class WriteConfigError extends Error {
-}
+export class WriteConfigError extends Error {}
 
-export class ReadConfigError extends Error {
-}
+export class ReadConfigError extends Error {}
 
 export async function writeConfig(config: Config): Promise<void> {
     try {
-        await fsExtra.writeJson(CONFIG_FILE_NAME, config)
+        await fsExtra.writeFile(
+            CONFIG_FILE_NAME,
+            JSON.stringify(config, null, 2)
+        )
     } catch (err) {
         throw new WriteConfigError()
     }

package/src/encrypt.ts

@@ -43,7 +43,7 @@ export async function encryptFile(
         '-out',
         destFilePath,
         '-pass',
-        `pass:${secret}`,
+        `'pass:${secret}'`,
     ].join(' ')
 
     await fsExtra.ensureDir(path.dirname(destFilePath))
@@ -93,7 +93,7 @@ export async function decryptFile(
         '-out',
         srcFilePath,
         '-pass',
-        `pass:${secret}`,
+        `'pass:${secret}'`,
     ].join(' ')
 
     await fsExtra.ensureDir(path.dirname(srcFilePath))

package/trick.config.json

@@ -2,12 +2,19 @@
   "iteration_count": 114514,
   "targets": [
     {
-      "secret_name": "ROBLOX_PROJECT_TRICK_SECRET",
+      "secret_name": "TRICK_SECRET_NAME",
       "files": [
         "test/resources/really.json",
         "test/resources/task.yml"
       ]
+    },
+    {
+      "secret_name": "ANOTHER_TRICK_SECRET_NAME",
+      "files": [
+        "test/main/resources/database.properties",
+        "test/main/resources/password.properties"
+      ]
     }
   ],
-  "default_secret_name": "ROBLOX_PROJECT_TRICK_SECRET"
-}
+  "default_secret_name": "ANOTHER_TRICK_SECRET_NAME"
+}

package/.prettierrc.yaml

@@ -1,6 +0,0 @@
-trailingComma: es5
-tabWidth: 4
-semi: false
-singleQuote: true
-endOfLine: lf
-printWidth: 80

package/.trick/encrypted/test/resources/really.json

@@ -1 +0,0 @@
-Salted__�;��a��S�K�9ℑ���2�����4�'Q���\0]�G~G01�߯G���

package/.trick/encrypted/test/resources/task.yml

@@ -1 +0,0 @@
-Salted__�)�"�K7�bk��aQ��ܰ^�B9��������.3.�
g�!g�$�XjM�q�~q�c76C�i����0�S