Convert local-settings.js to typescript

Change-type: patch

lib/gui/app/models/local-settings.js

@@ -1,184 +0,0 @@
-/*
- * Copyright 2017 balena.io
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-'use strict'
-
-const Bluebird = require('bluebird')
-const fs = require('fs')
-const path = require('path')
-
-/**
- * @summary Number of spaces to indent JSON output with
- * @type {Number}
- * @constant
- */
-const JSON_INDENT = 2
-
-/**
- * @summary Userdata directory path
- * @description
- * Defaults to the following:
- * - `%APPDATA%/etcher` on Windows
- * - `$XDG_CONFIG_HOME/etcher` or `~/.config/etcher` on Linux
- * - `~/Library/Application Support/etcher` on macOS
- * See https://electronjs.org/docs/api/app#appgetpathname
- * @constant
- * @type {String}
- */
-const USER_DATA_DIR = (() => {
-  // NOTE: The ternary is due to this module being loaded both,
-  // Electron's main process and renderer process
-  const electron = require('electron')
-  return electron.app
-    ? electron.app.getPath('userData')
-    : electron.remote.app.getPath('userData')
-})()
-
-/**
- * @summary Configuration file path
- * @type {String}
- * @constant
- */
-const CONFIG_PATH = path.join(USER_DATA_DIR, 'config.json')
-
-/**
- * @summary Read a local config.json file
- * @function
- * @private
- *
- * @param {String} filename - file path
- * @fulfil {Object} - settings
- * @returns {Promise}
- *
- * @example
- * readConfigFile('config.json').then((settings) => {
- *   console.log(settings)
- * })
- */
-const readConfigFile = (filename) => {
-  return new Bluebird((resolve, reject) => {
-    fs.readFile(filename, { encoding: 'utf8' }, (error, contents) => {
-      let data = {}
-      if (error) {
-        if (error.code === 'ENOENT') {
-          resolve(data)
-        } else {
-          reject(error)
-        }
-      } else {
-        try {
-          data = JSON.parse(contents)
-        } catch (parseError) {
-          console.error(parseError)
-        }
-        resolve(data)
-      }
-    })
-  })
-}
-
-/**
- * @summary Write to the local configuration file
- * @function
- * @private
- *
- * @param {String} filename - file path
- * @param {Object} data - data
- * @fulfil {Object} data - data
- * @returns {Promise}
- *
- * @example
- * writeConfigFile('config.json', { something: 'good' })
- *   .then(() => {
- *     console.log('data written')
- *   })
- */
-const writeConfigFile = (filename, data) => {
-  return new Bluebird((resolve, reject) => {
-    const contents = JSON.stringify(data, null, JSON_INDENT)
-    fs.writeFile(filename, contents, (error) => {
-      if (error) {
-        reject(error)
-      } else {
-        resolve(data)
-      }
-    })
-  })
-}
-
-/**
- * @summary Read all local settings
- * @function
- * @public
- *
- * @fulfil {Object} - local settings
- * @returns {Promise}
- *
- * @example
- * localSettings.readAll().then((settings) => {
- *   console.log(settings);
- * });
- */
-exports.readAll = () => {
-  return readConfigFile(CONFIG_PATH)
-}
-
-/**
- * @summary Write local settings
- * @function
- * @public
- *
- * @param {Object} settings - settings
- * @fulfil {Object} settings - settings
- * @returns {Promise}
- *
- * @example
- * localSettings.writeAll({
- *   foo: 'bar'
- * }).then(() => {
- *   console.log('Done!');
- * });
- */
-exports.writeAll = (settings) => {
-  return writeConfigFile(CONFIG_PATH, settings)
-}
-
-/**
- * @summary Clear the local settings
- * @function
- * @private
- *
- * @description
- * Exported for testing purposes
- *
- * @returns {Promise}
- *
- * @example
- * localSettings.clear().then(() => {
- *   console.log('Done!');
- * });
- */
-exports.clear = () => {
-  return new Bluebird((resolve, reject) => {
-    fs.unlink(CONFIG_PATH, (error) => {
-      if (error) {
-        reject(error)
-      } else {
-        resolve()
-      }
-    })
-  })
-}

lib/gui/app/models/local-settings.ts

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2017 balena.io
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as electron from 'electron';
+import { promises as fs } from 'fs';
+import * as path from 'path';
+
+const JSON_INDENT = 2;
+
+/**
+ * @summary Userdata directory path
+ * @description
+ * Defaults to the following:
+ * - `%APPDATA%/etcher` on Windows
+ * - `$XDG_CONFIG_HOME/etcher` or `~/.config/etcher` on Linux
+ * - `~/Library/Application Support/etcher` on macOS
+ * See https://electronjs.org/docs/api/app#appgetpathname
+ *
+ * NOTE: The ternary is due to this module being loaded both,
+ * Electron's main process and renderer process
+ */
+const USER_DATA_DIR = electron.app
+	? electron.app.getPath('userData')
+	: electron.remote.app.getPath('userData');
+
+const CONFIG_PATH = path.join(USER_DATA_DIR, 'config.json');
+
+async function readConfigFile(filename: string): Promise<any> {
+	let contents = '{}';
+	try {
+		contents = await fs.readFile(filename, { encoding: 'utf8' });
+	} catch (error) {
+		if (error.code !== 'ENOENT') {
+			throw error;
+		}
+	}
+	try {
+		return JSON.parse(contents);
+	} catch (parseError) {
+		console.error(parseError);
+		return {};
+	}
+}
+
+async function writeConfigFile(filename: string, data: any): Promise<any> {
+	await fs.writeFile(filename, JSON.stringify(data, null, JSON_INDENT));
+	return data;
+}
+
+export async function readAll(): Promise<any> {
+	return await readConfigFile(CONFIG_PATH);
+}
+
+export async function writeAll(settings: any): Promise<any> {
+	return await writeConfigFile(CONFIG_PATH, settings);
+}
+
+export async function clear(): Promise<void> {
+	await fs.unlink(CONFIG_PATH);
+}

lib/gui/app/models/settings.js

@@ -22,6 +22,7 @@
 
 const _ = require('lodash')
 const Bluebird = require('bluebird')
+// eslint-disable-next-line node/no-missing-require
 const localSettings = require('./local-settings')
 const errors = require('../../../shared/errors')
 const packageJSON = require('../../../../package.json')

tests/gui/models/settings.spec.js

@@ -20,6 +20,7 @@ const m = require('mochainon')
 const _ = require('lodash')
 const Bluebird = require('bluebird')
 const settings = require('../../../lib/gui/app/models/settings')
+// eslint-disable-next-line node/no-missing-require
 const localSettings = require('../../../lib/gui/app/models/local-settings')
 
 describe('Browser: settings', function () {