Version 3.0.2, code quality

JeremyJeanson · JeremyJeanson · commit f6c89e1b5f1f · 2020-10-05T14:43:24.000+02:00
diff --git a/Distribution/app/index.js b/Distribution/app/index.js
@@ -4,7 +4,6 @@ import * as messaging from "messaging";
 var SETTINGS_TYPE = "cbor";
 var SETTINGS_FILE = "settings.cbor";
 var _settings;
-var _onsettingschange;
 /**
  * Initialize settings
  * @param settings that will be managed by the module
@@ -13,32 +12,34 @@ var _onsettingschange;
 export function initialize(settings, callback) {
     // Save args
     _settings = settings;
-    _onsettingschange = callback;
     // load settings from file adn update values
     loadSettings();
+    addEventListeners(callback);
     // Send the full settings for first load from settings
-    _onsettingschange(_settings);
+    callback(_settings);
+}
+function addEventListeners(callback) {
+    /**
+     * Received message containing settings data
+     */
+    messaging.peerSocket.addEventListener("message", function (evt) {
+        // Get data
+        var data = evt.data;
+        // Test data type (it should be a setting)
+        if (data.type === "setting") {
+            // Update settings object
+            _settings[data.key] = data.value;
+            // Raise event with only the property changed
+            var args = {};
+            args[data.key] = data.value;
+            callback(args);
+        }
+    });
+    /**
+     * Register for the unload event
+     */
+    me.addEventListener("unload", saveSettings);
 }
-/**
- * Received message containing settings data
- */
-messaging.peerSocket.addEventListener("message", function (evt) {
-    // Get data
-    var data = evt.data;
-    // Test data type (it should be a setting)
-    if (data.type === "setting") {
-        // Update settings object
-        _settings[data.key] = data.value;
-        // Raise event with only the property changed
-        var args = {};
-        args[data.key] = data.value;
-        _onsettingschange(args);
-    }
-});
-/**
- * Register for the unload event
- */
-me.addEventListener("unload", saveSettings);
 /**
  * update settings
  */
diff --git a/Distribution/companion/index.d.ts b/Distribution/companion/index.d.ts
@@ -2,10 +2,10 @@
  * Initialize settings tools
  * @param defaultSettings - Class with default settings
  */
-export declare function initialize(defaultSettings: any): void;
+export declare function initialize<T>(defaultSettings: T): void;
 /**
  * Set defaut setting
  * @param key of setting to set
  * @param value of setting to set
  */
-export declare function setDefaultSetting(key: string, value: any): void;
+export declare function setDefaultSetting(key: string, value: unknown): void;
diff --git a/Distribution/package.json b/Distribution/package.json
@@ -1,6 +1,6 @@
 {
   "name": "simple-fitbit-settings",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Module to simplify management of settings inside Fitbit OS applications",
   "author": "Jérémy Jeanson (https://www.bugshunter.net)",
   "license": "MIT",
@@ -21,10 +21,14 @@
   "devDependencies": {
     "@fitbit/sdk": "5.0.1",
     "fitbit-sdk-types": "6.0.0",
-    "typescript": "4.0.3"
+    "typescript": "4.0.3",
+    "@typescript-eslint/eslint-plugin": "^4.3.0",
+    "@typescript-eslint/parser": "^4.3.0",
+    "eslint": "^7.10.0"    
   },
   "scripts": {
     "build":"@powershell Copy-Item -Path ./package.json,../README.md -Destination ../distribution/ && tsc --build",
-    "clean": "tsc --build --clean && @powershell Remove-Item ../distribution/*.*"
+    "clean": "tsc --build --clean && @powershell Remove-Item ../distribution/*.*",
+    "lint":"eslint . --ext .js,.jsx,.ts,.tsx"
   }
 }
diff --git a/Sources/.eslintignore b/Sources/.eslintignore
@@ -0,0 +1,2 @@
+# don't ever lint node_modules
+node_modules
diff --git a/Sources/.eslintrc.json b/Sources/.eslintrc.json
@@ -0,0 +1,16 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "vars-on-top": "error",
+    "semi": "error"
+  }
+}
diff --git a/Sources/app/index.ts b/Sources/app/index.ts
@@ -6,8 +6,7 @@ import { MessageData } from "../common";
 const SETTINGS_TYPE = "cbor";
 const SETTINGS_FILE = "settings.cbor";
 
-let _settings: any;
-let _onsettingschange: (newSettings: any) => void;
+let _settings: Record<string, unknown>;
 
 /**
  * Initialize settings
@@ -16,35 +15,37 @@ let _onsettingschange: (newSettings: any) => void;
  */
 export function initialize<T>(settings: T, callback: (newSettings: T) => void): void {
   // Save args
-  _settings = settings;
-  _onsettingschange = callback;
+  _settings = settings as Record<string, unknown>;
   // load settings from file adn update values
   loadSettings();
+  addEventListeners(callback);
   // Send the full settings for first load from settings
-  _onsettingschange(_settings);
+  callback(_settings as T);
 }
 
