Set up an eslint&prettier config to standardize style. Automatically fix lint warnings and manually fix others (#88)

* Set up an eslint&prettier config to standardize style.

This is done for the following reasons:

- Remove unused imports and detect unused variables
  (skip warning about unused parameters).
- Start standardizing the existing code style
- Make code style guidelines less subjective for existing/new contributors to
  save time and avoid distractions reviewing spacing/indentation in the future,
  and focus on semantics of changes
- Remove `use strict`, it's redundant in JS modules.
  https://stackoverflow.com/questions/49386015/javascript-use-strict-is-unnecessary-inside-of-modules

* Run `eslint --fix .`, `npm run prettier`

* Update github workflows, test with node 16, publish with node 12

* Run prettier on mock/test folder

* Only fix style issues that are less subjective

Author: TysonAndre

.eslintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es2021: true,
+    node: true,
+    mocha: true,
+  },
+  extends: [
+    'eslint:recommended',
+  ],
+  parserOptions: {
+    ecmaVersion: 13,
+    sourceType: 'module',
+  },
+  rules: {
+    /* Check variables but not function arguments. */
+    'eol-last': 2,
+    'linebreak-style': ['error', 'unix'],
+    'no-multiple-empty-lines': 1,
+    'no-trailing-spaces': 2,
+    'no-unused-vars': ['error', {args: 'none'}],
+    'no-var': 'error',
+    'prefer-const': 'error',
+    'require-atomic-updates': 'off',
+    'space-infix-ops': 'error',
+    'space-in-parens': ['error', 'never'],
+    'strict': ['error', 'never'],
+  },
+};

.github/workflows/ci.yml

@@ -15,6 +15,8 @@ jobs:
             NODE_VERSION: 12
           - name: Node.js 14
             NODE_VERSION: 14
+          - name: Node.js 16
+            NODE_VERSION: 16
     runs-on: ubuntu-18.04
     timeout-minutes: 30
     steps:
@@ -31,5 +33,6 @@ jobs:
           restore-keys: |
               ${{ runner.os }}-node-${{ matrix.NODE_VERSION }}-
       - run: npm ci
+      - run: npm run lint
       - run: npm run coverage
       - run: bash <(curl -s https://codecov.io/bash)

.prettierrc

@@ -0,0 +1,5 @@
+semi: true
+trailingComma: "es5"
+singleQuote: true
+arrowParens: "avoid"
+printWidth: 100

examples/sending-multiple-notifications.js

@@ -1,39 +1,39 @@
-"use strict";
-
 /**
 
 Send individualised notifications
 
 i.e. Account updates for users with one-or-more device tokens
 */
 
-const apn = require("apn");
+const apn = require('@parse/node-apn');
 
-let users = [
-  { name: "Wendy", "devices": ["<insert device token>", "<insert device token>"]},
-  { name: "John",  "devices": ["<insert device token>"]},
+const users = [
+  { name: 'Wendy', devices: ['<insert device token>', '<insert device token>'] },
+  { name: 'John', devices: ['<insert device token>'] },
 ];
 
-let service = new apn.Provider({
-  cert: "certificates/cert.pem",
-  key: "certificates/key.pem",
+const service = new apn.Provider({
+  cert: 'certificates/cert.pem',
+  key: 'certificates/key.pem',
 });
 
-Promise.all(users.map(user => {
-  let note = new apn.Notification();
-  note.alert = `Hey ${user.name}, I just sent my first Push Notification`;
+Promise.all(
+  users.map(user => {
+    const note = new apn.Notification();
+    note.alert = `Hey ${user.name}, I just sent my first Push Notification`;
 
-  // The topic is usually the bundle identifier of your application.
-  note.topic = "<bundle identifier>";
+    // The topic is usually the bundle identifier of your application.
+    note.topic = '<bundle identifier>';
 
-  console.log(`Sending: ${note.compile()} to ${user.devices}`);
+    console.log(`Sending: ${note.compile()} to ${user.devices}`);
 
-  return service.send(note, user.devices).then( result => {
-      console.log("sent:", result.sent.length);
-      console.log("failed:", result.failed.length);
+    return service.send(note, user.devices).then(result => {
+      console.log('sent:', result.sent.length);
+      console.log('failed:', result.failed.length);
       console.log(result.failed);
-  });
-})).then(() => {
+    });
+  })
+).then(() => {
   // For one-shot notification tasks you may wish to shutdown the connection
   // after everything is sent, but only call shutdown if you need your
   // application to terminate.

examples/sending-to-multiple-devices.js

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
 
 Send an identical notification to multiple devices.
@@ -11,30 +9,30 @@ Possible use cases:
  - Sport results
 */
 
-const apn = require("apn");
+const apn = require('@parse/node-apn');
 
-let tokens = ["<insert token here>", "<insert token here>"];
+const tokens = ['<insert token here>', '<insert token here>'];
 
-let service = new apn.Provider({
-  cert: "certificates/cert.pem",
-  key: "certificates/key.pem",
+const service = new apn.Provider({
+  cert: 'certificates/cert.pem',
+  key: 'certificates/key.pem',
 });
 
-let note = new apn.Notification({
-	alert:  "Breaking News: I just sent my first Push Notification",
+const note = new apn.Notification({
+  alert: 'Breaking News: I just sent my first Push Notification',
 });
 
 // The topic is usually the bundle identifier of your application.
-note.topic = "<bundle identifier>";
+note.topic = '<bundle identifier>';
 
 console.log(`Sending: ${note.compile()} to ${tokens}`);
 service.send(note, tokens).then(result => {
-    console.log("sent:", result.sent.length);
-    console.log("failed:", result.failed.length);
-    console.log(result.failed);
-
-    // For one-shot notification tasks you may wish to shutdown the connection
-    // after everything is sent, but only call shutdown if you need your 
-    // application to terminate.
-    service.shutdown();
+  console.log('sent:', result.sent.length);
+  console.log('failed:', result.failed.length);
+  console.log(result.failed);
+
+  // For one-shot notification tasks you may wish to shutdown the connection
+  // after everything is sent, but only call shutdown if you need your
+  // application to terminate.
+  service.shutdown();
 });

index.js

@@ -1,42 +1,42 @@
-const debug = require("debug")("apn");
+const http2 = require('http2');
+const debug = require('debug')('apn');
+
 debug.log = console.log.bind(console);
 
-const credentials = require("./lib/credentials")({
-  logger: debug
+const credentials = require('./lib/credentials')({
+  logger: debug,
 });
 
-const config = require("./lib/config")({
+const config = require('./lib/config')({
   logger: debug,
   prepareCertificate: credentials.certificate,
   prepareToken: credentials.token,
   prepareCA: credentials.ca,
 });
 
-const http2 = require("http2");
-
-const Client = require("./lib/client")({
+const Client = require('./lib/client')({
   logger: debug,
   config,
   http2,
 });
 
-const MultiClient = require("./lib/multiclient")({
+const MultiClient = require('./lib/multiclient')({
   Client,
 });
 
-const Provider = require("./lib/provider")({
+const Provider = require('./lib/provider')({
   logger: debug,
   Client,
 });
 
-const MultiProvider = require("./lib/provider")({
+const MultiProvider = require('./lib/provider')({
   logger: debug,
   Client: MultiClient,
 });
 
-const Notification = require("./lib/notification");
+const Notification = require('./lib/notification');
 
-const token = require("./lib/token");
+const token = require('./lib/token');
 
 module.exports = {
   Provider,