Convert project to typescript (#125)

Author: danielroe

.circleci/config.yml

@@ -30,7 +30,7 @@ jobs:
       # Tests
       - run:
           name: Tests
-          command: yarn jest
+          command: yarn tsc && yarn jest
 
       # Coverage
       - run:

.eslintrc.yml

@@ -1,3 +1,16 @@
-extends: "@nuxtjs"
+extends:
+  - "plugin:@typescript-eslint/recommended"
+  - "@nuxtjs"
 rules:
   no-console: 1
+  "@typescript-eslint/no-var-requires": 0
+plugins:
+  - "@typescript-eslint"
+parserOptions:
+  parser: "@typescript-eslint/parser"
+  tsconfigRootDir: "./src"
+  ecmaFeatures:
+    jsx: false
+  useJSXTextNode: false
+  ecmaVersion: 11
+  sourceType: "module"

.gitignore

@@ -9,3 +9,5 @@ coverage
 dist
 .cache
 .tmp
+lib
+!lib/.yarnclean

examples/.eslintrc.yml

@@ -0,0 +1,2 @@
+rules:
+  "@typescript-eslint/explicit-function-return-type": 0

index.d.ts

@@ -0,0 +1 @@
+declare module 'esm';

lib/config.js

@@ -8,10 +8,11 @@
     "lib"
   ],
   "scripts": {
-    "lint": "eslint --ext .vue,.js lib examples test",
-    "test": "jest test",
+    "lint": "eslint --ext .vue,.js,.ts src examples test",
+    "test": "tsc && jest test",
     "update-fixture": "cd test/fixture && yarn && rm -rf node_modules",
     "update-example": "cd test/example && yarn && rm -rf node_modules",
+    "prepublish": "tsc",
     "release": "standard-version && git push --follow-tags && npm publish"
   },
   "dependencies": {
@@ -26,6 +27,14 @@
   "devDependencies": {
     "@now/build-utils": "^0.10.0",
     "@nuxtjs/eslint-config": "^1.1.2",
+    "@types/execa": "^0.9.0",
+    "@types/fs-extra": "^8.0.0",
+    "@types/glob": "^7.1.1",
+    "@types/node": "^12.7.4",
+    "@types/resolve-from": "^5.0.1",
+    "@types/semver": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^2.2.0",
+    "@typescript-eslint/parser": "^2.2.0",
     "codecov": "^3.5.0",
     "eslint": "^6.3.0",
     "eslint-config-standard": "^14.1.0",
@@ -36,6 +45,7 @@
     "eslint-plugin-standard": "^4.0.1",
     "eslint-plugin-vue": "^5.2.3",
     "jest": "^24.9.0",
-    "standard-version": "^7.0.0"
+    "standard-version": "^7.0.0",
+    "typescript": "^3.6.2"
   }
 }

package.json

@@ -1,15 +1,21 @@
-const path = require('path')
-const resolveFrom = require('resolve-from')
-const fs = require('fs-extra')
-const semver = require('semver')
-const consola = require('consola')
-const esm = require('esm')
+import path from 'path'
+import resolveFrom from 'resolve-from'
+import fs from 'fs-extra'
+import { gte, gt } from 'semver'
+import consola from 'consola'
+import esm from 'esm'
 
-const { createLambda, download, FileFsRef, FileBlob, getNodeVersion, getSpawnOptions } = require('@now/build-utils')
+import { createLambda, download, FileFsRef, FileBlob, glob, getNodeVersion, getSpawnOptions, BuildOptions, Route, Lambda, File, PackageJson } from '@now/build-utils'
 
-const { exec, validateEntrypoint, globAndPrefix, glob, preparePkgForProd, startStep, endStep } = require('./utils')
+import { exec, validateEntrypoint, globAndPrefix, preparePkgForProd, startStep, endStep } from './utils'
 
