feat: add package.json file generation on init (#61)

* feat: add package.json file on init

* format

* refactor

* format

* refactor the file generation

* format

cli/init/register.ts

@@ -1,10 +1,12 @@
 import type { Command } from "commander"
+import { execSync } from "node:child_process"
 import * as fs from "node:fs"
 import * as path from "node:path"
 import { setupTsciProject } from "lib/shared/setup-tsci-packages"
 import { generateTsConfig } from "lib/shared/generate-ts-config"
 import { writeFileIfNotExists } from "lib/shared/write-file-if-not-exists"
 import { generateGitIgnoreFile } from "lib/shared/generate-gitignore-file"
+import { generatePackageJson } from "lib/shared/generate-package-json"
 
 export const registerInit = (program: Command) => {
   program
@@ -47,18 +49,14 @@ export default () => (
 `,
       )
 
-      // Setup project dependencies
-      try {
-        setupTsciProject(projectDir)
-      } catch (error) {
-        console.error("Failed to install dependencies:", error)
-        process.exit(1)
-      }
-
+      // Generate package.json
+      generatePackageJson(projectDir)
       // Generate tsconfig.json
       generateTsConfig(projectDir)
       // Create .gitignore file
       generateGitIgnoreFile(projectDir)
+      // Setup project dependencies
+      setupTsciProject(projectDir)
 
       console.info(
         `🎉 Initialization complete! Run ${directory ? `"cd ${directory}" & ` : ""}"tsci dev" to start developing.`,

lib/shared/generate-package-json.ts

@@ -0,0 +1,22 @@
+import * as path from "node:path"
+import { writeFileIfNotExists } from "./write-file-if-not-exists"
+
+export const generatePackageJson = (dir: string) => {
+  const packageJsonPath = path.join(dir, "package.json")
+  const packageJsonContent = {
+    name: path.basename(dir),
+    version: "1.0.0",
+    description: "A TSCircuit project",
+    main: "index.tsx",
+    keywords: ["tscircuit", "electronics"],
+    scripts: {
+      dev: "tsci dev",
+      build: "tsci build",
+    },
+  }
+
+  writeFileIfNotExists(
+    packageJsonPath,
+    JSON.stringify(packageJsonContent, null, 2),
+  )
+}

lib/shared/setup-tsci-packages.ts

@@ -34,11 +34,6 @@ export function setupTsciProject(
   const packageJsonPath = path.join(projectPath, "package.json")
   const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"))
 
-  // Remove unwanted fields
-  delete packageJson.keywords
-  delete packageJson.author
-  delete packageJson.main
-
   fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
   console.log("Updated package.json to remove unnecessary fields.")
 

tests/cli/init/init.test.ts

@@ -1,7 +1,7 @@
-import { getCliTestFixture } from "../../fixtures/get-cli-test-fixture"
-import { test, expect } from "bun:test"
-import { join } from "node:path"
+import { expect, test } from "bun:test"
 import { execSync } from "node:child_process"
+import { join } from "node:path"
+import { getCliTestFixture } from "../../fixtures/get-cli-test-fixture"
 
 test("init command installs @types/react and passes type-checking", async () => {
   const { tmpDir, runCommand } = await getCliTestFixture()
@@ -10,9 +10,37 @@ test("init command installs @types/react and passes type-checking", async () =>
   console.log(stdout)
 
   const pkgJsonPath = join(tmpDir, "package.json")
-  const pkgJson = JSON.parse(await Bun.file(pkgJsonPath).text())
-  expect(pkgJson.devDependencies["@types/react"]).toBeDefined()
-  expect(pkgJson.devDependencies["@tscircuit/core"]).toBeDefined()
+  const pkgJson = await Bun.file(pkgJsonPath).json()
+
+  expect(pkgJson).toMatchInlineSnapshot(
+    {
+      name: expect.any(String),
+      devDependencies: {
+        "@tscircuit/core": expect.any(String),
+        "@types/react": expect.any(String),
+      },
+    },
+    `
+    {
+      "description": "A TSCircuit project",
+      "devDependencies": {
+        "@tscircuit/core": Any<String>,
+        "@types/react": Any<String>,
+      },
+      "keywords": [
+        "tscircuit",
+        "electronics",
+      ],
+      "main": "index.tsx",
+      "name": Any<String>,
+      "scripts": {
+        "build": "tsci build",
+        "dev": "tsci dev",
+      },
+      "version": "1.0.0",
+    }
+  `,
+  )
 
   const npmrcPath = join(tmpDir, ".npmrc")
   const npmrcContent = await Bun.file(npmrcPath).text()