@platformatic/generators 1.26.0 → 1.28.0

package/index.test-d.ts

@@ -0,0 +1,16 @@
+import { expectAssignable } from 'tsd'
+import { BaseGenerator } from './lib/base-generator';
+
+expectAssignable<BaseGenerator.ConfigFieldDefinition>({
+  label: 'PLT_TESTING',
+  var: 'testing',
+  default: 'hello world',
+  type: 'string',
+  configValue: 'someConfigValue'
+})
+
+expectAssignable<BaseGenerator.ConfigField>({
+  var: 'testing',
+  configValue: 'someConfigValue',
+  value: 'asd123'
+})

package/lib/base-generator.d.ts

@@ -61,13 +61,13 @@ export namespace BaseGenerator {
     var: string
     default: string
     type: 'number' | 'string' | 'boolean' | 'path'
-    configValue?: 'string'
+    configValue?: string
   }
 
   type ConfigField = {
     var: string
-    configValue?: 'string'
-    value: 'string'
+    configValue?: string
+    value: string
   }
 
   type AddEnvVarOptions = {

package/lib/base-generator.js

@@ -364,12 +364,14 @@ class BaseGenerator extends FileGenerator {
 
   async generatePackageJson () {
     const template = {
+      name: `${this.config.serviceName}`,
       scripts: {
         start: 'platformatic start',
-        test: 'node --test test/**'
+        test: 'borp'
       },
       devDependencies: {
         fastify: `^${this.fastifyVersion}`,
+        borp: `${this.pkgData.devDependencies.borp}`,
         ...this.config.devDependencies
       },
       dependencies: {

package/lib/create-stackable-files.js

@@ -9,16 +9,17 @@ function getJsStackableIndexFile (stackableName) {
 const { platformaticService } = require('@platformatic/service')
 const { schema } = require('./lib/schema')
 const { Generator } = require('./lib/generator')
+const { version } = require('./package.json')
 
 async function stackable (fastify, opts) {
   await fastify.register(platformaticService, opts)
   await fastify.register(require('./plugins/example'), opts)
 }
-
 stackable.configType = '${kebabCase(stackableName + '-app')}'
 stackable.schema = schema
 stackable.Generator = Generator
 stackable.configManagerConfig = {
+  version,
   schema,
   envWhitelist: ['PORT', 'HOSTNAME'],
   allowToWatch: ['.env'],
@@ -48,6 +49,9 @@ import { platformaticService, Stackable } from '@platformatic/service'
 import { schema } from './lib/schema'
 import { Generator } from './lib/generator'
 import { ${stackableConfigType} } from './config'
+import { readFileSync } from 'node:fs'
+
+const { version } = JSON.parse(readFileSync('package.json', 'utf8'))
 
 const stackable: Stackable<${stackableConfigType}> = async function (fastify, opts) {
   await fastify.register(platformaticService, opts)
@@ -58,6 +62,7 @@ stackable.configType = '${kebabCase(stackableName + '-app')}'
 stackable.schema = schema
 stackable.Generator = Generator
 stackable.configManagerConfig = {
+  version,
   schema,
   envWhitelist: ['PORT', 'HOSTNAME'],
   allowToWatch: ['.env'],
@@ -179,7 +184,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
     const packageJson = await this.getStackablePackageJson()
     const config = {
       $schema: './stackable.schema.json',
-      module: packageJson.name,
+      module: \`\${packageJson.name}@\${packageJson.version}\`,
       greeting: {
         text: \`{\${this.getEnvVarName('PLT_GREETING_TEXT')}}\`
       }
@@ -287,7 +292,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
     const packageJson = await this.getStackablePackageJson()
     const config = {
       $schema: './stackable.schema.json',
-      module: packageJson.name,
+      module: \`\${packageJson.name}@\${packageJson.version}\`,
       greeting: {
         text: \`{\${this.getEnvVarName('PLT_GREETING_TEXT')}}\`
       }
@@ -359,11 +364,13 @@ function getJsStackableSchemaFile (stackableName) {
 'use strict'
 
 const { schema } = require('@platformatic/service')
+const { version } = require('../package.json')
 
 const ${schemaVarName} = {
   ...schema.schema,
   $id: '${schemaId}',
   title: '${schemaTitle}',
+  version,
   properties: {
     ...schema.schema.properties,
     module: { type: 'string' },
@@ -400,6 +407,7 @@ const ${schemaVarName} = {
   ...schema.schema,
   $id: '${schemaId}',
   title: '${schemaTitle}',
+  version,
   properties: {
     ...schema.schema.properties,
     module: { type: 'string' },

package/lib/stackable-generator.js

@@ -230,7 +230,9 @@ class StackableGenerator extends FileGenerator {
         },
         scripts: {
           build: 'tsc --build',
-          'build:config': 'node ./dist/lib/schema.js | json2ts > config.d.ts',
+          'gen-schema': 'node lib/schema.js > schema.json',
+          'gen-types': 'json2ts > config.d.ts < schema.json',
+          'build:config': 'pnpm run gen-schema && pnpm run gen-types',
           clean: 'rm -fr ./dist'
         },
         engines: {
@@ -261,7 +263,10 @@ class StackableGenerator extends FileGenerator {
         [startStackableCommand]: './cli/start.js'
       },
       scripts: {
-        'build:config': 'node lib/schema.js | json2ts > config.d.ts',
+        'gen-schema': 'node lib/schema.js > schema.json',
+        'gen-types': 'json2ts > config.d.ts < schema.json',
+        'build:config': 'pnpm run gen-schema && pnpm run gen-types',
+        prepublishOnly: 'pnpm run build:config',
         lint: 'standard'
       },
       engines: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "1.26.0",
+  "version": "1.28.0",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -10,20 +10,21 @@
     "@fastify/error": "^3.4.1",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
-    "fastify": "^4.26.0",
-    "pino": "^8.17.2",
-    "undici": "^6.6.0"
+    "fastify": "^4.26.2",
+    "pino": "^8.19.0",
+    "undici": "^6.9.0"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",
-    "borp": "^0.9.0",
+    "borp": "^0.10.0",
     "c8": "^9.1.0",
     "snazzy": "^9.0.0",
     "standard": "^17.1.0",
-    "typescript": "^5.3.3"
+    "tsd": "^0.30.7",
+    "typescript": "^5.4.2"
   },
   "scripts": {
     "lint": "standard | snazzy",
-    "test": "pnpm run lint && borp -C -X fixtures -X test --concurrency=1"
+    "test": "pnpm run lint && borp -C -X fixtures -X test --concurrency=1 && tsd"
   }
 }

package/test/base-generator.test.js

@@ -30,7 +30,8 @@ test('should write file and dirs', async (t) => {
   })
 
   gen.setConfig({
-    targetDirectory: dir
+    targetDirectory: dir,
+    serviceName: 'test-service'
   })
 
   await gen.run()
@@ -40,6 +41,8 @@ test('should write file and dirs', async (t) => {
   assert.ok(packageJson.dependencies)
   assert.ok(packageJson.engines)
 
+  assert.equal(packageJson.name, 'test-service')
+
   const configFile = JSON.parse(await readFile(join(dir, 'platformatic.json'), 'utf8'))
   assert.deepEqual(configFile, {})