-async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
+interface BuilderOutput {
+  watch?: string[];
+  output: Record<string, Lambda | File | FileFsRef>;
+  routes: Route[];
+}
+
+export async function build ({ files, entrypoint, workPath, config = {}, meta = {} }: BuildOptions): Promise<BuilderOutput> {
   // ----------------- Prepare build -----------------
   startStep('Prepare build')
 
@@ -30,7 +36,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
   consola.log('Working directory:', process.cwd())
 
   // Read package.json
-  let pkg
+  let pkg: PackageJson
   try {
     pkg = await fs.readJson('package.json')
   } catch (e) {
@@ -40,13 +46,16 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
   // Node version
   const nodeVersion = await getNodeVersion(rootDir)
   const spawnOpts = getSpawnOptions(meta, nodeVersion)
+  if (!spawnOpts.env) {
+    spawnOpts.env = {}
+  }
 
   const usesTypescript = pkg.dependencies && (Object.keys(pkg.dependencies).includes('@nuxt/typescript-build') || Object.keys(pkg.dependencies).includes('@nuxt/typescript'))
   if (usesTypescript) {
-    spawnOpts.env.NODE_PRESERVE_SYMLINKS = 1
+    spawnOpts.env.NODE_PRESERVE_SYMLINKS = '1'
   }
 
-  if (usesTypescript && (await fs.exists('tsconfig.json'))) {
+  if (usesTypescript && (fs.existsSync('tsconfig.json'))) {
     let tsConfig
     try {
       tsConfig = await fs.readJson('tsconfig.json')
@@ -58,7 +67,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
   }
 
   // Detect npm (prefer yarn)
-  const isYarn = !await fs.exists('package-lock.json')
+  const isYarn = !fs.existsSync('package-lock.json')
   consola.log('Using', isYarn ? 'yarn' : 'npm')
 
   // Write .npmrc
@@ -68,7 +77,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
   }
 
   // Write .yarnclean
-  if (isYarn && !await fs.exists('.yarnclean')) {
+  if (isYarn && !fs.existsSync('.yarnclean')) {
     await fs.copyFile(path.join(__dirname, '.yarnclean'), '.yarnclean')
   }
 
@@ -84,7 +93,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
 
   // Prepare node_modules
   await fs.mkdirp('node_modules_dev')
-  if (await fs.exists('node_modules')) {
+  if (fs.existsSync('node_modules')) {
     await fs.unlink('node_modules')
   }
   await fs.symlink('node_modules_dev', 'node_modules')
@@ -123,7 +132,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
   // Execute nuxt build
   spawnOpts.env.NODE_ENV = 'production'
 
-  if (await fs.exists(buildDir)) {
+  if (fs.existsSync(buildDir)) {
     consola.warn(buildDir, 'exists! Please ensure to ignore it with `.nowignore`')
   }
 
@@ -139,7 +148,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
 
   // Use node_modules_prod
   await fs.mkdirp('node_modules_prod')
-  if (await fs.exists('node_modules')) {
+  if (fs.existsSync('node_modules')) {
     await fs.unlink('node_modules')
   }
   await fs.symlink('node_modules_prod', 'node_modules')
@@ -165,10 +174,10 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
 
   // Validate nuxt version
   const nuxtPkg = require(resolveFrom(rootDir, `@nuxt/core${nuxtDep.suffix}/package.json`))
-  if (!semver.gte(nuxtPkg.version, '2.4.0')) {
+  if (!gte(nuxtPkg.version, '2.4.0')) {
     throw new Error(`nuxt >= 2.4.0 is required, detected version ${nuxtPkg.version}`)
   }
-  if (semver.gt(nuxtPkg.version, '3.0.0')) {
+  if (gt(nuxtPkg.version, '3.0.0')) {
     consola.warn('WARNING: nuxt >= 3.0.0 is not tested against this builder!')
   }
 
@@ -196,7 +205,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
   const nodeModules = await globAndPrefix('**', nodeModulesDir, 'node_modules')
 
   // Lambdas
-  const lambdas = {}
+  const lambdas: Record<string, Lambda> = {}
 
   const launcherPath = path.join(__dirname, 'launcher.js')
   const launcherSrc = (await fs.readFile(launcherPath, 'utf8'))
@@ -213,7 +222,7 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
 
   // Extra files to be included in lambda
   const serverFiles = [
-    ...(config.serverFiles || []),
+    ...(Array.isArray(config.serverFiles) ? config.serverFiles : []),
     'package.json'
   ]
 
@@ -249,5 +258,3 @@ async function build ({ files, entrypoint, workPath, config = {}, meta = {} }) {
     ]
   }
 }
-
-module.exports = build

lib/build.js renamed to src/build.ts

@@ -0,0 +1,7 @@
+import { Config } from '@now/build-utils'
+
+const config: Config = {
+  maxLambdaSize: '50mb'
+}
+
+export default config

src/config.ts

@@ -1,6 +1,6 @@
-const build = require('./build')
-const config = require('./config')
-const prepareCache = require('./prepare-cache')
+import { build } from './build'
+import config from './config'
+import prepareCache from './prepare-cache'
 
 // Docs: https://zeit.co/docs/v2/deployments/builders/developer-guide/
 module.exports = {

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

@@ -1,7 +1,10 @@
+import { IncomingMessage, ServerResponse } from 'http'
+import esmCompiler from 'esm'
+
 const startTime = process.hrtime()
 
 // Load Config
-const esm = require('esm')(module, {
+const esm = esmCompiler(module, {
   cjs: {
     dedefault: true
   }
@@ -23,17 +26,17 @@ const readyPromise = nuxt.ready().then(() => {
   const hrTimeMs = ((hrTime[0] * 1e9) + hrTime[1]) / 1e6
   // eslint-disable-next-line no-console
   console.log(`λ Cold start took: ${hrTimeMs}ms`)
-}).catch((error) => {
+}).catch((error: string | Error) => {
   // eslint-disable-next-line no-console
   console.error('λ Error while initializing nuxt:', error)
   process.exit(1)
 })
 
-// Create brdige and start listening
+// Create bridge and start listening
 const { Server } = require('http') // eslint-disable-line import/order
 const { Bridge } = require('./now__bridge.js')
 
-const server = new Server(async (req, res) => {
+const server = new Server(async (req: IncomingMessage, res: ServerResponse): Promise<void> => {
   if (!isReady) {
     await readyPromise
   }
@@ -43,4 +46,4 @@ const bridge = new Bridge(server)
 
 bridge.listen()
 
-exports.launcher = bridge.launcher
+export const launcher = bridge.launcher

lib/launcher.js renamed to src/launcher.ts

@@ -1,9 +1,12 @@
-const path = require('path')
-const fs = require('fs-extra')
-const consola = require('consola')
-const { glob, startStep, endStep } = require('./utils')
+import path from 'path'
+import { PrepareCacheOptions, glob, FileRef } from '@now/build-utils'
 
-async function prepareCache ({ prepareCachePath, workPath, entrypoint }) {
+import fs from 'fs-extra'
+import consola from 'consola'
+import { startStep, endStep } from './utils'
+
+// Amend below line once https://github.com/zeit/now/issues/2992 is resolved
+async function prepareCache ({ prepareCachePath, workPath, entrypoint }: PrepareCacheOptions & { prepareCachePath: string }): Promise<Record<string, FileRef>> {
   const entryDir = path.dirname(entrypoint)
   const rootDir = path.join(workPath, entryDir)
   const cacheDir = path.join(prepareCachePath, entryDir)
@@ -16,11 +19,11 @@ async function prepareCache ({ prepareCachePath, workPath, entrypoint }) {
   endStep()
 
   startStep('Collect cache')
-  const cache = {}
+  const cache: Record<string, FileRef> = {}
   for (const dir of ['.now_cache', 'node_modules_dev', 'node_modules_prod']) {
     const src = path.join(rootDir, dir)
     const dst = path.join(cacheDir, dir)
-    if (!await fs.exists(src)) {
+    if (!fs.existsSync(src)) {
       consola.warn(src, 'not exists. skipping!')
       continue
     }
@@ -34,4 +37,4 @@ async function prepareCache ({ prepareCachePath, workPath, entrypoint }) {
   return cache
 }
 
-module.exports = prepareCache
+export default prepareCache