CLI版メモアプリを作成（Node.js）

今回は、Node.jsでメモの追加・一覧表示・参照・削除ができるメモアプリ（CLI版）を作成しました。

データの保存先にはsqlite3、JavaScriptのクラス構文を使って作成しました。

要件

1. メモの追加

標準入力に入ってきたテキストを新しいメモとして追加する。

$ echo 'メモの内容' | app.js

2. メモの一覧を表示

それぞれのメモの最初の行のみを表示する。

$ memo.js -l
メモ1
今日の日記
晩ご飯のレシピ

3. メモの参照

選択したメモの全文が表示される。
（カーソルを合わせた時点もしくはメモを選択した時にメモの全文が表示される）

$ memo.js -r
Choose a note you want to see:
  メモ1
  今日の日記
> 晩ご飯のレシピ

晩ご飯のレシピ
カレー
豚肉
じゃがいも
人参
タマネギ
カレールー

4. メモの削除

選択したメモが削除される。

$ memo.js -d
Choose a note you want to delete:
  メモ1
  今日の日記
> 晩ご飯のレシピ

必要なパッケージをインストール

$ npm install --save enquirer minimist sqlite3

• enquirer: ユーザからの入力を受け取るためのライブラリ。
• minimist: コマンドライン引数を解析するライブラリ。
• sqlite3: SQLite3データベースと連携するためのライブラリ。

memoDB.js

• SQLite3データベースとのインタラクション（相互作用）を処理するクラス。

↓クリックで表示↓

// sqlite3というnpmパッケージからDatabaseをインポート
import pkg from "sqlite3";
const { Database } = pkg;

export default class MemoDB {
  constructor() {
    this.db = new Database("./db/memo.sqlite3");
    this.tableName = "memos";

    this.db.serialize(() => {
      this.db.run(
        `CREATE TABLE IF NOT EXISTS ${this.tableName} (id INTEGER PRIMARY KEY AUTOINCREMENT, text TEXT)`,
        (err) => {
          if (err) {
            console.error(err.message);
          }
        }
      );
    });
  }
// 指定したテーブルからすべてのレコードを取得
  selectAll() {
    return new Promise((resolve, reject) => {
      this.db.all("SELECT * FROM " + this.tableName, (err, rows) => {
        err ? reject(new Error(err)) : resolve(rows);
      });
    });
  }
// idに基づいて特定のメモを選択
  select(id) {
    return new Promise((resolve, reject) => {
      this.db.get(
        "SELECT * FROM " + this.tableName + " WHERE id = ?",
        id,
        (err, row) => {
          err ? reject(new Error(err)) : resolve(row);
        }
      );
    });
  }
// 新しいメモを挿入
  insert(columnName, text) {
    return new Promise((resolve, reject) => {
      this.db.run(
        "INSERT INTO " + this.tableName + "(" + columnName + ")" + " values(?)",
        text,
        (err) => {
          err ? reject(new Error(err)) : resolve();
        }
      );
    });
  }
// idに基づいて特定のメモを削除
  delete(id) {
    return new Promise((resolve, reject) => {
      this.db.run(
        "DELETE FROM " + this.tableName + " WHERE id = ?",
        id,
        (err) => {
          err ? reject(new Error(err)) : resolve();
        }
      );
    });
  }
// データベースの接続を閉じる
  close() {
    this.db.close;
  }
}

• serialize()
  • 指定したテーブルが存在しない場合は、新しいテーブルを作成。
    テーブルは、自動的に増加する主キーのidとテキストデータを保持するtextの2つのカラムを持っている。

memo.js

• メモ操作に関連するクラス。
  MemoDBクラスのインスタンスを引数として受け取り、Memoクラス内でデータベースの操作を行う。

↓クリックで表示↓

import Menu from "./menu.js";

