(Archived) Adopt TypeScript

.circleci/config.yml

@@ -1,6 +1,5 @@
 version: 2.1
 
-
 commands:
   npm-install:
     steps:
@@ -18,31 +17,36 @@ 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:
+  build:
+    docker: [<<: *node12]
+    steps:
+      - checkout
+      - npm-install
+      - run: npm run build
+
   test-node12:
     docker: [<<: *node12]
     <<: *test-steps
@@ -60,13 +64,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:
@@ -94,6 +100,7 @@ jobs:
     steps:
       - checkout
       - npm-install
+      - run: npm run build
       - run: npm run ci:smoke
 
   release:
@@ -103,21 +110,22 @@ jobs:
     steps:
       - checkout
       - npm-install
+      - run: npm run build
       - run: npm run ci:release
 
-
 workflows:
   version: 2
   test-and-release:
     jobs:
       - quality-checks
+      - docs-dry-run
       - test-node12
       - test-node10
       - test-node8
       - test-e2e-apib
       - test-e2e-openapi2
       - smoke-tests
-      - docs-dry-run
+
       - release:
           requires:
             - quality-checks

.eslintignore

@@ -2,6 +2,7 @@
 .vscode
 coverage
 docs
+build
 
 # In case Python virtualenv is present in the project directory, this ignores
 # its contents (some Python projects vendor JavaScript files, etc.)

.eslintrc.js

@@ -1,28 +1,20 @@
 module.exports = {
-  extends: 'airbnb-base',
+  extends: ['airbnb-base', 'prettier'],
   env: {
-    'node': true
+    node: true
   },
   rules: {
     // Using 'console' is perfectly okay for a Node.js CLI tool and avoiding
     // it only brings unnecessary complexity
     'no-console': 'off',
 
-    // Node 6 does not support dangling commas in function arguments
-    'comma-dangle': [
-      'error',
-      {
-        'arrays': 'always-multiline',
-        'objects': 'always-multiline',
-        'functions': 'never'
-      }
-    ],
-
     // This is to allow a convention for exporting functions solely for
     // the purpose of the unit tests, see
     // https://github.com/apiaryio/dredd-transactions/pull/179#discussion_r206852270
     'no-underscore-dangle': 'off',
 
+    'import/prefer-default-export': 'off',
+
     // Following rules were introduced to make the decaffeination
     // of the codebase possible and are to be removed in the future
     'class-methods-use-this': 'off',
@@ -38,6 +30,6 @@ module.exports = {
     'no-plusplus': 'off',
     'no-restricted-syntax': 'off',
     'no-use-before-define': 'off',
-    'prefer-destructuring': 'off',
+    'prefer-destructuring': 'off'
   }
-};
+}

.gitignore

@@ -3,6 +3,8 @@ npm-shrinkwrap.json
 
 /coverage
 /docs/_build
+build
+typings
 node_modules
 .idea
 .vscode

.npmignore

@@ -0,0 +1,2 @@
+# Prevent publishing source code to NPM
+lib

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": true,
+  "arrowParens": "always",
+  "singleQuote": true,
+  "trailingComma": "none"
+}

appveyor.yml

@@ -1,15 +1,16 @@
 environment:
-  nodejs_version: "10"
+  nodejs_version: '10'
 install:
   - ps: Install-Product node 10
-  - "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,13 +8,13 @@
   }
 });
 
-const CLI = require('../lib/CLI');
+const CLI = require('../build/CLI').default;
 
-const dreddCli = new CLI({
+const dreddCLI = new CLI({
   custom: {
     cwd: process.cwd(),
-    argv: process.argv.slice(2),
-  },
+    argv: process.argv.slice(2)
+  }
 });
 
-dreddCli.run();
+dreddCLI.run();

docs/usage-cli.rst

@@ -83,4 +83,4 @@ CLI Options Reference
 
 Remember you can always list all available arguments by ``dredd --help``.
 
-.. cli-options:: ../lib/options.json
+.. cli-options:: ../options.json