Fix: Incorrect TypeScript declarations and export format (#136)

* Do not run build step on local install, only during publish

* A few more keywords while at it

* moving to ts

* about to setup prettier

* add prettier

* Update command

* setup husky

* Fix html

* Fix html

* test pretty html

* Add editor config

* update editor config

* updated indentation rules

* test indent

* tweak setup with html

* Implementing typescript

* setup export properly

* test ts on ci

* cleanup

* no sourcemap

* wrong cli argument

* typo

* tweak readme

Author: stipsan

.babelrc

@@ -16,6 +16,8 @@ jobs:
 
       - run: yarn install
 
+      - run: yarn test
+
       - save_cache:
           paths:
             - node_modules

.circleci/config.yml

@@ -0,0 +1,9 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space

.editorconfig

@@ -0,0 +1,3 @@
+node_modules
+dist
+package.json

.prettierignore

@@ -0,0 +1,3 @@
+singleQuote: true
+trailingComma: es5
+semi: false

.prettierrc

@@ -12,7 +12,7 @@ yarn add scroll-into-view-if-needed
 
 ## API
 
-### scrollIntoViewIfNeeded(node:Element, centerIfNeeded:boolean, options:object)
+### scrollIntoViewIfNeeded(node:Element, centerIfNeeded:boolean, AnimateOptions:object)
 
 Returns a function that can be used to cancel a scroll animation.
 Inspired by [scroll-iv](https://www.npmjs.com/package/scroll-iv).
@@ -24,11 +24,11 @@ Inspired by [scroll-iv](https://www.npmjs.com/package/scroll-iv).
 This defaults to true to match the behavior of the WebKit/Blink implementation.
 Set it to false to actually only scroll the parent when needed and not further than absolutely necessary.
 
-##### duration
+##### AnimateOptions.duration
 
 The duration of the animation in milliseconds, defaults to 0 for no animation.
 
-##### easing
+##### AnimateOptions.easing
 
 default is ease. Possible values: `ease|easeIn|easeOut|easeInOut|linear`
 

README.md

@@ -1,41 +1,28 @@
 {
   "name": "scroll-into-view-if-needed",
   "description": "Element.scrollIntoViewIfNeeded ponyfill that can animate the scrolling",
-  "main": "dist/index.js",
-  "typings": "typings.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "npm run clean && npm run build-module && npm run build-bundle",
-    "build-module": "babel src -d dist",
-    "build-bundle": "rollup src/index.js --format cjs -c --output dist/bundle.js && rollup test/index.js -c -f umd --output test/bundle.js",
-    "clean": "rimraf dist",
-    "prepublish": "npm run build",
-    "changelog:preview": "sr-changelog",
-    "changelog:commit": "sr-changelog commit",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
-  },
-  "release": {
-    "analyzeCommits": "semantic-release-tamia/analyzeCommits",
-    "verifyConditions": "condition-circle",
-    "generateNotes": "semantic-release-tamia/generateNotes",
-    "verifyRelease": "semantic-release-tamia/verifyRelease"
-  },
+  "author": "Stian Didriksen",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/stipsan/scroll-into-view-if-needed.git"
   },
-  "keywords": [
-    "ponyfill",
-    "smooth",
-    "scroll",
-    "scroll-into-view"
-  ],
-  "author": "Stian Didriksen",
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/stipsan/scroll-into-view-if-needed/issues"
   },
-  "homepage": "https://github.com/stipsan/scroll-into-view-if-needed#readme",
+  "main": "dist/bundle.js",
+  "scripts": {
+    "build": "npm run clean && npm run build-module && npm run build-bundle",
+    "build-bundle": "rollup -c",
+    "build-module": "tsc",
+    "changelog:commit": "sr-changelog commit",
+    "changelog:preview": "sr-changelog",
+    "clean": "rimraf dist",
+    "precommit": "lint-staged",
+    "prepublishOnly": "yarn build",
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post",
+    "test": "tsc --noEmit"
+  },
   "dependencies": {
     "amator": "1.0.1"
   },
@@ -44,11 +31,54 @@
     "babel-plugin-add-module-exports": "^0.2.1",
     "babel-preset-env": "^1.2.1",
     "babel-preset-es2015-rollup": "^3.0.0",
+    "husky": "^0.14.3",
+    "lint-staged": "^4.3.0",
+    "prettier": "^1.7.4",
     "release-relief": "^1.0.1",
     "rimraf": "^2.6.1",
-    "rollup": "^0.41.4",
+    "rollup": "^0.50.0",
     "rollup-plugin-babel": "^2.7.1",
     "rollup-plugin-commonjs": "^8.0.2",
-    "rollup-plugin-node-resolve": "^2.0.0"
-  }
+    "rollup-plugin-node-resolve": "^2.0.0",
+    "typescript": "^2.6.1"
+  },
+  "keywords": [
+    "ponyfill",
+    "scroll",
+    "scroll-into-view",
+    "scrollIntoView",
+    "scrollIntoViewIfNeeded",
+    "smooth",
+    "smooth"
+  ],
+  "lint-staged": {
+    "*.html": [
+      "npx https://gist.github.com/stipsan/0d0578fe92bcdeb024a0af2a3e2a9e2a",
+      "git add"
+    ],
+    "*.js": [
+      "prettier --write",
+      "git add"
+    ],
+    "*.ts": [
+      "prettier --write",
+      "git add"
+    ],
+    "*.json": [
+      "prettier --write",
+      "git add"
+    ],
+    "package.json": [
+      "npx prettier-package-json --write",
+      "git add"
+    ]
+  },
+  "module": "dist/index.js",
+  "release": {
+    "analyzeCommits": "semantic-release-tamia/analyzeCommits",
+    "verifyConditions": "condition-circle",
+    "generateNotes": "semantic-release-tamia/generateNotes",
+    "verifyRelease": "semantic-release-tamia/verifyRelease"
+  },
+  "typings": "dist/index.d.ts"
 }

package.json

@@ -1,20 +1,36 @@
-import commonjs from 'rollup-plugin-commonjs';
-import nodeResolve from 'rollup-plugin-node-resolve';
+import commonjs from 'rollup-plugin-commonjs'
+import nodeResolve from 'rollup-plugin-node-resolve'
+const globals = {}
 
 export default {
+  entry: 'dist/index.js',
+  dest: 'dist/bundle.js',
+  format: 'umd',
+  moduleName: 'scrollIntoViewIfNeeded',
+  exports: 'named',
+  globals,
+  onwarn,
   plugins: [
     nodeResolve({
       jsnext: true,
-      main: true
+      main: true,
     }),
 
     commonjs({
       // non-CommonJS modules will be ignored, but you can also
       // specifically include/exclude files
-      include: 'node_modules/**',  // Default: undefined
+      include: 'node_modules/**', // Default: undefined
 
       // if false then skip sourceMap generation for CommonJS modules
-      sourceMap: false,  // Default: true
-    })
-  ]
-}
+      sourceMap: false, // Default: true
+    }),
+  ],
+}
+
+function onwarn(message) {
+  const suppressed = ['UNRESOLVED_IMPORT', 'THIS_IS_UNDEFINED']
+
+  if (!suppressed.find(code => message.code === code)) {
+    return console.warn(message.message)
+  }
+}