Migration of extension-port-stream to typescript

.circleci/config.yml

@@ -0,0 +1,66 @@
+version: 2.1
+
+workflows:
+  build-test:
+    jobs:
+      - prep-deps
+      - test-build:
+          requires:
+            - prep-deps
+      - test-lint:
+          requires:
+            - prep-deps
+      - all-tests-pass:
+          requires:
+            - test-build
+            - test-lint
+
+jobs:
+  prep-deps:
+    docker:
+      - image: circleci/node:10
+    steps:
+      - checkout
+      - run:
+          name: Install deps
+          command: |
+            .circleci/scripts/deps-install.sh
+      - run:
+          name: Collect yarn install HAR logs
+          command: |
+            .circleci/scripts/collect-har-artifact.sh
+      - persist_to_workspace:
+          root: .
+          paths:
+          - node_modules
+          - build-artifacts
+
+  test-build:
+    docker:
+      - image: circleci/node:10
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run:
+          name: Build project
+          command: yarn build
+
+  test-lint:
+    docker:
+      - image: circleci/node:10
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run:
+          name: Lint
+          command: yarn lint
+
+  all-tests-pass:
+    docker:
+      - image: circleci/node:10
+    steps:
+      - run:
+          name: All tests passed
+          command: echo 'Great success'

.circleci/scripts/collect-har-artifact.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -x
+set -e
+set -u
+set -o pipefail
+
+mkdir -p build-artifacts/yarn-install-har
+mv ./*.har build-artifacts/yarn-install-har/

.circleci/scripts/deps-install.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -x
+set -e
+set -u
+set -o pipefail
+
+yarn --frozen-lockfile --ignore-scripts --har

.eslintrc.js

@@ -0,0 +1,32 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    ecmaVersion: 2017,
+  },
+  extends: [
+    '@metamask/eslint-config',
+    '@metamask/eslint-config/config/nodejs',
+    '@metamask/eslint-config/config/typescript',
+  ],
+  plugins: [
+    'json',
+  ],
+  overrides: [{
+    files: [
+      '*.js',
+      '*.json',
+    ],
+    parserOptions: {
+      sourceType: 'script',
+    },
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+      '@typescript-eslint/no-var-requires': 'off',
+    },
+  }],
+  ignorePatterns: [
+    '!eslintrc.js',
+    'dist/',
+    'node_modules/',
+  ],
+};

.gitignore

@@ -1 +1,16 @@
 node_modules/
+package-lock.json
+dist/
+
+# IDEs
+.idea
+.vscode
+.sublime-project
+
+# VIM
+*.swp
+*.swo
+
+temp
+.tmp
+.DS_Store

README.md

@@ -1,6 +1,6 @@
 # Extension Port Stream
 
-A module for creating a node-style stream over a WebExtension port object.
+A module for creating a Node-style stream over a WebExtension [Runtime.Port](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/Port) object.
 
 ## Usage
 
@@ -12,4 +12,3 @@ const portStream = new PortStream(remotePort)
 
 // Enjoy!
 ```
-

package.json

@@ -2,10 +2,16 @@
   "name": "extension-port-stream",
   "version": "1.0.0",
   "description": "A module for creating a node style stream over a WebExtension port object.",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
+    "build": "tsc --project .",
+    "lint": "eslint . --ext ts,js,json",
+    "lint:fix": "yarn lint --fix",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "files": [
+    "dist/"
+  ],
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/MetaMask/extension-port-stream.git"
@@ -20,8 +26,17 @@
     "url": "https://github.com/MetaMask/extension-port-stream/issues"
   },
   "homepage": "https://github.com/MetaMask/extension-port-stream#readme",
-  "dependencies": {
-    "readable-stream": "^2.3.6",
-    "util": "^0.11.0"
+  "dependencies": {},
+  "devDependencies": {
+    "@metamask/eslint-config": "^4.1.0",
+    "@types/node": "14.14.7",
+    "@typescript-eslint/eslint-plugin": "^4.8.1",
+    "@typescript-eslint/parser": "^4.8.1",
+    "eslint": "^7.13.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-json": "^2.1.2",
+    "eslint-plugin-node": "^11.1.0",
+    "typescript": "^4.0.5",
+    "webextension-polyfill-ts": "^0.22.0"
   }
 }