export default class Memo {
  constructor(memoDB) {
    this.memoDB = memoDB;
  }
// 新しいメモをデータベースに追加。
  async create(lines) {
    await this.memoDB.insert("text", lines.join("\n"));
    return lines.join("\n");
  }
// データベースからすべてのメモを取得し、それぞれのメモの最初の行を表示。メモが存在しない場合は、空の配列を返す。
  async showAll() {
    const allMemos = await this.memoDB.selectAll();
    if (this.hasNoMemo(allMemos)) {
      return [];
    }

    for (let memo of allMemos) {
      console.log(memo.text.split("\n")[0]);
    }
    return allMemos;
  }
// ユーザーが選択したメモを表示。ユーザーがメモを選択すると、そのメモの全文が表示される。メモが存在しない場合は、nullを返す。
  async show() {
    const allMemos = await this.memoDB.selectAll();
    if (this.hasNoMemo(allMemos)) {
      return null;
    }
    const selectedMemo = await this.select(allMemos, "see");
    const selectedRow = await this.memoDB.select(selectedMemo.id);
    return selectedRow.text;
  }
// ユーザーが選択したメモを削除。メモが存在しない場合は、nullを返す。
  async delete() {
    const allMemos = await this.memoDB.selectAll();
    if (this.hasNoMemo(allMemos)) {
      return null;
    }
    const selectedMemo = await this.select(allMemos, "delete");
    await this.memoDB.delete(selectedMemo.id);
    return selectedMemo;
  }
// 指定したメモを選択するためのユーティリティメソッド（汎用的な機能を持つメソッド）。メモとアクション（"see"または"delete"）を引数に取り、メモのIDを選択。
  async select(memos, purpose) {
    const menu = new Menu(memos);
    return await menu.chooseMemoId("id", purpose);
  }
// メモが存在しない（配列memosの長さが0である）場合にtrueを返す。存在する場合はfalseを返す。これにより、メモが存在しない場合の処理を各メソッドで行うことができる。
  hasNoMemo(memos) {
    return memos.length === 0;
  }
}

menu.js

• メモ選択のメニューを表示するクラス。

↓クリックで表示↓

import pkg from "enquirer";
const { prompt } = pkg;

export default class Menu {
  constructor(choices) {
    this.choices = choices.map((item) => ({
      name: item.text.split("\n")[0],
      value: item.id,
    }));
  }

  async chooseMemoId(name, action) {
    return await prompt({
      type: "select",
      name: name,
      message: `Choose a memo you want to ${action}:`,
      choices: this.choices,
      result() {
        return this.focused.value;
      },
    });
  }
}

• コンストラクタにchoices（選択肢）を引数として渡す。（メモの配列を表す）
  配列の各要素に対して、最初の行を名前（name）、idを値（value）とするオブジェクトを作成し、その結果を新しい配列として保存。

• chooseMemoId()
  

  • ユーザーにメモを選択させるためにprompt関数を使用。
    
  • promptはenquirerライブラリを使用し、メモの選択メニューを表示し、ユーザーからの選択を受け取る。以下のキーを持たせる。
    • typeは入力の種類を指定し、ここでは"select"を指定。
    • nameはプロンプトの名前を指定。
    • messageはプロンプトのメッセージを指定。
    • choicesには先程作成したchoices配列を指定。
    • result関数では、選択した選択肢の値（この場合、メモのID）を返す。

cli.js

• メインのコマンドラインインターフェイス部分。オプションの解析と各操作の実行を行う。

↓クリックで表示↓

#!/usr/bin/env node

import { createInterface } from "readline"; // コマンドラインの入出力を扱うための関数
import MemoDB from "./memoDB.js"; // テーブルを管理するMemoDBクラス
import Memo from "./memo.js"; // メモを管理するMemoクラス。
import minimist from "minimist"; // コマンドライン引数をパースする。

