feat(lint): add eslint and airbnb rules

Author: vilaboim

.editorconfig

@@ -0,0 +1,3 @@
+[*]
+end_of_line = lf
+insert_final_newline = true

.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    'airbnb-base',
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  rules: {
+    'no-param-reassign': 'off',
+  },
+};

package.json

@@ -7,6 +7,7 @@
   "browser": "dist/vuecloak.umd.js",
   "scripts": {
     "build": "rimraf dist && rollup -c rollup.config.js",
+    "lint": "eslint --ext .js --fix src/",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -28,6 +29,9 @@
   },
   "homepage": "https://github.com/vilaboim/vuecloak#readme",
   "devDependencies": {
+    "eslint": "^7.32.0 || ^8.2.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.25.2",
     "rimraf": "^3.0.2",
     "rollup": "^2.52.7"
   },

src/devtools.js

@@ -1,11 +1,11 @@
-import { setupDevtoolsPlugin } from '@vue/devtools-api'
+import { setupDevtoolsPlugin } from '@vue/devtools-api';
 
-let isAlreadyInstalled = false
-const INSPECTOR_ID = 'vuecloak'
+let isAlreadyInstalled = false;
+const INSPECTOR_ID = 'vuecloak';
 
-export function devtoolsPlugin (app, keycloak) {
-  const keycloakProperties = Object.keys(keycloak).filter(key => typeof keycloak[key] !== 'function')
-  const keycloakMethods = ['loadUserProfile', 'loadUserInfo']
+export default function devtoolsPlugin(app, keycloak) {
+  const keycloakProperties = Object.keys(keycloak).filter((key) => typeof keycloak[key] !== 'function');
+  const keycloakMethods = ['loadUserProfile', 'loadUserInfo'];
 
   setupDevtoolsPlugin(
     {
@@ -21,63 +21,63 @@ export function devtoolsPlugin (app, keycloak) {
           id: INSPECTOR_ID,
           label: 'Vuecloak',
           icon: 'lock',
-          treeFilterPlaceholder: 'Search for property...'
-        })
+          treeFilterPlaceholder: 'Search for property...',
+        });
 
-        api.on.getInspectorTree(payload => {
+        api.on.getInspectorTree((payload) => {
           if (payload.inspectorId === INSPECTOR_ID) {
             const rootNodes = [
               {
                 id: 'properties',
                 label: 'Properties',
                 children: keycloakProperties.map((property) => ({
                   id: property,
-                  label: property
-                }))
-              }
-            ]
+                  label: property,
+                })),
+              },
+            ];
 
             if (keycloak.authenticated) {
               rootNodes.push({
                 id: 'methods',
                 label: 'Methods',
                 children: keycloakMethods.map((property) => ({
                   id: property,
-                  label: property
-                }))
-              })
+                  label: property,
+                })),
+              });
             }
 
-            payload.rootNodes = rootNodes
+            payload.rootNodes = rootNodes;
           }
-        })
+        });
 
         api.on.getInspectorState(async (payload) => {
           if (payload.inspectorId === INSPECTOR_ID) {
-            const nodeId = payload.nodeId
+            const { nodeId } = payload;
 
             if (keycloak.authenticated && keycloakMethods.includes(nodeId)) {
               payload.state = {
                 [nodeId]: {
                   key: nodeId,
                   value: await keycloak[nodeId](),
-                  editable: false
-                }
-              }
+                  editable: false,
+                },
+              };
             } else {
               payload.state = {
                 [nodeId]: {
                   key: nodeId,
                   value: keycloak[nodeId],
-                  editable: false
-                }
-              }
+                  editable: false,
+                },
+              };
             }
           }
-        })
+        });
       }
 
-      isAlreadyInstalled = true
-    }
-  )
+      isAlreadyInstalled = true;
+    },
+  );
 }

src/index.js

@@ -1,75 +1,77 @@
-import Keycloak from 'keycloak-js'
-import { devtoolsPlugin } from './devtools'
+import Keycloak from 'keycloak-js';
+import devtoolsPlugin from './devtools';
 
