@platformatic/generators 2.0.0-alpha.2 → 2.0.0-alpha.21

package/package.json

@@ -1,30 +1,31 @@
 {
   "name": "@platformatic/generators",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.21",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "@fastify/error": "^3.4.1",
+    "@fastify/error": "^4.0.0",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
-    "fastify": "^4.26.2",
-    "pino": "^8.19.0",
-    "undici": "^6.9.0"
+    "fastify": "^5.0.0",
+    "pino": "^9.0.0",
+    "undici": "^6.9.0",
+    "@platformatic/utils": "2.0.0-alpha.21"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",
-    "borp": "^0.16.0",
+    "borp": "^0.17.0",
     "c8": "^10.0.0",
-    "snazzy": "^9.0.0",
-    "standard": "^17.1.0",
+    "eslint": "9",
+    "neostandard": "^0.11.1",
     "tsd": "^0.31.0",
-    "typescript": "^5.4.2"
+    "typescript": "^5.5.4"
   },
   "scripts": {
-    "lint": "standard | snazzy",
-    "test": "pnpm run lint && borp -C -X fixtures -X test --concurrency=1 && tsd"
+    "lint": "eslint",
+    "test": "pnpm run lint && borp --timeout=180000 -C -X fixtures -X test --concurrency=1 && tsd"
   }
 }

package/lib/create-stackable-cli.js

@@ -1,161 +0,0 @@
-'use strict'
-
-const { kebabCase } = require('change-case-all')
-
-function getJsStackableStartCli () {
-  return `\
-#!/usr/bin/env node
-'use strict'
-
-const stackable = require('../index')
-const { start } = require('@platformatic/service')
-const { printAndExitLoadConfigError } = require('@platformatic/config')
-
-start(stackable, process.argv.splice(2)).catch(printAndExitLoadConfigError)
-`
-}
-
-function getTsStackableStartCli () {
-  return `\
-#!/usr/bin/env node
-import stackable from '../index'
-import { start } from '@platformatic/service'
-import { printAndExitLoadConfigError } from '@platformatic/config'
-
-start(stackable, process.argv.splice(2)).catch(printAndExitLoadConfigError)
-`
-}
-
-function getJsStackableCreateCli (stackableName) {
-  return `\
-#!/usr/bin/env node
-'use strict'
-
-const { join } = require('node:path')
-const { parseArgs } = require('node:util')
-const { Generator } = require('../lib/generator')
-
-async function execute () {
-  const args = parseArgs({
-    args: process.argv.slice(2),
-    options: {
-      dir: {
-        type: 'string',
-        default: join(process.cwd(), '${kebabCase(stackableName + '-app')}')
-      },
-      port: { type: 'string', default: '3042' },
-      hostname: { type: 'string', default: '0.0.0.0' },
-      plugin: { type: 'boolean', default: true },
-      tests: { type: 'boolean', default: true },
-      typescript: { type: 'boolean', default: false },
-      git: { type: 'boolean', default: false },
-      install: { type: 'boolean', default: true }
-    }
-  })
-
-  const generator = new Generator()
-
-  generator.setConfig({
-    port: parseInt(args.values.port),
-    hostname: args.values.hostname,
-    plugin: args.values.plugin,
-    tests: args.values.tests,
-    typescript: args.values.typescript,
-    initGitRepository: args.values.git,
-    targetDirectory: args.values.dir
-  })
-
-  await generator.run()
-
-  console.log('Application created successfully! Run \`npm run start\` to start an application.')
-}
-
-execute()
-`
-}
-
-function getTsStackableCreateCli (stackableName) {
-  return `\
-#!/usr/bin/env node
-import { join } from 'node:path'
-import { parseArgs } from 'node:util'
-import { Generator } from '../lib/generator'
-
-async function execute (): Promise<void> {
-  const args = parseArgs({
-    args: process.argv.slice(2),
-    options: {
-      dir: {
-        type: 'string',
-        default: join(process.cwd(), '${kebabCase(stackableName + '-app')}')
-      },
-      port: { type: 'string' },
-      hostname: { type: 'string', default: '0.0.0.0' },
-      plugin: { type: 'boolean', default: true },
-      tests: { type: 'boolean', default: true },
-      typescript: { type: 'boolean', default: false },
-      git: { type: 'boolean', default: false },
-      install: { type: 'boolean', default: true }
-    }
-  })
-
-  const generator = new Generator()
-
-  generator.setConfig({
-    port: parseInt(args.values.port || '3042'),
-    hostname: args.values.hostname,
-    plugin: args.values.plugin,
-    tests: args.values.tests,
-    typescript: args.values.typescript,
-    initGitRepository: args.values.git,
-    targetDirectory: args.values.dir
-  })
-
-  await generator.run()
-
-  console.log('Application created successfully! Run \`npm run start\` to start an application.')
-}
-
-execute().catch(err => {
-  throw err
-})
-`
-}
-
-function generateStackableCli (typescript, stackableName) {
-  if (typescript) {
-    return [
-      {
-        path: 'cli',
-        file: 'start.ts',
-        contents: getTsStackableStartCli(),
-        options: { mode: 0o755 }
-      },
-      {
-        path: 'cli',
-        file: 'create.ts',
-        contents: getTsStackableCreateCli(stackableName),
-        options: { mode: 0o755 }
-      }
-    ]
-  }
-
-  return [
-    {
-      path: 'cli',
-      file: 'start.js',
-      contents: getJsStackableStartCli(),
-      options: { mode: 0o755 }
-    },
-    {
-      path: 'cli',
-      file: 'create.js',
-      contents: getJsStackableCreateCli(stackableName),
-      options: { mode: 0o755 }
-    }
-  ]
-}
-
-module.exports = {
-  generateStackableCli
-}

