feat(create): ensure add-on metadata always includes version

Author: tannerlinsley

docs/creating-add-ons.md

@@ -56,6 +56,7 @@ Required fields:
 ```json
 {
   "name": "My Feature",
+  "version": "0.0.1",
   "description": "What it does",
   "type": "add-on",
   "phase": "add-on",
@@ -66,6 +67,7 @@ Required fields:
 
 | Field | Values |
 |-------|--------|
+| `version` | Semantic version for your add-on metadata (e.g. `0.0.1`) |
 | `type` | `add-on`, `toolchain`, `deployment`, `example` |
 | `phase` | `setup`, `add-on`, `example` |
 | `category` | `tanstack`, `auth`, `database`, `orm`, `deploy`, `tooling`, `monitoring`, `api`, `i18n`, `cms`, `other` |

packages/create/src/custom-add-ons/add-on.ts

@@ -122,6 +122,11 @@ export async function readOrGenerateAddOnInfo(
         },
         dependsOn: options.chosenAddOns,
       } as AddOnInfo)
+
+  if (!info.version) {
+    info.version = '0.0.1'
+  }
+
   return info
 }
 

packages/create/src/custom-add-ons/starter.ts

@@ -27,7 +27,7 @@ const COMPILED_FILE = 'starter.json'
 export async function readOrGenerateStarterInfo(
   options: PersistedOptions,
 ): Promise<StarterInfo> {
-  return existsSync(INFO_FILE)
+  const info = existsSync(INFO_FILE)
     ? JSON.parse((await readFile(INFO_FILE)).toString())
     : {
         id: `${options.projectName}-starter`,
@@ -51,6 +51,12 @@ export async function readOrGenerateStarterInfo(
         dependsOn: options.chosenAddOns,
         typescript: true,
       }
+
+  if (!info.version) {
+    info.version = '0.0.1'
+  }
+
+  return info
 }
 
 async function loadCurrentStarterInfo(environment: Environment) {

packages/create/src/frameworks.ts

@@ -111,6 +111,7 @@ export function scanAddOnDirectories(addOnsDirectories: Array<string>) {
       addOns.push({
         ...info,
         id: dir,
+        version: info.version ?? '0.0.0',
         packageAdditions,
         packageTemplate,
         readme,

packages/create/tests/custom-add-ons/starter.test.ts

@@ -55,4 +55,33 @@ describe('readOrGenerateStarterInfo', () => {
     })
     expect(starterInfo.name).toEqual('test-starter')
   })
+
+  it('should backfill version when missing', async () => {
+    fs.mkdirSync(process.cwd(), { recursive: true })
+    fs.writeFileSync(
+      'starter-info.json',
+      JSON.stringify({
+        framework: 'test',
+        chosenAddOns: [],
+        starter: undefined,
+        name: 'test-starter',
+        mode: 'code-router',
+        typescript: true,
+        tailwind: true,
+        git: true,
+      }),
+    )
+    const starterInfo = await readOrGenerateStarterInfo({
+      framework: 'test',
+      version: 1,
+      chosenAddOns: [],
+      starter: undefined,
+      projectName: 'test',
+      mode: 'code-router',
+      typescript: true,
+      tailwind: true,
+      git: true,
+    })
+    expect(starterInfo.version).toEqual('0.0.1')
+  })
 })