fix(options): allow omitting options (#135)

* setup jest

* add first test case

* Run tests on the ci

* fix rootDir behavior

* updated test case to detect missing promises

* fix failing test

Author: stipsan

.circleci/config.yml

@@ -41,6 +41,18 @@ jobs:
       - run: npx bundlesize
       - save-cache: *save-cache
 
+  Test:
+    docker:
+      - image: circleci/node:8
+    steps:
+      - checkout
+      - restore-cache: *restore-cache
+      - *install
+      - run: 
+          command: yarn test --ci --runInBand
+      - store_test_results:
+          path: reports
+
   Semantic Release:
     docker:
       - image: circleci/node:8
@@ -57,10 +69,12 @@ workflows:
     jobs:
       - Typecheck
       - Build
+      - Test
       - Semantic Release:
           requires:
             - Typecheck
             - Build
+            - Test
           filters:
             branches:
               only:

.gitignore

@@ -61,6 +61,7 @@ dist
 es
 typings
 umd
+reports
 /*.js
 !.babelrc.js
 !rollup.config.js

package.json

@@ -28,6 +28,7 @@
     "precommit": "lint-staged",
     "dev": "concurrently 'tsc --noEmit --watch' 'yarn build:cjs --watch' 'yarn build:es --watch' 'yarn build:umd --watch' 'yarn build:umd.min --watch'",
     "prepublishOnly": "unset npm_config_cafile && yarn build",
+    "test": "jest",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
@@ -39,6 +40,7 @@
     "@babel/plugin-external-helpers": "7.0.0-beta.54",
     "@babel/preset-env": "7.0.0-beta.54",
     "@babel/preset-typescript": "7.0.0-beta.54",
+    "@types/jest": "23.3.0",
     "babel-eslint": "8.2.6",
     "babel-plugin-add-module-exports": "0.2.1",
     "babel-plugin-dev-expression": "0.2.1",
@@ -48,6 +50,8 @@
     "eslint-plugin-import": "2.13.0",
     "eslint-plugin-react": "7.10.0",
     "husky": "0.14.3",
+    "jest": "23.4.1",
+    "jest-junit": "5.1.0",
     "lint-staged": "7.2.0",
     "prettier": "1.13.7",
     "prettier-package-json": "1.6.0",
@@ -59,6 +63,7 @@
     "rollup-plugin-replace": "2.0.0",
     "rollup-plugin-terser": "1.0.1",
     "semantic-release": "15.8.0",
+    "ts-jest": "23.0.1",
     "typescript": "2.9.2"
   },
   "keywords": [
@@ -87,6 +92,29 @@
       "compression": "none"
     }
   ],
+  "jest": {
+    "transform": {
+      "^.+\\.ts$": "ts-jest"
+    },
+    "testRegex": "(/tests/.*|(\\.|/)(test|spec))\\.(js|ts)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
+    ],
+    "reporters": [
+      "default",
+      [
+        "jest-junit",
+        {
+          "output": "reports/jest/results.xml"
+        }
+      ]
+    ]
+  },
   "lint-staged": {
     "*.js": [
       "prettier --write",

src/index.ts

@@ -102,8 +102,8 @@ function scroll(target: Element, options?: SmoothBehaviorOptions): Promise<any>
 function scroll<T>(target: Element, options: CustomBehaviorOptions<T>): T
 function scroll(target: Element, options: StandardBehaviorOptions): void
 function scroll<T>(target: Element, options?: any) {
-  if (shouldSmoothScroll<SmoothBehaviorOptions>(options)) {
-    const overrides = options || {}
+  const overrides = options || {}
+  if (shouldSmoothScroll<SmoothBehaviorOptions>(overrides)) {
     // @TODO replace <any> in promise signatures with better information
     return scrollIntoView<Promise<any>>(target, {
       block: overrides.block,

tests/interface.test.ts

@@ -0,0 +1,11 @@
+import scrollIntoView from '../src'
+
+jest.mock(
+  'scroll-into-view-if-needed',
+  () => (_target: Element, options: any) => options.behavior([])
+)
+
+test('options is optional', () => {
+  expect.assertions(1)
+  return expect(scrollIntoView(document.body)).resolves.toEqual([])
+})

tsconfig.json

@@ -3,6 +3,7 @@
     "target": "es5",
     "module": "es2015",
     "moduleResolution": "node",
+    "esModuleInterop": true,
     "declaration": true,
     "rootDir": "src",
     "declarationDir": "typings",
@@ -17,5 +18,5 @@
     "alwaysStrict": true,
     "lib": ["es5", "es2015.promise", "dom"]
   },
-  "exclude": ["dist", "example", "**/*-test.ts", "cypress"]
+  "exclude": ["tests"]
 }