Use prettier for formatting. (#95)

Author: mrstegeman

.eslintrc.js

@@ -11,7 +11,9 @@ module.exports = {
   'extends': [
     'eslint:recommended',
     'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended'
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+    'prettier/@typescript-eslint'
   ],
   'parser': '@typescript-eslint/parser',
   'parserOptions': {
@@ -68,10 +70,6 @@ module.exports = {
       'error',
       'never'
     ],
-    'implicit-arrow-linebreak': [
-      'error',
-      'beside'
-    ],
     '@typescript-eslint/indent': [
       'error',
       2,
@@ -98,13 +96,7 @@ module.exports = {
         'mode': 'strict'
       }
     ],
-    '@typescript-eslint/keyword-spacing': [
-      'error',
-      {
-        'after': true,
-        'before': true
-      }
-    ],
+    '@typescript-eslint/keyword-spacing': 'off',
     'linebreak-style': [
       'error',
       'unix'
@@ -121,7 +113,7 @@ module.exports = {
       'error',
       {
         'singleline': {
-          'delimiter': 'comma',
+          'delimiter': 'semi',
           'requireLast': false
         },
         'multiline': {
@@ -194,7 +186,7 @@ module.exports = {
     ],
     'object-curly-spacing': [
       'error',
-      'never'
+      'always'
     ],
     'object-property-newline': [
       'error',
@@ -204,7 +196,13 @@ module.exports = {
     ],
     'operator-linebreak': [
       'error',
-      'after'
+      'after',
+      {
+        'overrides': {
+          '?': 'before',
+          ':': 'before'
+        }
+      }
     ],
     'padded-blocks': [
       'error',
@@ -248,7 +246,7 @@ module.exports = {
     '@typescript-eslint/space-before-function-paren': [
       'error',
       {
-        'anonymous': 'never',
+        'anonymous': 'always',
         'asyncArrow': 'always',
         'named': 'never'
       }

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node_version: [
+        node-version: [
           10,
           12,
           14,
@@ -22,10 +22,13 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node_version }}
+          node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: |
           npm ci
+      - name: Check formatting
+        run: |
+          npx prettier -c '*.js' 'src/*.ts'
       - name: Lint with eslint
         run: |
           npm run lint

.prettierignore

@@ -0,0 +1 @@
+.eslintrc.js

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "singleQuote": true
+}

generate-types.js

@@ -1,13 +1,10 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const fs = require('fs');
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const {compileFromFile} = require('json-schema-to-typescript');
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { compileFromFile } = require('json-schema-to-typescript');
 const path = require('path');
 
-compileFromFile('schema/schema.json', {cwd: 'schema'})
-  .then((ts) => fs.writeFileSync('src/schema.ts', ts));
+compileFromFile('schema/schema.json', { cwd: 'schema' }).then((ts) =>
+  fs.writeFileSync('src/schema.ts', ts)
+);
 
 const dname = path.resolve(path.join(__dirname, 'schema', 'messages'));
 
@@ -17,8 +14,7 @@ for (const fname of fs.readdirSync(dname)) {
   const schemaPath = path.join(dname, fname);
   const schema = JSON.parse(fs.readFileSync(schemaPath).toString());
 
-  if (!schema.hasOwnProperty('properties') ||
-      !schema.properties.hasOwnProperty('messageType')) {
+  if (!schema.hasOwnProperty('properties') || !schema.properties.hasOwnProperty('messageType')) {
     continue;
   }
 

package-lock.json

@@ -4,7 +4,8 @@
   "description": "Bindings for WebThings Gateway add-ons",
   "scripts": {
     "build": "if [ ! -d schema/messages ]; then git submodule init; fi; git submodule update && node generate-types.js && tsc -p .",
-    "lint": "eslint src --ext .ts"
+    "lint": "eslint src --ext .ts",
+    "prettier": "npx prettier -w '*.js' 'src/*.ts'"
   },
   "main": "lib/index.js",
   "keywords": [
@@ -33,7 +34,9 @@
     "@typescript-eslint/parser": "^4.14.1",
     "babel-eslint": "^10.1.0",
     "eslint": "^7.18.0",
+    "eslint-config-prettier": "^7.2.0",
     "json-schema-to-typescript": "^10.1.3",
+    "prettier": "^2.2.1",
     "typescript": "^4.1.3"
   },
   "files": [

package.json

@@ -6,9 +6,9 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import {Device} from './device';
-import {ActionDescription, Any} from './schema';
-import {timestamp} from './utils';
+import { Device } from './device';
+import { ActionDescription, Any } from './schema';
+import { timestamp } from './utils';
 
 /**
  * An Action represents an individual action on a device.
@@ -29,13 +29,13 @@ export class Action {
   private input?: Any;
 
   /**
-  * Initialize the object.
-  *
-  * @param {String} id ID of this action
-  * @param {Object} device Device this action belongs to
-  * @param {String} name Name of the action
-  * @param {unknown} input Any action inputs
-  */
+   * Initialize the object.
+   *
+   * @param {String} id ID of this action
+   * @param {Object} device Device this action belongs to
+   * @param {String} name Name of the action
+   * @param {unknown} input Any action inputs
+   */
   constructor(id: string, device: Device, name: string, input?: Any) {
     this.id = id;
     this.device = device;

src/action.ts

@@ -9,13 +9,10 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.*
  */
 
-import {Action} from './action';
-import {AddonManagerProxy} from './addon-manager-proxy';
-import {Device} from './device';
-import {DeviceWithoutId as DeviceWithoutIdSchema,
-  Preferences,
-  UserProfile} from './schema';
-
+import { Action } from './action';
+import { AddonManagerProxy } from './addon-manager-proxy';
+import { Device } from './device';
+import { DeviceWithoutId as DeviceWithoutIdSchema, Preferences, UserProfile } from './schema';
 
 export interface AdapterDescription {
   id: string;
@@ -51,8 +48,12 @@ export class Adapter {
 
   private preferences?: Preferences;
 
-  constructor(manager: AddonManagerProxy, id: string, packageName: string,
-              {verbose}: Record<string, unknown> = {}) {
+  constructor(
+    manager: AddonManagerProxy,
+    id: string,
+    packageName: string,
+    { verbose }: Record<string, unknown> = {}
+  ) {
     this.manager = manager;
     this.id = id;
     this.packageName = packageName;
@@ -176,12 +177,10 @@ export class Adapter {
    * @param {string} deviceId - ID of the device
    * @param {object} device - the saved device description
    */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   handleDeviceSaved(_deviceId: string, _device: DeviceWithoutIdSchema): void {
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    // pass
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   startPairing(_timeoutSeconds: number): void {
     if (this.verbose) {
       console.log('Adapter:', this.name, 'id', this.id, 'pairing started');
@@ -220,17 +219,23 @@ export class Adapter {
 
   removeThing(device: Device): void {
     if (this.verbose) {
-      console.log('Adapter:', this.name, 'id', this.id,
-                  'removeThing(', device.getId(), ') started');
+      console.log(
+        'Adapter:',
+        this.name,
+        'id',
+        this.id,
+        'removeThing(',
+        device.getId(),
+        ') started'
+      );
     }
 
     this.handleDeviceRemoved(device);
   }
 
   cancelRemoveThing(device: Device): void {
     if (this.verbose) {
-      console.log('Adapter:', this.name, 'id', this.id,
-                  'cancelRemoveThing(', device.getId(), ')');
+      console.log('Adapter:', this.name, 'id', this.id, 'cancelRemoveThing(', device.getId(), ')');
     }
   }
 
@@ -259,8 +264,7 @@ export class Adapter {
     const device = this.getDevice(deviceId);
     if (device) {
       if (this.verbose) {
-        console.log('Adapter:', this.name, 'id', this.id,
-                    'setPin(', deviceId, ',', pin, ')');
+        console.log('Adapter:', this.name, 'id', this.id, 'setPin(', deviceId, ',', pin, ')');
       }
 
       return Promise.resolve();
@@ -282,9 +286,19 @@ export class Adapter {
     const device = this.getDevice(deviceId);
     if (device) {
       if (this.verbose) {
-        console.log('Adapter:', this.name, 'id', this.id,
-                    'setCredentials(', deviceId, ',', username, ',', password,
-                    ')');
+        console.log(
+          'Adapter:',
+          this.name,
+          'id',
+          this.id,
+          'setCredentials(',
+          deviceId,
+          ',',
+          username,
+          ',',
+          password,
+          ')'
+        );
       }
 
       return Promise.resolve();