package/lib/create-stackable-files.js

@@ -1,518 +0,0 @@
-'use strict'
-
-const { pascalCase, camelCase, capitalCase, kebabCase } = require('change-case-all')
-
-function getJsStackableIndexFile (stackableName) {
-  return `\
-'use strict'
-
-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,
-  allowToWatch: ['.env'],
-  schemaOptions: {
-    useDefaults: true,
-    coerceTypes: true,
-    allErrors: true,
-    strict: false
-  },
-  async transformConfig () {}
-}
-
-// break Fastify encapsulation
-stackable[Symbol.for('skip-override')] = true
-
-module.exports = stackable
-`
-}
-
-function getTsStackableIndexFile (stackableName) {
-  const stackableConfigType = pascalCase(stackableName + 'Config')
-
-  return `\
-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)
-  await fastify.register(require('./plugins/example'), opts)
-}
-
-stackable.configType = '${kebabCase(stackableName + '-app')}'
-stackable.schema = schema
-stackable.Generator = Generator
-stackable.configManagerConfig = {
-  version,
-  schema,
-  allowToWatch: ['.env'],
-  schemaOptions: {
-    useDefaults: true,
-    coerceTypes: true,
-    allErrors: true,
-    strict: false
-  },
-  async transformConfig () {}
-}
-
-// break Fastify encapsulation
-// @ts-ignore 
-stackable[Symbol.for('skip-override')] = true
-
-export default stackable
-export { Generator, schema }
-`
-}
-
-function getStackableIndexTypesFile (stackableName) {
-  const stackableConfigType = pascalCase(stackableName + 'Config')
-
-  return `\
-import { FastifyInstance } from 'fastify'
-import { PlatformaticApp } from '@platformatic/service'
-import { ${stackableConfigType} } from './config'
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    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}>
-  }
-}
-\`
-}
-`
-}
-
-function getJsStackableGeneratorFile (stackableName) {
-  const stackableGeneratorType = pascalCase(stackableName + 'Generator')
-
-  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 () {
-    const defaultBaseConfig = super.getDefaultConfig()
-    const defaultConfig = {
-      greeting: 'Hello world!'
-    }
-    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}@\${packageJson.version}\`,
-      greeting: {
-        text: \`{\${this.getEnvVarName('PLT_GREETING_TEXT')}}\`
-      }
-    }
-    return Object.assign({}, baseConfig, config)
-  }
-
-  async _beforePrepare () {
-    super._beforePrepare()
-
-    this.addEnvVars({
-      PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!'
-    }, { overwrite: false, default: true })
-
-    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) {
-      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}
-module.exports.Generator = ${stackableGeneratorType}
-`
-}
-
-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 (): { [x: string]: BaseGenerator.JSONValue } {
-    const defaultBaseConfig = super.getDefaultConfig()
-    const defaultConfig = {
-      greeting: 'Hello world!'
-    }
-    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<{ [x: string]: BaseGenerator.JSONValue }> {
-    const baseConfig = await super._getConfigFileContents()
-    const packageJson = await this.getStackablePackageJson()
-    const config = {
-      $schema: './stackable.schema.json',
-      module: \`\${packageJson.name}@\${packageJson.version}\`,
-      greeting: {
-        text: \`{\${this.getEnvVarName('PLT_GREETING_TEXT')}}\`
-      }
-    }
-    return Object.assign({}, baseConfig, config)
-  }
-
-  async _beforePrepare (): Promise<void> {
-    await super._beforePrepare()
-
-    this.addEnvVars({
-      PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!'
-    }, { overwrite: false, default: true })
-
-    const packageJson = await this.getStackablePackageJson()
-
-    this.config.dependencies = {
-      [packageJson.name]: \`^\${packageJson.version}\`
-    }
-  }
-
-  async _afterPrepare (): Promise<void> {
-    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) {
-      const packageJsonPath = join(__dirname, '..', '..', 'package.json')
-      const packageJsonFile = await readFile(packageJsonPath, 'utf8')
-      const packageJson: Partial<PackageJson> = JSON.parse(packageJsonFile)
-
-      if (packageJson.name === undefined || packageJson.name === null) {
-        throw new Error('Missing package name in package.json')
-      }
-
-      if (packageJson.version === undefined || packageJson.version === null) {
-        throw new Error('Missing package version in package.json')
-      }
-
-      this._packageJson = packageJson as PackageJson
-      return packageJson as PackageJson
-    }
-    return this._packageJson
-  }
-}
-
-export default ${stackableGeneratorType}
-export { ${stackableGeneratorType} as Generator }
-`
-}
-
-function getJsStackableSchemaFile (stackableName) {
-  const schemaId = kebabCase(stackableName)
-  const schemaTitle = capitalCase(stackableName + 'Config')
-  const schemaVarName = camelCase(stackableName + 'Schema')
-
-  return `\
-'use strict'
-
-const { schema } = require('@platformatic/service')
-const { version } = require('../package.json')
-
-const ${schemaVarName} = {
-  ...schema,
-  $id: '${schemaId}',
-  title: '${schemaTitle}',
-  version,
-  properties: {
-    ...schema.properties,
-    module: { type: 'string' },
-    greeting: {
-      type: 'object',
-      properties: {
-        text: {
-          type: 'string'
-        }
-      },
-      required: ['text'],
-      additionalProperties: false
-    }
-  }
-}
-
-module.exports.schema = ${schemaVarName}
-
-if (require.main === module) {
-  console.log(JSON.stringify(${schemaVarName}, null, 2))
-}
-`
-}
-
-function getTsStackableSchemaFile (stackableName) {
-  const schemaId = kebabCase(stackableName)
-  const schemaTitle = capitalCase(stackableName + 'Config')
-  const schemaVarName = camelCase(stackableName + 'Schema')
-
-  return `\
-import { schema } from '@platformatic/service'
-import { readFileSync } from 'node:fs'
-
-const { version } = JSON.parse(readFileSync('package.json', 'utf8'))
-
-const ${schemaVarName} = {
-  ...schema,
-  $id: '${schemaId}',
-  title: '${schemaTitle}',
-  version,
-  properties: {
-    ...schema.properties,
-    module: { type: 'string' },
-    greeting: {
-      type: 'object',
-      properties: {
-        text: {
-          type: 'string'
-        }
-      },
-      required: ['text'],
-      additionalProperties: false
-    }
-  }
-}
-
-export { ${schemaVarName} as schema }
-
-if (require.main === module) {
-  console.log(JSON.stringify(${schemaVarName}, null, 2))
-}
-`
-}
-
-function getStackableConfigTypesFile (stackableName) {
-  const stackableConfigType = pascalCase(stackableName + 'Config')
-
-  return `\
-// Use npm run build:config to generate this file from the Stackable schema
-export interface ${stackableConfigType} {
-  greeting?: {
-    text: string;
-  };
-}
-`
-}
-
-function generateStackableFiles (typescript, stackableName) {
-  if (typescript) {
-    return [
-      {
-        path: '',
-        file: 'index.ts',
-        contents: getTsStackableIndexFile(stackableName)
-      },
-      {
-        path: '',
-        file: 'index.d.ts',
-        contents: getStackableIndexTypesFile(stackableName)
-      },
-      {
-        path: '',
-        file: 'config.d.ts',
-        contents: getStackableConfigTypesFile(stackableName)
-      },
-      {
-        path: 'lib',
-        file: 'generator.ts',
-        contents: getTsStackableGeneratorFile(stackableName)
-      },
-      {
-        path: 'lib/templates',
-        file: 'types.ts',
-        contents: getTsGlobalTypesTemplateFile(stackableName)
-      },
-      {
-        path: 'lib',
-        file: 'schema.ts',
-        contents: getTsStackableSchemaFile(stackableName)
-      }
-    ]
-  }
-  return [
-    {
-      path: '',
-      file: 'index.js',
-      contents: getJsStackableIndexFile(stackableName)
-    },
-    {
-      path: '',
-      file: 'index.d.ts',
-      contents: getStackableIndexTypesFile(stackableName)
-    },
-    {
-      path: '',
-      file: 'config.d.ts',
-      contents: getStackableConfigTypesFile(stackableName)
-    },
-    {
-      path: 'lib',
-      file: 'generator.js',
-      contents: getJsStackableGeneratorFile(stackableName)
-    },
-    {
-      path: 'lib/templates',
-      file: 'types.js',
-      contents: getJsGlobalTypesTemplateFile(stackableName)
-    },
-    {
-      path: 'lib',
-      file: 'schema.js',
-      contents: getJsStackableSchemaFile(stackableName)
-    }
-  ]
-}
-
-module.exports = {
-  generateStackableFiles
-}