feat: switch to typescript

Author: vladholubiev

.circleci/config.yml

@@ -1,6 +1,13 @@
+version: 2.1
+
 orbs:
   node: circleci/[email protected]
 
+parameters:
+  node_version:
+    type: string
+    default: '14'
+
 commands:
   install_deps:
     steps:
@@ -10,49 +17,17 @@ commands:
           dir: ~/repo/node_modules
           use-strict-cache: true
           steps:
-            - run: yarn install --pure-lockfile --ignore-scripts --no-progress
-
-version: 2.1
+            - run: yarn install --pure-lockfile --no-progress
 
 jobs:
-  tests_10:
-    executor:
-      name: node/default
-      tag: '10'
-    working_directory: ~/repo
-    environment:
-      - JEST_JUNIT_OUTPUT_DIR: './test-results/jest'
-      - JEST_JUNIT_OUTPUT_NAME: 'results.xml'
-    steps:
-      - checkout
-      - install_deps
-
-      - run: yarn test:internal
-
-      - store_test_results:
-          path: test-results
-  tests_12:
+  build:
     executor:
       name: node/default
-      tag: '12'
+      tag: << pipeline.parameters.node_version >>
     working_directory: ~/repo
-    environment:
-      - JEST_JUNIT_OUTPUT_DIR: './test-results/jest'
-      - JEST_JUNIT_OUTPUT_NAME: 'results.xml'
     steps:
       - checkout
       - install_deps
-
-      - run: yarn test:internal
-
-      - store_test_results:
-          path: test-results
-
-workflows:
-  version: 2
-
-  run_tests:
-    jobs:
-      - tests_10
-
-      - tests_12
+      - run: yarn test
+      - run: yarn type-check
+      - run: yarn lint:ci

.eslintignore

@@ -0,0 +1,4 @@
+coverage/
+lib/
+renovate.json
+tsconfig.json

.eslintrc

@@ -1,6 +1,6 @@
 {
   "root": true,
   "extends": [
-    "@shelf/eslint-config/backend"
+    "@shelf/eslint-config/typescript"
   ]
 }

.prettierignore

@@ -2,49 +2,68 @@
   "name": "@shelf/aws-lambda-brotli-unpacker",
   "version": "1.0.1",
   "description": "Unpacks large Lambda binaries to /tmp",
-  "license": "MIT",
+  "keywords": [
+    "lambda",
+    "brotli"
+  ],
   "repository": "shelfio/aws-lambda-brotli-unpacker",
+  "license": "MIT",
   "author": {
     "name": "Vlad Holubiev",
     "email": "[email protected]",
     "url": "shelf.io"
   },
-  "engines": {
-    "node": ">=10.16.0"
-  },
+  "main": "lib",
+  "files": [
+    "lib"
+  ],
   "scripts": {
-    "lint": "eslint . --fix",
+    "build": "rm -rf lib/ && yarn build:types && yarn build:code",
+    "build:code": "babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts' && find ./lib -name '*.test.d.ts' -delete",
+    "build:types": "tsc --emitDeclarationOnly --declaration --isolatedModules false --declarationDir lib",
+    "coverage": "yarn test --coverage",
+    "lint": "yarn lint:ci --fix",
+    "lint:ci": "eslint . --ext .js,.ts,.json",
+    "prepack": "yarn build",
+    "test": "bin/test",
     "test:internal": "rm -rf .test && mkdir .test && jest",
-    "test": "bin/test"
+    "type-check": "tsc --noEmit",
+    "type-check:watch": "npm run type-check -- --watch"
   },