-/**
- * Received message containing settings data
- */
-messaging.peerSocket.addEventListener("message", (evt) => {
-  // Get data
-  const data = evt.data as MessageData;
-  // Test data type (it should be a setting)
-  if (data.type === "setting") {
-    // Update settings object
-    _settings[data.key] = data.value;
-    // Raise event with only the property changed
-    const args = {};
-    args[data.key] = data.value;
-    _onsettingschange(args);
-  }
-});
+function addEventListeners<T>(callback: (newSettings: T) => void): void {
+  /**
+   * Received message containing settings data
+   */
+  messaging.peerSocket.addEventListener("message", (evt) => {
+    // Get data
+    const data = evt.data as MessageData;
+    // Test data type (it should be a setting)
+    if (data.type === "setting") {
+      // Update settings object
+      _settings[data.key] = data.value;
+      // Raise event with only the property changed
+      const args = {};
+      args[data.key] = data.value;
+      callback(args as T);
+    }
+  });
 
-/**
- * Register for the unload event
- */
-me.addEventListener("unload", saveSettings);
+  /**
+   * Register for the unload event
+   */
+  me.addEventListener("unload", saveSettings);
+}
 
 /**
  * update settings
@@ -53,7 +54,7 @@ function loadSettings() {
   const settings = getSettings();
   if (settings === undefined) return;
   // Update each property defined in file
-  for (let key in settings) {
+  for (const key in settings) {
     // Get value
     const value = settings[key];
     // update settigns value if deined
@@ -66,7 +67,7 @@ function loadSettings() {
 /**
  * Load settings from filesystem
  */
-function getSettings(): any {
+function getSettings(): Record<string, unknown> | undefined {
   try {
     return fs.readFileSync(SETTINGS_FILE, SETTINGS_TYPE);
   } catch (ex) {
diff --git a/Sources/companion/index.ts b/Sources/companion/index.ts
@@ -6,7 +6,7 @@ import { MessageData } from "../common";
  * Initialize settings tools 
  * @param defaultSettings - Class with default settings
  */
-export function initialize(defaultSettings: any): void {
+export function initialize<T>(defaultSettings: T): void {
   // Whensettings changed -> send the new value
   settingsStorage.onchange = (e) => {
     if (e.key !== null && e.oldValue !== e.newValue && e.newValue !== undefined) {
@@ -40,9 +40,9 @@ function sendValue(key: string, value: string | null): void {
  * Init default settings
  * @param defaultSettings 
  */
-function setDefaultSettings(defaultSettings: any): void {
+function setDefaultSettings<T>(defaultSettings: T): void {
   // For each properties of the settings class
-  for (let key in defaultSettings) {
+  for (const key in defaultSettings) {
     // Get the value
     const value = defaultSettings[key];
     // Test if value is defined
@@ -57,7 +57,7 @@ function setDefaultSettings(defaultSettings: any): void {
  * @param key of setting to set 
  * @param value of setting to set
  */
-export function setDefaultSetting(key: string, value: any): void {
+export function setDefaultSetting(key: string, value: unknown): void {
   if (getSetting(key) === null) {
     setSetting(key, value);
   }
@@ -80,7 +80,7 @@ function getSetting(key: string): string | null {
  * @param key 
  * @param value 
  */
-function setSetting(key: string, value: any): void {
+function setSetting(key: string, value: unknown): void {
   try {
     settingsStorage.setItem(key, JSON.stringify(value));
   }
diff --git a/Sources/package.json b/Sources/package.json
@@ -1,6 +1,6 @@
 {
   "name": "simple-fitbit-settings",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Module to simplify management of settings inside Fitbit OS applications",
   "author": "Jérémy Jeanson (https://www.bugshunter.net)",
   "license": "MIT",
@@ -21,10 +21,14 @@
   "devDependencies": {
     "@fitbit/sdk": "5.0.1",
     "fitbit-sdk-types": "6.0.0",
-    "typescript": "4.0.3"
+    "typescript": "4.0.3",
+    "@typescript-eslint/eslint-plugin": "^4.3.0",
+    "@typescript-eslint/parser": "^4.3.0",
+    "eslint": "^7.10.0"    
   },
   "scripts": {
     "build":"@powershell Copy-Item -Path ./package.json,../README.md -Destination ../distribution/ && tsc --build",
-    "clean": "tsc --build --clean && @powershell Remove-Item ../distribution/*.*"
+    "clean": "tsc --build --clean && @powershell Remove-Item ../distribution/*.*",
+    "lint":"eslint . --ext .js,.jsx,.ts,.tsx"
   }
 }
diff --git a/Sources/pnpm-lock.yaml b/Sources/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# don't ever lint node_modules`
	`2`	`+node_modules`