Add support to Typescript (#151)

Julio Farah · web-flow · commit bdc86fbc31f2 · 2020-06-08T09:32:17.000-07:00
* Add support to Typescript

* 3.13.4-beta.0

* add typescript support for karma

* bump history

* remove tests from tsconfig include

* use module commonjs

* remove commit message rules

* bump node to 13.14

* point tests to /build dir

* bump node to 12.18

* add .npmignore
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,7 +1,7 @@
 defaults: &defaults
   working_directory: ~/analytics.js-core
   docker:
-    - image: circleci/node:8-browsers
+    - image: circleci/node:12-browsers
 
 version: 2
 jobs:
@@ -17,7 +17,6 @@ jobs:
           key: yarn-dependency-cache-{{ checksum "yarn.lock" }}
           paths:
             - node_modules
-      - run: yarn commitlint-circle 
       - run: make test
       - store_test_results:
           path: junit-reports
@@ -33,6 +32,7 @@ jobs:
           key: yarn-dependency-cache-{{ checksum "yarn.lock" }}
           paths:
             - node_modules
+      - run: yarn run tsc
       - run: yarn run karma start karma.conf.coverage.js
       - store_test_results:
           path: junit-reports
@@ -61,6 +61,7 @@ jobs:
       - checkout
       - attach_workspace: { at: . }
       - run: npm config set "//registry.npmjs.org/:_authToken" $NPM_AUTH
+      - run: yarn tsc
       - run: npm publish .
 
 workflows:
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,6 @@ coverage
 node_modules
 package-lock.json
 junit-reports
+
+build/
+.DS_Store
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,13 @@
+.circleci
+.github
+node_modules
+test/**/*
+lib/**/*
+.eslintrc
+.gitignore
+.nvmrc
+.prettierrc
+*.md
+karma.*
+Makefile
+tsconfig.json
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-8.17.0
+12.18.0
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,3 +1,7 @@
+# 3.13.4 / 2020-06-02
+
+- refactor: enable typescript support
+
 # 3.13.3 / 2020-05-26
 
 - feat: add destination middleware
diff --git a/Makefile b/Makefile
@@ -45,9 +45,14 @@ GREP ?= .
 install:
 	yarn
 
+# Build typescript
+build: clean install
+	yarn tsc
+.PHONY: build
+
 # Remove temporary files and build artifacts.
 clean:
-	rm -rf *.log coverage
+	rm -rf *.log coverage build
 .PHONY: clean
 
 # Remove temporary files, build artifacts, and vendor dependencies.
@@ -67,7 +72,7 @@ fmt: install
 .PHONY: fmt
 
 # Run browser unit tests in a browser.
-test-browser: install
+test-browser: build
 	@$(KARMA) start $(KARMA_FLAGS) $(KARMA_CONF)
 .PHONY: test-browser
 
diff --git a/karma.conf.js b/karma.conf.js
@@ -5,6 +5,11 @@
 var TEST_TIMEOUT = 10 * 60 * 1000;
 
 module.exports = function(config) {
+  require('ts-node').register({
+    compilerOptions: {
+      module: 'commonjs'
+    }
+  });
   config.set({
     files: [
       { pattern: 'test/support/*.html', included: false },
diff --git a/package.json b/package.json
@@ -1,23 +1,22 @@
 {
   "name": "@segment/analytics.js-core",
   "author": "Segment <friends@segment.com>",
-  "version": "3.13.3",
+  "version": "3.13.4",
   "description": "The hassle-free way to integrate analytics into any web application.",
   "keywords": [
     "analytics",
     "analytics.js",
     "segment",
     "segment.io"
   ],
-  "main": "lib/index.js",
+  "main": "build/index.js",
   "scripts": {
     "test": "make test",
     "lint": "eslint \"./{lib,test}/**/*.js\"",
     "format": "prettier-eslint --write --list-different \"./{lib,test}/**/*.{js,json,md}\"",
     "precommit": "lint-staged",
     "np": "np --no-publish",
-    "cz": "git-cz",
-    "commitmsg": "commitlint -E GIT_PARAMS"
+    "cz": "git-cz"
   },
   "repository": {
     "type": "git",
@@ -63,15 +62,12 @@
     "uuid": "^3.4.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^7.0.0",
-    "@commitlint/config-conventional": "^7.0.1",
     "@segment/analytics.js-integration": "^3.2.1",
     "@segment/eslint-config": "^4.0.0",
+    "@types/node": "^14.0.6",
     "browserify": "13.0.0",
     "browserify-istanbul": "^2.0.0",
     "codecov": "^3.0.2",
-    "commitizen": "^2.10.1",
-    "commitlint-circle": "^1.0.0",
     "compat-trigger-event": "^1.0.0",
     "component-each": "^0.2.6",
     "cz-conventional-changelog": "^2.1.0",
@@ -101,13 +97,10 @@
     "proclaim": "^3.4.1",
     "sinon": "^1.7.3",
     "snyk": "^1.83.0",
+    "ts-node": "^8.10.2",
+    "typescript": "^3.9.3",
     "watchify": "^3.7.0"
   },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "lint-staged": {
     "linters": {
       "*.{js,json,md}": [
@@ -116,11 +109,6 @@
       ]
     }
   },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
   "browserify": {
     "transform": [
       "package-json-versionify"
diff --git a/test/analytics.test.js b/test/analytics.test.js
@@ -1,15 +1,15 @@
 'use strict';
 
-var Analytics = require('../lib').constructor;
+var Analytics = require('../build').constructor;
 var Facade = require('segmentio-facade');
-var analytics = require('../lib');
+var analytics = require('../build');
 var assert = require('proclaim');
 var bind = require('component-event').bind;
 var createIntegration = require('@segment/analytics.js-integration');
 var extend = require('@ndhoule/extend');
 var type = require('component-type');
 var jQuery = require('jquery');
-var pageDefaults = require('../lib/pageDefaults');
+var pageDefaults = require('../build/pageDefaults');
 var sinon = require('sinon');
 var tick = require('next-tick');
 var trigger = require('compat-trigger-event');
diff --git a/test/clone.test.js b/test/clone.test.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var assert = require('proclaim');
-var clone = require('../lib/utils/clone');
+var clone = require('../build/utils/clone');
 
 describe('clone', function() {
   it('should be a function', function() {
diff --git a/test/cookie.test.js b/test/cookie.test.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var assert = require('proclaim');
-var cookie = require('../lib').constructor.cookie;
+var cookie = require('../build').constructor.cookie;
 
 describe('cookie', function() {
   beforeEach(function() {
diff --git a/test/each.test.js b/test/each.test.js
@@ -10,7 +10,7 @@
 var assert = require('assert');
 var keys = require('@ndhoule/keys');
 var sinon = require('sinon');
-var each = require('../lib/utils/each');
+var each = require('../build/utils/each');
 
 /**
  * Locals.
diff --git a/test/group.test.js b/test/group.test.js
@@ -1,7 +1,7 @@
 'use strict';
 
-var Analytics = require('../lib').constructor;
-var analytics = require('../lib');
+var Analytics = require('../build').constructor;
+var analytics = require('../build');
 var assert = require('proclaim');
 var sinon = require('sinon');
 
diff --git a/test/index.test.js b/test/index.test.js
@@ -1,6 +1,6 @@
 'use strict';
 
-var analytics = require('../lib');
+var analytics = require('../build');
 var assert = require('proclaim');
 
 describe('analytics', function() {
@@ -30,7 +30,7 @@ describe('analytics', function() {
     it('should restore global.analytics to its previous value', function() {
       assert(global.analytics === previousAnalyticsGlobal);
 
-      var analytics = require('../lib');
+      var analytics = require('../build');
       global.analytics = analytics;
 
       assert(global.analytics === analytics);
diff --git a/test/map.test.js b/test/map.test.js
@@ -9,7 +9,7 @@
 var assert = require('proclaim');
 var keys = require('@ndhoule/keys');
 var sinon = require('sinon');
-var map = require('../lib/utils/map');
+var map = require('../build/utils/map');
 
 describe('map', function() {
   var identity;
diff --git a/test/memory.test.js b/test/memory.test.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var assert = require('proclaim');
-var memory = require('../lib').constructor.memory;
+var memory = require('../build').constructor.memory;
 
 describe('memory', function() {
   afterEach(function() {
diff --git a/test/metrics.test.js b/test/metrics.test.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var assert = require('proclaim');
-var metrics = require('../lib').constructor.metrics;
+var metrics = require('../build').constructor.metrics;
 var sinon = require('sinon');
 var send = require('@segment/send-json');
 
diff --git a/test/middleware.test.js b/test/middleware.test.js
@@ -2,10 +2,11 @@
 
 var assert = require('proclaim');
 var Facade = require('segmentio-facade');
-var SourceMiddlewareChain = require('../lib/middleware').SourceMiddlewareChain;
-var IntegrationMiddlewareChain = require('../lib/middleware')
+var SourceMiddlewareChain = require('../build/middleware')
+  .SourceMiddlewareChain;
+var IntegrationMiddlewareChain = require('../build/middleware')
   .IntegrationMiddlewareChain;
-var middlewareChain = require('../lib/middleware').middlewareChain;
+var middlewareChain = require('../build/middleware').middlewareChain;
 
 describe('middlewareChain', function() {
   var chain;
diff --git a/test/normalize.test.js b/test/normalize.test.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var assert = require('proclaim');
-var normalize = require('../lib/normalize');
+var normalize = require('../build/normalize');
 
 describe('normalize', function() {
   var list = ['Segment', 'KISSmetrics'];
@@ -47,7 +47,7 @@ describe('normalize', function() {
     it('should move all other keys to context', function() {
       opts.context = { foo: 1 };
       opts.campaign = { name: 'campaign-name' };
-      opts.library = 'analytics-wordpress';
+      opts.buildrary = 'analytics-wordpress';
       opts.traits = { trait: true };
       var normalized = normalize(msg, list);
 
@@ -58,7 +58,7 @@ describe('normalize', function() {
         integrations: {},
         context: {
           campaign: { name: 'campaign-name' },
-          library: 'analytics-wordpress',
+          buildrary: 'analytics-wordpress',
           traits: { trait: true },
           foo: 1
         }
diff --git a/test/store.test.js b/test/store.test.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var assert = require('proclaim');
-var store = require('../lib').constructor.store;
+var store = require('../build').constructor.store;
 
 describe('store', function() {
   afterEach(function() {
diff --git a/test/user.test.js b/test/user.test.js
@@ -3,8 +3,8 @@
 var assert = require('proclaim');
 var rawCookie = require('@segment/cookie');
 var sinon = require('sinon');
-var analytics = require('../lib');
-var Analytics = require('../lib').constructor;
+var analytics = require('../build');
+var Analytics = require('../build').constructor;
 
 var cookie = Analytics.cookie;
 var store = Analytics.store;
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "ES5",
+    "allowJs": true,
+    "outDir": "build"
+  },
+  "exclude": ["node_modules", "*.md", "Makefile", "karma.*", "test"]
+}
diff --git a/yarn.lock b/yarn.lock
