@platformatic/generators 1.27.0 → 1.28.1

package/lib/base-generator.js

@@ -367,10 +367,11 @@ class BaseGenerator extends FileGenerator {
       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-cli.js

@@ -45,7 +45,7 @@ async function execute () {
       },
       port: { type: 'string', default: '3042' },
       hostname: { type: 'string', default: '0.0.0.0' },
-      plugins: { type: 'boolean', default: true },
+      plugin: { type: 'boolean', default: true },
       tests: { type: 'boolean', default: true },
       typescript: { type: 'boolean', default: false },
       git: { type: 'boolean', default: false },
@@ -58,7 +58,7 @@ async function execute () {
   generator.setConfig({
     port: parseInt(args.values.port),
     hostname: args.values.hostname,
-    plugins: args.values.plugins,
+    plugin: args.values.plugin,
     tests: args.values.tests,
     typescript: args.values.typescript,
     initGitRepository: args.values.git,
@@ -81,7 +81,7 @@ import { join } from 'node:path'
 import { parseArgs } from 'node:util'
 import { Generator } from '../lib/generator'
 
-async function execute () {
+async function execute (): Promise<void> {
   const args = parseArgs({
     args: process.argv.slice(2),
     options: {
@@ -91,7 +91,7 @@ async function execute () {
       },
       port: { type: 'string', default: '3042' },
       hostname: { type: 'string', default: '0.0.0.0' },
-      plugins: { type: 'boolean', default: true },
+      plugin: { type: 'boolean', default: true },
       tests: { type: 'boolean', default: true },
       typescript: { type: 'boolean', default: false },
       git: { type: 'boolean', default: false },
@@ -104,7 +104,7 @@ async function execute () {
   generator.setConfig({
     port: parseInt(args.values.port as string),
     hostname: args.values.hostname,
-    plugins: args.values.plugins,
+    plugin: args.values.plugin,
     tests: args.values.tests,
     typescript: args.values.typescript,
     initGitRepository: args.values.git,
@@ -116,7 +116,9 @@ async function execute () {
   console.log('Application created successfully! Run \`npm run start\` to start an application.')
 }
 
-execute()
+execute().catch(err => {
+  throw err
+})
 `
 }
 

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')}}\`
       }
@@ -295,8 +300,8 @@ class ${stackableGeneratorType} extends ServiceGenerator {
     return Object.assign({}, baseConfig, config)
   }
 
-  async _beforePrepare () {
-    super._beforePrepare()
+  async _beforePrepare (): Promise<void> {
+    await super._beforePrepare()
 
     this.addEnvVars({
       PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!'
@@ -309,7 +314,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
     }
   }
 
-  async _afterPrepare () {
+  async _afterPrepare (): Promise<void> {
     const packageJson = await this.getStackablePackageJson()
     this.addFile({
       path: '',
@@ -328,18 +333,18 @@ class ${stackableGeneratorType} extends ServiceGenerator {
     if (!this._packageJson) {
       const packageJsonPath = join(__dirname, '..', '..', 'package.json')
       const packageJsonFile = await readFile(packageJsonPath, 'utf8')
-      const packageJson = JSON.parse(packageJsonFile)
+      const packageJson: Partial<PackageJson> = JSON.parse(packageJsonFile)
 
-      if (!packageJson.name) {
+      if (packageJson.name === undefined || packageJson.name === null) {
         throw new Error('Missing package name in package.json')
       }
 
-      if (!packageJson.version) {
+      if (packageJson.version === undefined || packageJson.version === null) {
         throw new Error('Missing package version in package.json')
       }
 
-      this._packageJson = packageJson
-      return packageJson
+      this._packageJson = packageJson as PackageJson
+      return packageJson as PackageJson
     }
     return this._packageJson
   }
@@ -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/create-stackable-plugin.js

@@ -16,6 +16,7 @@ module.exports = async function (fastify, opts) {
 
 function getTsStackablePluginFile () {
   return `\
+// eslint-disable-next-line
 /// <reference path="../index.d.ts" />
 import { FastifyInstance, FastifyPluginOptions } from 'fastify'
 

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.27.0",
+  "version": "1.28.1",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -10,9 +10,9 @@
     "@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",
@@ -20,8 +20,8 @@
     "c8": "^9.1.0",
     "snazzy": "^9.0.0",
     "standard": "^17.1.0",
-    "tsd": "^0.30.4",
-    "typescript": "^5.3.3"
+    "tsd": "^0.30.7",
+    "typescript": "^5.4.2"
   },
   "scripts": {
     "lint": "standard | snazzy",