chore(linter): prevent common errors (#252)

* setup linter

* fix linter error

* prevent console errors

Author: stipsan

package.json

@@ -59,6 +59,8 @@
     "rollup-plugin-replace": "2.0.0",
     "rollup-plugin-terser": "1.0.1",
     "semantic-release": "15.5.0",
+    "tslint": "5.10.0",
+    "tslint-config-prettier": "1.13.0",
     "typescript": "2.8.3"
   },
   "keywords": [

src/compute.ts

@@ -26,7 +26,7 @@ import { CustomScrollAction, Options } from './types'
 // @TODO better shadowdom test, 11 = document fragment
 const isElement = el =>
   el != null &&
-  typeof el == 'object' &&
+  typeof el === 'object' &&
   (el.nodeType === 1 || el.nodeType === 11)
 
 const hasScrollableSpace = (el, axis: 'X' | 'Y') =>
@@ -91,7 +91,6 @@ const alignNearest = (
    *   │┃         ┃│        do nothing
    *   └───────────┘
    *    ┗ ━ ━ ━ ━ ┛
-
    */
   if (
     (elementEdgeStart < scrollingEdgeStart &&
@@ -139,7 +138,6 @@ const alignNearest = (
    *    ┃   │     ┃     │   ┃         ┃ │
    *        └───────────┘   └───────────┘
    *    ┗ ━ ━ ━ ━ ┛         ┗ ━ ━ ━ ━ ┛
-
    */
   if (
     (elementEdgeStart < scrollingEdgeStart && elementSize < scrollingSize) ||
@@ -213,13 +211,13 @@ export default (
   // The default behavior is to check if the current target matches the boundary element or not
   // If undefined it'll check that target is never undefined (can happen as we recurse up the tree)
   const checkBoundary =
-    typeof boundary == 'function' ? boundary : parent => parent !== boundary
+    typeof boundary === 'function' ? boundary : node => node !== boundary
 
   if (!isElement(target)) {
     throw new Error('Element is required in scrollIntoView')
   }
 
-  let targetRect = target.getBoundingClientRect()
+  const targetRect = target.getBoundingClientRect()
   const viewport = document.scrollingElement || document.documentElement
 
   // Collect all the scrolling boxes, as defined in the spec: https://drafts.csswg.org/cssom-view/#scrolling-box

src/index.ts

@@ -22,8 +22,9 @@ export interface Options<T = any> extends BaseOptions {
 let supportsScrollBehavior
 let scrollingElement
 
+// tslint:disable-next-line: ban-types
 const isFunction = (arg: any): arg is Function => {
-  return typeof arg == 'function'
+  return typeof arg === 'function'
 }
 const isOptionsObject = <T>(options: any): options is T => {
   return options === Object(options) && Object.keys(options).length !== 0

src/types.ts

@@ -16,11 +16,13 @@ export interface Options {
 }
 
 // Custom behavior, not in any spec
-export interface CustomScrollBoundaryCallback {
-  (parent: Element): boolean
-}
+export type CustomScrollBoundaryCallback = (parent: Element) => boolean
 export type CustomScrollBoundary = Element | CustomScrollBoundaryCallback
-export type CustomScrollAction = { el: Element; top: number; left: number }
-export interface CustomScrollBehaviorCallback<T> {
-  (actions: CustomScrollAction[]): T
+export interface CustomScrollAction {
+  el: Element
+  top: number
+  left: number
 }
+export type CustomScrollBehaviorCallback<T> = (
+  actions: CustomScrollAction[]
+) => T

tests/web-platform/package.json

@@ -2,6 +2,7 @@
   "private": true,
   "scripts": {
     "browserstack": "wdio ./browserstack.conf.js",
+    "lint": "tslint -c tslint.json 'src/**/*.ts'",
     "start": "serve -i cypress/ -p 3000",
     "test": "cypress run --browser chrome --reporter junit --reporter-options 'mochaFile=junit/test-results.xml'"
   },

tslint.json

@@ -0,0 +1,10 @@
+{
+  "defaultSeverity": "error",
+  "extends": ["tslint:recommended", "tslint-config-prettier"],
+  "jsRules": {},
+  "rules": {
+    "interface-name": [true, "never-prefix"],
+    "no-console": [true]
+  },
+  "rulesDirectory": []
+}

yarn.lock

@@ -1117,7 +1117,7 @@ buffer-from@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.0.0.tgz#4cb8832d23612589b0406e9e2956c17f06fdf531"
 
-builtin-modules@^1.0.0:
+builtin-modules@^1.0.0, builtin-modules@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-1.1.1.tgz#270f076c5a72c02f5b65a47df94c5fe3a278892f"
 
@@ -1358,7 +1358,7 @@ [email protected]:
   version "2.6.0"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.6.0.tgz#9df7e52fb2a0cb0fb89058ee80c3104225f37e1d"
 
-commander@^2.11.0, commander@^2.14.1, commander@^2.8.1, commander@^2.9.0:
+commander@^2.11.0, commander@^2.12.1, commander@^2.14.1, commander@^2.8.1, commander@^2.9.0:
   version "2.15.1"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f"
 
@@ -3045,7 +3045,7 @@ js-tokens@^3.0.0, js-tokens@^3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.2.tgz#9866df395102130e38f7f996bceb65443209c25b"
 
-js-yaml@^3.9.0, js-yaml@^3.9.1:
+js-yaml@^3.7.0, js-yaml@^3.9.0, js-yaml@^3.9.1:
   version "3.11.0"
   resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.11.0.tgz#597c1a8bd57152f26d622ce4117851a51f5ebaef"
   dependencies:
@@ -5004,10 +5004,37 @@ trim-right@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/trim-right/-/trim-right-1.0.1.tgz#cb2e1203067e0c8de1f614094b9fe45704ea6003"
 
-tslib@^1.9.0:
+tslib@^1.8.0, tslib@^1.8.1, tslib@^1.9.0:
   version "1.9.1"
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.9.1.tgz#a5d1f0532a49221c87755cfcc89ca37197242ba7"
 
+[email protected]:
+  version "1.13.0"
+  resolved "https://registry.yarnpkg.com/tslint-config-prettier/-/tslint-config-prettier-1.13.0.tgz#189e821931ad89e0364e4e292d5c44a14e90ecd6"
+
+[email protected]:
+  version "5.10.0"
+  resolved "https://registry.yarnpkg.com/tslint/-/tslint-5.10.0.tgz#11e26bccb88afa02dd0d9956cae3d4540b5f54c3"
+  dependencies:
+    babel-code-frame "^6.22.0"
+    builtin-modules "^1.1.1"
+    chalk "^2.3.0"
+    commander "^2.12.1"
+    diff "^3.2.0"
+    glob "^7.1.1"
+    js-yaml "^3.7.0"
+    minimatch "^3.0.4"
+    resolve "^1.3.2"
+    semver "^5.3.0"
+    tslib "^1.8.0"
+    tsutils "^2.12.1"
+
+tsutils@^2.12.1:
+  version "2.27.1"
+  resolved "https://registry.yarnpkg.com/tsutils/-/tsutils-2.27.1.tgz#ab0276ac23664f36ce8fd4414daec4aebf4373ee"
+  dependencies:
+    tslib "^1.8.1"
+
 tunnel-agent@^0.6.0:
   version "0.6.0"
   resolved "https://registry.yarnpkg.com/tunnel-agent/-/tunnel-agent-0.6.0.tgz#27a5dea06b36b04a0a9966774b290868f0fc40fd"