-  "files": [
-    "src"
-  ],
-  "main": "src/index.js",
-  "keywords": [
-    "lambda",
-    "brotli"
-  ],
+  "lint-staged": {
+    "*.{html,md,yml}": [
+      "prettier --write"
+    ],
+    "*.{js,ts,json}": [
+      "eslint --fix"
+    ]
+  },
+  "babel": {
+    "extends": "@shelf/babel-config/backend"
+  },
+  "prettier": "@shelf/prettier-config",
   "dependencies": {
-    "tar-fs": "2.1.0"
+    "tar-fs": "2.1.1"
   },
   "devDependencies": {
-    "@shelf/eslint-config": "0.19.0",
-    "eslint": "7.6.0",
+    "@babel/cli": "7.17.6",
+    "@babel/core": "7.17.5",
+    "@shelf/babel-config": "0.1.8",
+    "@shelf/eslint-config": "2.13.0",
+    "@shelf/prettier-config": "1.0.0",
+    "@shelf/tsconfig": "0.0.6",
+    "@types/jest": "27.4.0",
+    "@types/node": "14",
+    "@types/tar-fs": "2.0.1",
+    "eslint": "8.9.0",
     "husky": "7.0.4",
-    "jest": "26.2.2",
-    "lint-staged": "10.2.11",
-    "prettier": "2.0.5"
+    "jest": "27.5.1",
+    "lint-staged": "12.3.4",
+    "prettier": "2.5.1",
+    "typescript": "4.5.5"
   },
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "git add"
-    ],
-    "*.{html,json,md,yml}": [
-      "prettier --write",
-      "git add"
-    ]
+  "engines": {
+    "node": ">=14"
   },
   "publishConfig": {
     "access": "public"

.prettierrc.json

@@ -1,25 +1,24 @@
-const fs = require('fs');
-
-const index = require('./index');
+import fs from 'fs';
+import {unpack} from './index';
 
 const outputBaseDir = './.test';
 const testPackageDir = './etc/test/packages';
 
 it('should unpack test-extract.tar.br package only once', async () => {
   const inputPath = `${testPackageDir}/test-extract.tar.br`;
   const outputPath = `${outputBaseDir}/test-extract/test-file.txt`;
-  await index.unpack({inputPath, outputBaseDir, outputPath});
+  await unpack({inputPath, outputBaseDir, outputPath});
 
   const expectedOutputPath = `${outputBaseDir}/test-extract/test-file.txt`;
 
   expect(fs.existsSync(expectedOutputPath)).toBe(true);
   expect(fs.readFileSync(expectedOutputPath, {encoding: 'utf-8'})).toBe('success\n');
 
   // Try again with the same output binary but a bogus package. It should ignore the package
-  await index.unpack({
+  await unpack({
     inputPath: `${outputBaseDir}/does-not-exist`,
     outputBaseDir,
-    outputPath
+    outputPath,
   });
 
   expect(fs.existsSync(expectedOutputPath)).toBe(true);

package.json

@@ -1,7 +1,9 @@
-const fs = require('fs');
-const path = require('path');
-const tar = require('tar-fs');
-const zlib = require('zlib');
+import fs from 'fs';
+import path from 'path';
+import tar from 'tar-fs';
+import zlib from 'zlib';
+
+type UnpackParams = {inputPath: string; outputBaseDir: string; outputPath: string};
 
 /**
  * Unpacks brotli archive of a .tar file to /tmp folder
@@ -10,27 +12,23 @@ const zlib = require('zlib');
  * @return {Promise<String>} Path to unpacked binary, equals to outputBin
  * @see https://github.com/alixaxel/chrome-aws-lambda
  */
-module.exports.unpack = function({inputPath, outputBaseDir, outputPath}) {
+export function unpack({inputPath, outputBaseDir, outputPath}: UnpackParams) {
   outputBaseDir = outputBaseDir || '/tmp';
 
   return new Promise((resolve, reject) => {
-    let input = path.resolve(inputPath);
-    let output = outputPath;
+    const input = path.resolve(inputPath);
+    const output = outputPath;
 
-    if (fs.existsSync(output) === true) {
+    if (fs.existsSync(output)) {
       return resolve(output);
     }
 
     const source = fs.createReadStream(input);
     const target = tar.extract(outputBaseDir);
 
-    source.on('error', error => {
-      return reject(error);
-    });
+    source.on('error', error => reject(error));
 
-    target.on('error', error => {
-      return reject(error);
-    });
+    target.on('error', error => reject(error));
 
     target.on('finish', () => {
       fs.chmod(output, '0755', error => {
@@ -44,4 +42,4 @@ module.exports.unpack = function({inputPath, outputBaseDir, outputPath}) {
 
     source.pipe(zlib.createBrotliDecompress()).pipe(target);
   });
-};
+}

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

@@ -0,0 +1,8 @@
+{
+  "extends": "@shelf/tsconfig/backend",
+  "compilerOptions": {
+    "strict": true
+  },
+  "exclude": ["node_modules"],
+  "include": ["src"]
+}