feat: switch to TypeScript

Author: vladholubiev

.eslintrc

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

.gitignore

@@ -5,3 +5,4 @@ temp
 yarn.lock
 *.log
 .DS_Store
+lib/

babel.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  plugins: ['@babel/plugin-proposal-object-rest-spread'],
+  presets: [
+    '@babel/preset-typescript',
+    [
+      '@babel/preset-env',
+      {
+        targets: {
+          node: '8.10'
+        }
+      }
+    ]
+  ]
+};

package.json

@@ -13,25 +13,38 @@
     "node": ">=8.10"
   },
   "scripts": {
+    "build": "rm -rf lib/ && yarn build:types && babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts' --copy-files",
+    "build:types": "tsc --emitDeclarationOnly --declaration --isolatedModules false --declarationDir lib",
+    "coverage": "jest --coverage",
     "lint": "eslint . --fix",
-    "test": "echo ok"
+    "prepack": "yarn build",
+    "test": "echo ok",
+    "type-check": "tsc --noEmit",
+    "type-check:watch": "npm run type-check -- --watch"
   },
   "files": [
-    "src",
+    "lib",
     "bin"
   ],
   "main": "src/index.js",
   "keywords": [],
   "dependencies": {
     "@shelf/aws-lambda-brotli-unpacker": "0.0.2",
-    "del": "^4.0.0"
+    "del": "4.1.1"
   },
   "devDependencies": {
+    "@babel/cli": "7.4.4",
+    "@babel/core": "7.4.5",
+    "@babel/preset-env": "7.4.5",
+    "@babel/preset-typescript": "7.3.3",
     "@shelf/eslint-config": "0.3.5",
+    "@types/jest": "24.0.13",
+    "@types/node": "8",
     "eslint": "5.16.0",
     "husky": "2.4.0",
     "lint-staged": "8.2.0",
-    "prettier": "1.18.2"
+    "prettier": "1.18.2",
+    "typescript": "3.5.1"
   },
   "husky": {
     "hooks": {

readme.md

@@ -46,7 +46,7 @@ execSync(`${loBinary} ${defaultArgs.join(' ')} --convert-to pdf file.docx --outd
 
 ### Test
 
-Smoke test that it works: `docker run --rm -v "$PWD":/var/task lambci/lambda:nodejs8.10 src/test.handler`
+Smoke test that it works: `yarn build && docker run --rm -v "$PWD":/var/task lambci/lambda:nodejs8.10 lambda.test.handler`
 
 ## License
 

src/cleanup.js renamed to src/cleanup.ts

@@ -1,7 +1,7 @@
-const fs = require('fs');
-const del = require('del');
+import fs from 'fs';
+import del from 'del';
 
-module.exports.cleanupTempFiles = function() {
+export function cleanupTempFiles() {
   for (let file of fs.readdirSync(`/tmp`)) {
     if (file.endsWith('.tmp') === true || file.startsWith('OSL_PIPE')) {
       try {
@@ -10,4 +10,4 @@ module.exports.cleanupTempFiles = function() {
       } catch (error) {}
     }
   }
-};
+}

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

@@ -1,28 +1,21 @@
-const {unpack} = require('@shelf/aws-lambda-brotli-unpacker');
-const {execSync} = require('child_process');
-const path = require('path');
-const defaultArgs = require('./args');
-const {cleanupTempFiles} = require('./cleanup');
+import {unpack} from '@shelf/aws-lambda-brotli-unpacker';
+import {execSync} from 'child_process';
+import path from 'path';
+import {cleanupTempFiles} from './cleanup';
+import defaultArgsJSON from './args.json';
 
-module.exports.defaultArgs = defaultArgs;
+export const defaultArgs = defaultArgsJSON;
 
 const inputPath = path.join(__dirname, '..', 'bin', 'lo.tar.br');
 const outputPath = '/tmp/instdir/program/soffice';
 
-// see https://github.com/alixaxel/chrome-aws-lambda
-module.exports.getExecutablePath = async function() {
-  cleanupTempFiles();
-
-  return unpack({inputPath, outputPath});
-};
-
 /**
  * Converts a file in /tmp to PDF
  * @param {String} filePath Absolute path to file to convert located in /tmp directory
  * @return {Promise<String>} Logs from spawning LibreOffice process
  */
-module.exports.convertFileToPDF = async function(filePath) {
-  const binary = await module.exports.getExecutablePath();
+export async function convertFileToPDF(filePath): Promise<string> {
+  const binary = await getExecutablePath();
 
   const logs = execSync(
     `cd /tmp && ${binary} ${defaultArgs.join(' ')} --convert-to pdf --outdir /tmp ${filePath}`
@@ -31,4 +24,11 @@ module.exports.convertFileToPDF = async function(filePath) {
   execSync(`rm /tmp/${filePath}`);
 
   return logs.toString('utf8');
-};
+}
+
+// see https://github.com/alixaxel/chrome-aws-lambda
+export async function getExecutablePath(): Promise<string> {
+  cleanupTempFiles();
+
+  return unpack({inputPath, outputPath});
+}

src/test.js renamed to test.js

@@ -1,5 +1,6 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 const {writeFileSync} = require('fs');
-const {convertFileToPDF} = require('./');
+const {convertFileToPDF} = require('./lib');
 
 module.exports.handler = async () => {
   writeFileSync('/tmp/test.txt', Buffer.from('Hello World!'));

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "module": "commonjs",
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": false,
+    "target": "esnext"
+  },
+  "exclude": ["node_modules", "lambda.test.js"],
+  "include": ["src"]
+}