Electronで設定ファイルを導入

Electronに設定ファイル機能を導入する

Electronで設定値を保存するためのライブラリは以下の２つがある。

electron-store(旧 electron-config)
　シンプルで使いやすい。

electron-json-storage
　コールバック方式で使いにくい。

electron-storeを使いたかったが自分の環境だとなぜかelectron-builderでアプリをパッケージ化するとSyntaxエラーになって動かないためelectron-json-storageを使用した。解決出来た人がいたら教えて欲しい。

electron-store

GitHubはコチラ

インストール方法

npm install electron-store

デフォルトの保存場所

デフォルトではapp.getPath('userData')の下にconfig.jsonファイルが作成される。

Windowsの場合のパス

C:\Users\【ユーザー名】\AppData\Roaming\【パッケージ名】\config.json

使用例

    const Store = require('electron-store');
    const store = new Store({
        cwd: __dirname,  // 保存ディレクトリを指定　※省略可。推奨されていない
        name: 'config'  // 設定ファイル名を指定　※省略可。拡張子は.jsonになる
    });

    //設定ファイルにデータを保存する。（programsというキーでJSONデータを保存する）
    store.set("programs", { index: 1, name: 'TEST', path: 'c/' });

    //設定ファイルからデータを読み込む。（programsというキーを取得する。取得出来ない場合は、第二引数で指定しているJSONデータを読み込む）
    const programs = store.get("programs", 
      { index: 0, name: 'TEST', path: 'c/' }
    );

エンジニアに役立つ情報をTwitterでも発信していますので宜しければTwitterの方もフォローをよろしくお願いします！
Twitterへのリンクはコチラ