@platformatic/generators 1.20.2 → 1.21.0

package/lib/create-stackable-files.js

@@ -35,6 +35,8 @@ stackable.configManagerConfig = {
 stackable[Symbol.for('skip-override')] = true
 
 module.exports = stackable
+module.exports.schema = schema
+module.exports.Generator = Generator
 `
 }
 
@@ -73,6 +75,7 @@ stackable.configManagerConfig = {
 stackable[Symbol.for('skip-override')] = true
 
 export default stackable
+export { Generator, schema }
 `
 }
 
@@ -89,6 +92,51 @@ declare module 'fastify' {
     platformatic: PlatformaticApp<${stackableConfigType}>
   }
 }
+
+export { PlatformaticApp, ${stackableConfigType} }
+`
+}
+
+function getJsGlobalTypesTemplateFile (stackableName) {
+  const stackableConfigType = pascalCase(stackableName + 'Config')
+
+  return `\
+'use strict'
+
+function generateGlobalTypesFile (npmPackageName) {
+  return \`\
+import { FastifyInstance } from 'fastify'
+import { ${stackableConfigType}, PlatformaticApp } from '\${npmPackageName}'
+  
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApp<${stackableConfigType}>
+  }
+}
+\`
+}
+
+module.exports = {
+  generateGlobalTypesFile
+}
+`
+}
+
+function getTsGlobalTypesTemplateFile (stackableName) {
+  const stackableConfigType = pascalCase(stackableName + 'Config')
+
+  return `\
+export function generateGlobalTypesFile (npmPackageName: string): string {
+  return \`import { FastifyInstance } from 'fastify'
+import { ${stackableConfigType}, PlatformaticApp } from '\${npmPackageName}'
+  
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApp<${stackableConfigType}>
+  }
+}
+\`
+}
 `
 }
 
