@kokiito0926/pseudoalias 0.0.4 → 0.0.6

package/README.md

@@ -1,7 +1,7 @@
-## スードーエイリアス（pseudoalias）
+## pseudoalias
 
-スードーエイリアス（pseudoalias）を用いれば、擬似的なエイリアスを作成することができます。  
-.bashrcなどにエイリアスを書くよりも、JavaScriptのファイルにエイリアスを書けたほうが便利かと思いました。
+pseudoaliasは、擬似的なエイリアスを作成することができるコマンドラインのツールです。  
+.bashrcなどにエイリアスを書くよりも、JavaScriptでエイリアスを書けるようになるので、書きやすいような気がします。
 
 ## インストール
 
@@ -9,15 +9,70 @@
 $ npm install --global @kokiito0926/pseudoalias
 ```
 
-## 実行方法
+## 使用方法
+
+設定のファイルにエイリアスを記述します。
+
+```javascript
+export const greetings = async () => {
+	console.log("Hello, world!");
+};
+
+export const addition = async (one, two) => {
+	console.log(Number(one) + Number(two));
+};
+
+export const subtraction = async (one, two) => {
+	console.log(Number(one) - Number(two));
+};
+
+export const multiplication = async (one, two) => {
+	console.log(Number(one) * Number(two));
+};
+
+export const division = async (one, two) => {
+	console.log(Number(one) / Number(two));
+};
+```
+
+--configのオプションに設定のファイルを指定します。  
+そうしたら、定義されているエイリアスを実行することができます。
 
 ```bash
-$ pseudoalias --config ./example.js
 $ pseudoalias --config ./example.js greetings
 $ pseudoalias --config ./example.js addition 1 2
 $ pseudoalias --config ./example.js subtraction 2 1
 ```
 
+エイリアスを書かずに実行した場合、エイリアスの一覧が表示されます。
+
+```bash
+$ pseudoalias --config ./example.js
+```
+
+--registerのオプションを用いると、ホームディレクトリに設定のファイルが保存されます。  
+それ以降は、--configのオプションを用いなくても、定義されているエイリアスを実行することができます。
+
+```bash
+$ pseudoalias --config ./example.js --register
+
+$ pseudoalias greetings
+$ pseudoalias addition 1 2
+$ pseudoalias subtraction 2 1
+```
+
+--unregisterのオプションを用いると、ホームディレクトリから設定のファイルを削除します。
+
+```bash
+$ pseudoalias --unregister
+```
+
+下記のコマンドを.bashrcなどに追記すると、入力補完が効くようになります。
+
+```bash
+$ complete -C "pseudoalias --completion" -o default pseudoalias
+```
+
 ## ライセンス
 
 [MIT](LICENSE)

package/index.js

@@ -26,9 +26,17 @@
 // >> $ ./index.js --config example.js greetings
 // >> $ ./index.js --config example.js addition 1 2
 
-import { minimist, fs, path, argv } from "zx";
+// >> $ ./index.js --config ./example.js --register
+// >> $ ./index.js greetings
+// >> $ ./index.js addition 1 2
+// >> $ ./index.js --unregister
+
+import { os, minimist, fs, path, argv } from "zx";
 import { pathToFileURL } from "node:url";
 
+const CONFIG_DIR = path.join(os.homedir(), ".pseudoalias");
+const CONFIG_FILE = path.join(CONFIG_DIR, "config.js");
+
 const commands = argv._;
 // console.log(commands);
 
@@ -39,11 +47,45 @@ const completion = args.completion;
 // console.log(args);
 // process.exit(0);
 
-const targetFile = config;
-if (!targetFile) {
+if (args.register) {
+	if (args.config) {
+		const absConfigPath = path.resolve(args.config);
+		const configData = fs.readFileSync(absConfigPath, "utf-8");
+
+		await fs.ensureDir(CONFIG_DIR);
+
+		await fs.writeFile(CONFIG_FILE, configData, "utf-8");
+
+		console.log(`Success: Registered config path to ${absConfigPath}`);
+		console.log(`Stored in: ${CONFIG_FILE}`);
+	} else {
+		console.error("Error: --config is required with --register");
+	}
+	process.exit(0);
+}
+
+if (args.unregister) {
+	if (await fs.exists(CONFIG_DIR)) {
+		await fs.remove(CONFIG_DIR);
+		console.log("Success: Unregistered and removed configuration.");
+	} else {
+		console.log("Notice: No configuration found to unregister.");
+	}
 	process.exit(0);
 }
 
+let targetFile = config;
+
+if (!targetFile) {
+	if (fs.existsSync(CONFIG_FILE)) {
+		targetFile = CONFIG_FILE;
+	} else {
+		process.exit(1);
+	}
+}
+// console.log(targetFile);
+// process.exit(0);
+
 const targetPath = path.resolve(targetFile);
 if (!targetPath) {
 	process.exit(0);

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "@kokiito0926/pseudoalias",
-	"version": "0.0.4",
+	"version": "0.0.6",
 	"private": false,
-	"description": "スードーエイリアス（pseudoalias）を用いれば、擬似的なエイリアスを作成することができます。",
+	"description": "擬似的なエイリアスを作成することができるコマンドラインのツールです。",
 	"keywords": [
 		"cli",
 		"bash",