feat: typescript migration

Author: simlu

.babelrc

@@ -1,5 +1,7 @@
 {
-  "presets": [["latest-node", {"target": "10"}]],
-  "plugins": [],
-  "sourceMaps": false
+  "presets": ["@babel/preset-env", "@babel/typescript"],
+  "plugins": [
+    "@babel/proposal-class-properties",
+    "@babel/proposal-object-rest-spread"
+  ]
 }

.idea/codeStyles/codeStyleConfig.xml

@@ -5,9 +5,11 @@
   "main": "lib/index.js",
   "scripts": {
     "clean": "rm -rf lib",
-    "build": "npx babel src --out-dir lib --copy-files --include-dotfiles --config-file ./.babelrc",
+    "build:js": "npx babel src --out-dir lib --copy-files --include-dotfiles --config-file ./.babelrc --extensions '.ts,.tsx'",
+    "build:types": "tsc --emitDeclarationOnly",
+    "build": "npm run build:types && npm run build:js",
     "build-clean": "yarn run clean && yarn run build",
-    "test-simple": "nyc mocha \"./test/**/*.spec.js\"",
+    "test-simple": "nyc mocha \"./test/**/*.spec.{js,ts}\"",
     "test": "yarn run clean && yarn run gardener && yarn run test-simple",
     "coveralls": "node ./node_modules/coveralls/bin/coveralls.js < ./coverage/lcov.info",
     "semantic-release": "yarn run build-clean && npx semantic-release",
@@ -44,24 +46,30 @@
   },
   "homepage": "https://github.com/blackflux/object-treeify#readme",
   "devDependencies": {
-    "@babel/cli": "7.12.1",
-    "@babel/core": "7.12.3",
+    "@babel/cli": "^7.12.1",
+    "@babel/core": "^7.12.3",
+    "@babel/preset-env": "^7.12.1",
+    "@babel/preset-typescript": "^7.12.1",
     "@babel/register": "7.12.1",
-    "@blackflux/eslint-plugin-rules": "1.3.41",
-    "@blackflux/robo-config-plugin": "3.10.14",
+    "@blackflux/eslint-plugin-rules": "1.3.40",
+    "@blackflux/robo-config-plugin": "3.10.9",
+    "@types/chai": "4.2.14",
+    "@types/mocha": "8.0.3",
     "babel-eslint": "10.1.0",
+    "babel-preset-latest-node": "5.0.0",
     "chai": "4.2.0",
     "coveralls": "3.1.0",
-    "eslint": "7.13.0",
-    "eslint-config-airbnb-base": "14.2.1",
+    "eslint": "7.11.0",
+    "eslint-config-airbnb-base": "14.2.0",
     "eslint-plugin-import": "2.22.1",
     "eslint-plugin-json": "2.1.2",
     "eslint-plugin-markdown": "1.0.2",
     "eslint-plugin-mocha": "8.0.0",
-    "js-gardener": "2.0.179",
+    "js-gardener": "2.0.177",
     "nyc": "15.1.0",
-    "semantic-release": "17.2.3",
-    "babel-preset-latest-node": "5.1.1"
+    "semantic-release": "17.2.1",
+    "ts-node": "9.0.0",
+    "typescript": "^4.0.3"
   },
   "nyc": {
     "tempDir": "./coverage/.nyc_output",
@@ -73,18 +81,21 @@
     "functions": 100,
     "branches": 100,
     "include": [
-      "**/*.js"
+      "**/*.js",
+      "**/*.ts"
     ],
     "reporter": [
       "lcov",
       "text-summary"
     ],
     "require": [
-      "@babel/register"
+      "ts-node/register"
+    ],
+    "extension": [
+      ".js",
+      ".ts"
     ],
-    "extension": [],
     "cache": true,
-    "all": true,
     "babel": true,
     "exclude": [
       "gardener.js",

.idea/jsLinters/eslint.xml

@@ -1,6 +1,6 @@
 const assert = require('assert');
 
-const buildCtx = (opts) => {
+const buildCtx = (opts: Object) => {
   const ctx = {
     joined: true,
     spacerNoNeighbour: '   ',
@@ -19,17 +19,19 @@ const buildCtx = (opts) => {
   return ctx;
 };
 
-module.exports = (tree, opts = {}) => {
+export default (tree: Object, opts: Object = {}) => {
   const ctx = buildCtx(opts);
   const result = [];
 
-  const sort = (input) => (ctx.sortFn === null ? input.reverse() : input.sort((a, b) => ctx.sortFn(b, a)));
+  const sort = (input: Array<string>) => (ctx.sortFn === null
+    ? input.reverse()
+    : input.sort((a, b) => ctx.sortFn(b, a)));
 
   const neighbours = [];
   const keys = sort(Object.keys(tree)).map((k) => [k]);
-  const lookup = [tree];
+  const lookup : Array<any> = [tree];
   while (keys.length !== 0) {
-    const key = keys.pop();
+    const key: Array<string> = keys.pop();
     const node = lookup[key.length - 1][key[key.length - 1]];
 
     neighbours[key.length - 1] = keys.length !== 0 && keys[keys.length - 1].length === key.length;

package.json

@@ -1,5 +1,6 @@
+import treeify from '../src/index';
+
 const expect = require('chai').expect;
-const treeify = require('../src/index');
 
 describe('Testing Treeify', () => {
   it('Testing Comprehensive Null Example', () => {
@@ -99,7 +100,7 @@ describe('Testing Treeify', () => {
         9: null
       }
     }, {
-      sortFn: (a, b) => Number(b) - Number(a)
+      sortFn: (a: string, b: string) => Number(b) - Number(a)
     })).to.deep.equal([
       '├─ 7',
       '│  ├─ 9',

src/index.js renamed to src/index.ts

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "esnext"
+    ],
+    "outDir": "./lib",
+    "target": "esnext",
+    "declaration": true,
+    "allowSyntheticDefaultImports": true,
+    "module": "CommonJS",
+    "moduleResolution": "Node"
+  },
+  "include": [
+    "./src/*"
+  ]
+}