@@ -98,8 +146,11 @@ function getJsStackableGeneratorFile (stackableName) {
   return `\
 'use strict'
 
+const { join } = require('node:path')
+const { readFile } = require('node:fs/promises')
 const { Generator: ServiceGenerator } = require('@platformatic/service')
 const { schema } = require('./schema')
+const { generateGlobalTypesFile } = require('./templates/types')
 
 class ${stackableGeneratorType} extends ServiceGenerator {
   getDefaultConfig () {
@@ -110,10 +161,25 @@ class ${stackableGeneratorType} extends ServiceGenerator {
     return Object.assign({}, defaultBaseConfig, defaultConfig)
   }
 
+  getConfigFieldsDefinitions () {
+    const serviceConfigFieldsDefs = super.getConfigFieldsDefinitions()
+    return [
+      ...serviceConfigFieldsDefs,
+      {
+        var: 'PLT_GREETING_TEXT',
+        label: 'What should the stackable greeting say?',
+        default: 'Hello world!',
+        type: 'string'
+      }
+    ]
+  }
+
   async _getConfigFileContents () {
     const baseConfig = await super._getConfigFileContents()
+    const packageJson = await this.getStackablePackageJson()
     const config = {
       $schema: './stackable.schema.json',
+      module: packageJson.name,
       greeting: {
         text: '{PLT_GREETING_TEXT}'
       }
@@ -128,15 +194,48 @@ class ${stackableGeneratorType} extends ServiceGenerator {
       PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!',
       ...this.config.env
     }
+
+    const packageJson = await this.getStackablePackageJson()
+
+    this.config.dependencies = {
+      [packageJson.name]: \`^\${packageJson.version}\`
+    }
   }
 
   async _afterPrepare () {
+    const packageJson = await this.getStackablePackageJson()
+    this.addFile({
+      path: '',
+      file: 'global.d.ts',
+      contents: generateGlobalTypesFile(packageJson.name)
+    })
+
     this.addFile({
       path: '',
       file: 'stackable.schema.json',
       contents: JSON.stringify(schema, null, 2)
     })
   }
+
+  async getStackablePackageJson () {
+    if (this._packageJson === null) {
+      const packageJsonPath = join(__dirname, '..', 'package.json')
+      const packageJsonFile = await readFile(packageJsonPath, 'utf8')
+      const packageJson = JSON.parse(packageJsonFile)
+
+      if (!packageJson.name) {
+        throw new Error('Missing package name in package.json')
+      }
+  
+      if (!packageJson.version) {
+        throw new Error('Missing package version in package.json')
+      }
+
+      this._packageJson = packageJson
+      return packageJson
+    }
+    return this._packageJson
+  }
 }
 
 module.exports = ${stackableGeneratorType}
@@ -148,11 +247,21 @@ function getTsStackableGeneratorFile (stackableName) {
   const stackableGeneratorType = pascalCase(stackableName + 'Generator')
 
   return `\
+import { join } from 'node:path'
+import { readFile } from 'node:fs/promises'
 import { Generator as ServiceGenerator } from '@platformatic/service'
 import { BaseGenerator } from '@platformatic/generators'
 import { schema } from './schema'
+import { generateGlobalTypesFile } from './templates/types'
+
+type PackageJson = {
+  name: string
+  version: string
+}
 
 class ${stackableGeneratorType} extends ServiceGenerator {
+  private _packageJson: PackageJson | null = null
+
   getDefaultConfig (): BaseGenerator.JSONValue {
     const defaultBaseConfig = super.getDefaultConfig()
     const defaultConfig = {
@@ -161,10 +270,25 @@ class ${stackableGeneratorType} extends ServiceGenerator {
     return Object.assign({}, defaultBaseConfig, defaultConfig)
   }
 
+  getConfigFieldsDefinitions (): BaseGenerator.ConfigFieldDefinition[] {
+    const serviceConfigFieldsDefs = super.getConfigFieldsDefinitions()
+    return [
+      ...serviceConfigFieldsDefs,
+      {
+        var: 'PLT_GREETING_TEXT',
+        label: 'What should the stackable greeting say?',
+        default: 'Hello world!',
+        type: 'string'
+      }
+    ]
+  }
+
   async _getConfigFileContents (): Promise<BaseGenerator.JSONValue> {
     const baseConfig = await super._getConfigFileContents()
+    const packageJson = await this.getStackablePackageJson()
     const config = {
       $schema: './stackable.schema.json',
+      module: packageJson.name,
       greeting: {
         text: '{PLT_GREETING_TEXT}'
       }
@@ -179,15 +303,48 @@ class ${stackableGeneratorType} extends ServiceGenerator {
       PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!',
       ...this.config.env
     }
+
+    const packageJson = await this.getStackablePackageJson()
+
+    this.config.dependencies = {
+      [packageJson.name]: \`^\${packageJson.version}\`
+    }
   }
 
   async _afterPrepare () {
+    const packageJson = await this.getStackablePackageJson()
+    this.addFile({
+      path: '',
+      file: 'global.d.ts',
+      contents: generateGlobalTypesFile(packageJson.name)
+    })
+
     this.addFile({
       path: '',
       file: 'stackable.schema.json',
       contents: JSON.stringify(schema, null, 2)
     })
   }
+
+  async getStackablePackageJson (): Promise<PackageJson> {
+    if (this._packageJson === null) {
+      const packageJsonPath = join(__dirname, '..', '..', 'package.json')
+      const packageJsonFile = await readFile(packageJsonPath, 'utf8')
+      const packageJson = JSON.parse(packageJsonFile)
+
+      if (!packageJson.name) {
+        throw new Error('Missing package name in package.json')
+      }
+  
+      if (!packageJson.version) {
+        throw new Error('Missing package version in package.json')
+      }
+
+      this._packageJson = packageJson
+      return packageJson
+    }
+    return this._packageJson
+  }
 }
 
 export default ${stackableGeneratorType}
@@ -211,6 +368,7 @@ const ${schemaVarName} = {
   title: '${schemaTitle}',
   properties: {
     ...schema.schema.properties,
+    module: { type: 'string' },
     greeting: {
       type: 'object',
       properties: {
@@ -246,6 +404,7 @@ const ${schemaVarName} = {
   title: '${schemaTitle}',
   properties: {
     ...schema.schema.properties,
+    module: { type: 'string' },
     greeting: {
       type: 'object',
       properties: {
@@ -303,6 +462,11 @@ function generateStackableFiles (typescript, stackableName) {
         file: 'generator.ts',
         contents: getTsStackableGeneratorFile(stackableName)
       },
+      {
+        path: 'lib/templates',
+        file: 'types.ts',
+        contents: getTsGlobalTypesTemplateFile(stackableName)
+      },
       {
         path: 'lib',
         file: 'schema.ts',
@@ -331,6 +495,11 @@ function generateStackableFiles (typescript, stackableName) {
       file: 'generator.js',
       contents: getJsStackableGeneratorFile(stackableName)
     },
+    {
+      path: 'lib/templates',
+      file: 'types.js',
+      contents: getJsGlobalTypesTemplateFile(stackableName)
+    },
     {
       path: 'lib',
       file: 'schema.js',

package/lib/stackable-generator.js

@@ -226,6 +226,7 @@ class StackableGenerator extends FileGenerator {
 
       return {
         name: npmPackageName,
+        version: '0.0.1',
         main: 'dist/index.js',
         bin: {
           [createStackableCommand]: './dist/cli/create.js',
@@ -255,6 +256,7 @@ class StackableGenerator extends FileGenerator {
 
     return {
       name: npmPackageName,
+      version: '0.0.1',
       main: 'index.js',
       bin: {
         [createStackableCommand]: './cli/create.js',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "1.20.2",
+  "version": "1.21.0",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -18,7 +18,6 @@
     "@types/inquirer": "^9.0.7",
     "borp": "^0.9.0",
     "c8": "^9.1.0",
-    "glob": "^10.3.10",
     "snazzy": "^9.0.0",
     "standard": "^17.1.0",
     "typescript": "^5.3.3"

package/test/runner.js

@@ -1,26 +0,0 @@
-'use strict'
-
-const { tap, spec } = require('node:test/reporters')
-const { run } = require('node:test')
-const { join } = require('node:path')
-const glob = require('glob').globSync
-
-/* eslint-disable new-cap */
-const reporter = process.stdout.isTTY ? new spec() : tap
-
-const files = [
-  ...glob('*.test.{js,mjs}', { cwd: __dirname }),
-  ...glob('*/*.test.{js,mjs}', { cwd: __dirname })
-].map(file => join(__dirname, file))
-
-const stream = run({
-  files,
-  concurrency: 1,
-  timeout: 30000
-})
-
-stream.on('test:fail', () => {
-  process.exitCode = 1
-})
-
-stream.compose(reporter).pipe(process.stdout)