[planner] Add typescript support to nodejs build (#153)

## Summary
Add typescript support to nodejs build. I don't think we need a separate
typescript planner, as most typescript projects need nodejs and
`package.json` to function properly.

## How was it tested?
`go test ./...`

Author: LucilleH

planner/languages/javascript/nodejs_planner.go

@@ -44,7 +44,7 @@ func (p *Planner) GetPlan(srcDir string) *plansdk.Plan {
 		BuildStage: &plansdk.Stage{
 			// Copy the rest of the directory over, since at install stage we only copied package.json and its lock file.
 			InputFiles: []string{"."},
-			Command:    p.buildCommand(pkgManager, project),
+			Command:    p.buildCommand(srcDir, pkgManager, project),
 		},
 
 		StartStage: &plansdk.Stage{
@@ -64,22 +64,25 @@ type nodeProject struct {
 	} `json:"engines,omitempty"`
 }
 
+var versionMap = map[string]string{
+	// Map node versions to the corresponding nixpkgs:
+	"10": "nodejs-10_x",
+	"12": "nodejs-12_x",
+	"16": "nodejs-16_x",
+	"18": "nodejs-18_x",
+}
+var defaultNodeJSPkg = "nodejs"
+
 func (p *Planner) nodePackage(project *nodeProject) string {
 	v := p.nodeVersion(project)
 	if v != nil {
-		switch v.Major() {
-		case "10":
-			return "nodejs-10_x"
-		case "12":
-			return "nodejs-12_x"
-		case "16":
-			return "nodejs-16_x"
-		case "18":
-			return "nodejs-18_x"
+		pkg, ok := versionMap[v.Major()]
+		if ok {
+			return pkg
 		}
 	}
 
-	return "nodejs"
+	return defaultNodeJSPkg
 }
 
 func (p *Planner) nodeVersion(project *nodeProject) *plansdk.Version {
@@ -128,20 +131,29 @@ func (p *Planner) inputFiles(srcDir string) []string {
 	return inputFiles
 }
 
-func (p *Planner) buildCommand(pkgManager string, project *nodeProject) string {
-	buildScript := project.Scripts.Build
-	defaultBuildCmd := "npm run build"
-	postBuildCmdHook := "npm prune --production"
+var buildCmdMap = map[string]string{
+	// Map package manager to build command:
+	"npm":  "npm run build",
+	"yarn": "yarn build",
+}
+var postBuildCmdHookMap = map[string]string{
+	// Map package manager to post build hook command:
+	"npm":  "npm prune --production",
+	"yarn": "yarn install --production --ignore-scripts --prefer-offline",
+}
 
-	if pkgManager == "yarn" {
-		defaultBuildCmd = "yarn build"
-		postBuildCmdHook = "yarn install --production --ignore-scripts --prefer-offline"
-	}
-	if buildScript == "" {
-		return postBuildCmdHook
+func (p *Planner) buildCommand(srcDir string, pkgManager string, project *nodeProject) string {
+	buildScript := project.Scripts.Build
+	if buildScript != "" {
+		return fmt.Sprintf("%s && %s", buildCmdMap[pkgManager], postBuildCmdHookMap[pkgManager])
+	} else {
+		if p.hasTypescriptConfig(srcDir) {
+			return fmt.Sprintf("%s && %s", "npx tsc", postBuildCmdHookMap[pkgManager])
+		} else {
+			// Still runs the post build command hook to clean up dev packages.
+			return postBuildCmdHookMap[pkgManager]
+		}
 	}
-
-	return fmt.Sprintf("%s && %s", defaultBuildCmd, postBuildCmdHook)
 }
 
 func (p *Planner) startCommand(pkgManager string, project *nodeProject) string {
@@ -162,3 +174,8 @@ func (p *Planner) nodeProject(srcDir string) *nodeProject {
 
 	return project
 }
+
+func (p *Planner) hasTypescriptConfig(srcDir string) bool {
+	tsPath := filepath.Join(srcDir, "tsconfig.json")
+	return plansdk.FileExists(tsPath)
+}

planner/languages/typescript/typescript_planner.go

@@ -32,7 +32,6 @@ import (
 	"go.jetpack.io/devbox/planner/languages/rust"
 	"go.jetpack.io/devbox/planner/languages/scala"
 	"go.jetpack.io/devbox/planner/languages/swift"
-	"go.jetpack.io/devbox/planner/languages/typescript"
 	"go.jetpack.io/devbox/planner/languages/zig"
 	"go.jetpack.io/devbox/planner/plansdk"
 )
@@ -65,7 +64,6 @@ var PLANNERS = []plansdk.Planner{
 	&rust.Planner{},
 	&scala.Planner{},
 	&swift.Planner{},
-	&typescript.Planner{},
 	&zig.Planner{},
 }
 

planner/planner.go

@@ -0,0 +1,3 @@
+{
+  "packages": []
+}

testdata/nodejs/nodejs-typescript/devbox.json

@@ -0,0 +1,4 @@
+const NODE_MAJOR_VERSION = process.versions.node.split('.')[0];
+if (NODE_MAJOR_VERSION !== "18") {
+  throw new Error('Node version is not 18');
+}

testdata/nodejs/nodejs-typescript/index.ts

@@ -0,0 +1,11 @@
+{
+  "name": "nodejs-18",
+  "main": "index.js",
+  "devDependencies": {
+    "@types/node": "^18.7.18",
+    "typescript": "^4.6.4"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

testdata/nodejs/nodejs-typescript/package-lock.json

@@ -0,0 +1,27 @@
+{
+  "install_stage": {
+    "command": "npm install",
+    "input_files": [
+      "package.json",
+      "package-lock.json"
+    ]
+  },
+  "build_stage": {
+    "command": "npx tsc && npm prune --production",
+    "input_files": [
+      "."
+    ]
+  },
+  "start_stage": {
+    "command": "node index.js",
+    "input_files": [
+      "."
+    ]
+  },
+  "dev_packages": [
+    "nodejs-18_x"
+  ],
+  "runtime_packages": [
+    "nodejs-18_x"
+  ]
+}

testdata/nodejs/nodejs-typescript/package.json

@@ -0,0 +1,17 @@
+{
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": [],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    /* Completeness */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}