-function isFunction (value) {
-  return typeof value === 'function'
+function isFunction(value) {
+  return typeof value === 'function';
 }
 
-function init (config, options) {
-  const keycloak = Keycloak(config)
+function init(config, options) {
+  const keycloak = Keycloak(config);
 
-  keycloak.onReady = function () {
-    isFunction(options.onReady) && options.onReady(keycloak)
-  }
+  keycloak.onReady = () => {
+    if (isFunction(options.onReady)) options.onReady(keycloak);
+  };
 
-  keycloak.onAuthSuccess = function () {
-    isFunction(options.onAuthSuccess) && options.onAuthSuccess(keycloak)
-  }
+  keycloak.onAuthSuccess = () => {
+    if (isFunction(options.onAuthSuccess)) options.onAuthSuccess(keycloak);
+  };
 
-  keycloak.onAuthError = function () {
-    isFunction(options.onAuthError) && options.onAuthError(keycloak)
-  }
+  keycloak.onAuthError = () => {
+    if (isFunction(options.onAuthError)) options.onAuthError(keycloak);
+  };
 
-  keycloak.onAuthRefreshSuccess = function () {
-    isFunction(options.onAuthRefreshSuccess) && options.onAuthRefreshSuccess(keycloak)
-  }
+  keycloak.onAuthRefreshSuccess = () => {
+    if (isFunction(options.onAuthRefreshSuccess)) options.onAuthRefreshSuccess(keycloak);
+  };
 
-  keycloak.onAuthRefreshError = function () {
-    isFunction(options.onAuthRefreshError) && options.onAuthRefreshError(keycloak)
-  }
+  keycloak.onAuthRefreshError = () => {
+    if (isFunction(options.onAuthRefreshError)) options.onAuthRefreshError(keycloak);
+  };
 
-  keycloak.onAuthLogout = function () {
-    isFunction(options.onAuthLogout) && options.onAuthLogout(keycloak)
-  }
+  keycloak.onAuthLogout = () => {
+    if (isFunction(options.onAuthLogout)) options.onAuthLogout(keycloak);
+  };
 
-  keycloak.onTokenExpired = function () {
-    isFunction(options.onTokenExpired) && options.onTokenExpired(keycloak)
-  }
+  keycloak.onTokenExpired = () => {
+    if (isFunction(options.onTokenExpired)) options.onTokenExpired(keycloak);
+  };
 
   keycloak
     .init(options.init)
     .then((authenticated) => {
-      isFunction(options.onInitSuccess) &&
-        options.onInitSuccess(authenticated)
+      if (isFunction(options.onInitSuccess)) options.onInitSuccess(authenticated);
     })
     .catch((error) => {
-      isFunction(options.onInitError)
-        ? options.onInitError(error)
-        : console.error(error)
-    })
+      if (isFunction(options.onInitError)) return options.onInitError(error);
+
+      // eslint-disable-next-line no-console
+      return console.error(error);
+    });
 
-  return keycloak
+  return keycloak;
 }
 
-let installed = false
+let installed = false;
 
-export const Vuecloak = {
+const Vuecloak = {
   install: (app, options) => {
-    if (installed) return
+    if (installed) return;
 
-    installed = true
+    installed = true;
 
-    const keycloak = init(options.config, options)
+    const keycloak = init(options.config, options);
 
-    app.config.globalProperties.$keycloak = keycloak
-    app.provide('$keycloak', keycloak)
+    app.config.globalProperties.$keycloak = keycloak;
+    app.provide('$keycloak', keycloak);
 
-    const IS_DEV = process.env.NODE_ENV === 'development'
-    const IS_CLIENT = typeof window !== 'undefined'
+    const IS_DEV = process.env.NODE_ENV === 'development';
+    const IS_CLIENT = typeof window !== 'undefined';
 
     if (IS_DEV && IS_CLIENT) {
-      devtoolsPlugin(app, keycloak)
+      devtoolsPlugin(app, keycloak);
     }
-  }
-}
+  },
+};
 
+export { Vuecloak };
+export default Vuecloak;