async function main() {
  const memoDB = new MemoDB();
  const memo = new Memo(memoDB);
  const argv = minimist(process.argv.slice(2));
  if (!process.stdin.isTTY) {
    const lines = await readStdin();
    const createdMemo = await memo.create(lines);
    console.log(
      "\nYour memo, '" + createdMemo + "', has been successfully saved."
    );
  }
// すべてのメモを表示。メモが一つもない場合、その旨を表示。
  if (argv.l) {
    const allMemos = await memo.showAll();
    if (memo.hasNoMemo(allMemos)) {
      console.log("No memos found. Please create a new one.");
    }
  }
// 選択したメモの内容を表示。メモが一つもない場合、その旨を表示。
  if (argv.r) {
    const memoContent = await memo.show();
    if (memoContent) {
      console.log("\n" + memoContent);
    } else {
      console.log("No memos found. Please create a new one.");
    }
  }
// 選択したメモを削除。メモが削除された場合、その旨を表示。メモが一つもない場合、その旨を表示。
  if (argv.d) {
    const deletedMemo = await memo.delete();
    if (deletedMemo) {
      console.log("\nThe selected memo has been successfully deleted.");
    } else {
      console.log("No memos found. Please create a new one.");
    }
  }
}

function readStdin() {
  return new Promise((resolve) => {
    const lines = [];
    const reader = createInterface({
      input: process.stdin,
      output: process.stdout,
    });

    reader.on("line", (line) => {
      lines.push(line);
    });

    reader.on("close", () => {
      resolve(lines);
    });
  });
}

main();

• main関数を定義
  • MemoDBとMemoクラスのインスタンスを作成し、minimistでコマンドライン引数をパース。
  • process.argv.slice(2)は最初の2つの引数（nodeのパスと実行ファイルのパス）を除いた残りの引数を取得。
• process.stdin.isTTYは、現在のプロセスがTTY（端末）からの入力を受け取っているかどうかをチェック。否定演算子（!）を前に付けているため、このif文はTTYからの入力がない場合、つまりパイプやリダイレクションからの入力がある場合に実行される。その入力を読み取り、新しいメモを作成。作成が完了したら、その内容をコンソールに表示。
• 最後に、標準入力からデータを非同期に読み込むreadStdin関数と、メインの関数を実行するmain()を定義。readStdin関数はPromiseを返すため、データが全て読み込まれるまで待機し、その後処理を進めることができる。

JavaScriptのclass構文について

1. そもそもクラスとは？

• プログラミングにおける「クラス」とは、オブジェクトを作るための設計図のようなもの。
  オブジェクト指向プログラミングでは、クラスを使ってデータとそれを操作するメソッド（関数）を一緒にまとめる。

2. JavaScriptのクラスはシンタックスシュガー

• JavaScriptにおいても、クラスはデータとメソッドを一緒にまとめる役割を果たす。
• JavaScriptのクラスは、他の言語のクラス構造と同じように見えるが、内部的には「プロトタイプベースのオブジェクト指向」を使用。
  • 「プロトタイプベース」...オブジェクトが他のオブジェクトを元にして作られることを意味する。これはクラスベースの言語と異なり、クラスを必要としないのが特徴。クラス構文はこのプロトタイプベースのオブジェクト指向を扱いやすくするための糖衣構文。（シンタックスシュガー）

まとめ✏️

• 非同期処理は、一部の時間のかかる操作（通常はI/O操作、たとえばデータベースへのクエリ、ファイルの読み書き、ネットワークリクエストなど）をバックグラウンドで実行し、それが完了するのを待つことなく他の操作を続けるために使用。

  • 上記のソースコードでは、データベースの操作（メモの作成、表示、削除など）と標準入力からの読み取りが非同期処理として行われている。こういった操作は、それぞれ時間がかかる可能性があるため、非同期処理を行う。特にデータベースの操作は、データベースエンジンが操作を完了するまでに時間がかかる場合がある。

  • 非同期処理を行うことで、アプリケーションは操作が完了するのを待つことなく、他の処理を行うことができる。これにより、アプリのパフォーマンスが向上、レスポンス時間が短縮され、ユーザーエクスペリエンスが向上。

  • 上記のソースコードの場合、たとえばメモの作成や表示を行うときに、それが完了するまで他の操作（たとえば別のメモの表示や削除）がブロックされることはない。これは非同期処理のおかげ。

【参考】
クラス - JavaScript | MDN
クラス（Class） - とほほのWWW入門
Node.jsでのCLIの作り方と便利なライブラリまとめ - Qiita
mapbox/node-sqlite3: Asynchronous, non-blocking SQLite3 bindings for Node.js