feat: adds basic typescript setup

.circleci/config.yml

@@ -1,6 +1,5 @@
 version: 2.1
 
-
 commands:
   npm-install:
     steps:
@@ -18,30 +17,28 @@ commands:
       - run: echo $(python --version) > .python-version
       - restore_cache:
           key: py-deps-{{ checksum ".python-version" }}-{{ checksum "docs/requirements.txt" }}
-      - run: "if [ ! -d ./venv ]; then python -m venv ./venv; fi"
+      - run: 'if [ ! -d ./venv ]; then python -m venv ./venv; fi'
       - run: echo "source $(pwd)/venv/bin/activate" >> $BASH_ENV
       - run: pip install -r ./docs/requirements.txt
       - save_cache:
           key: py-deps-{{ checksum "docs/requirements.txt" }}
           paths:
             - ./venv
 
-
 aliases:
   - &node12
     image: circleci/node:12
 
-  - &python-docs
-    # using Python 3.6 as that's the version ReadTheDocs is running
+  - &python-docs # using Python 3.6 as that's the version ReadTheDocs is running
     image: circleci/python:3.6-node
 
   - &test-steps
     steps:
       - checkout
       - npm-install
+      - run: npm run build
       - run: npm run ci:test
 
-
 jobs:
   test-node12:
     docker: [<<: *node12]
@@ -60,13 +57,15 @@ jobs:
     steps:
       - checkout
       - npm-install
+      - run: npm run build
       - run: npm run e2e:apib
 
   test-e2e-openapi2:
     docker: [<<: *node12]
     steps:
       - checkout
       - npm-install
+      - run: npm run build
       - run: npm run e2e:openapi2
 
   quality-checks:
@@ -112,7 +111,6 @@ jobs:
       - npm-install
       - run: npm run ci:release
 
-
 workflows:
   version: 2
   test-and-release:

.gitignore

@@ -1,6 +1,7 @@
 package-lock.json
 npm-shrinkwrap.json
 
+/build
 /coverage
 /docs/_build
 node_modules

appveyor.yml

@@ -1,15 +1,16 @@
 environment:
-  nodejs_version: "12"
+  nodejs_version: '12'
 install:
   - ps: Install-Product node 12
-  - "npm -g install npm@6"
+  - 'npm -g install npm@6'
   - "set PATH=%APPDATA%\\npm;%PATH%"
-  - "npm install"
+  - 'npm install'
 cache:
-  - "node_modules -> package.json"
+  - 'node_modules -> package.json'
   - "%APPDATA%\\npm-cache -> package.json"
 build: off
 test_script:
-  - "node --version"
-  - "npm --version"
-  - "npm test"
+  - 'node --version'
+  - 'npm --version'
+  - 'npm run build'
+  - 'npm test'

bin/dredd

@@ -8,7 +8,7 @@
   }
 });
 
-const CLI = require('../lib/CLI');
+const CLI = require('../build/CLI');
 
 const dreddCli = new CLI({
   custom: {

package.json

@@ -2,14 +2,16 @@
   "name": "dredd",
   "version": "0.0.0-semantically-released",
   "description": "HTTP API Testing Framework",
-  "main": "lib/Dredd.js",
+  "main": "build/Dredd.js",
   "bin": {
     "dredd": "bin/dredd"
   },
   "engines": {
     "node": ">=8"
   },
   "scripts": {
+    "start": "npm run build -- --watch",
+    "build": "tsc --build tsconfig.json",
     "docs:lint": "sphinx-build -nW -b linkcheck ./docs ./docs/_build",
     "docs:test-extensions": "python -m unittest docs/_extensions/*.py --verbose",
     "docs:build": "sphinx-build -nW -b html ./docs ./docs/_build",
@@ -26,15 +28,16 @@
     "ci:docs": "npm run docs:build",
     "ci:test": "npm test",
     "ci:smoke": "bash ./scripts/smoke.sh",
-    "ci:release": "semantic-release && npm dist-tag add \"dredd@$(npm view dredd version)\" stable"
+    "ci:release": "semantic-release && npm dist-tag add \"dredd@$(npm view dredd version)\" stable",
+    "prepack": "npm run build"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/apiaryio/dredd"
   },
   "files": [
     "bin",
-    "lib",
+    "build",
     "options.json",
     "README.md"
   ],

tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compileOnSave": true,
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2017",
+    "lib": ["es2017"],
+    "typeRoots": ["node_modules/@types"],
+    "rootDir": "./lib",
+    "outDir": "./build",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["./lib/**/*.ts", "./lib/**/*.js"],
+  "exclude": ["node_modules", "build"]
+}