@platformatic/generators 2.74.3 → 3.0.0-alpha.2

package/index.d.ts

@@ -1,5 +1,2 @@
-import { BaseGenerator } from './lib/base-generator'
-import { generatePlugins, generateTests } from './lib/create-plugin'
-import { FileGenerator } from './lib/file-generator'
-
-export { BaseGenerator, FileGenerator, generatePlugins, generateTests }
+export * from './lib/base-generator'
+export * from './lib/file-generator'

package/index.js

@@ -2,12 +2,10 @@
 
 const { BaseGenerator } = require('./lib/base-generator')
 const { ImportGenerator } = require('./lib/import-generator')
-const { generateTests } = require('./lib/create-plugin')
 const utils = require('./lib/utils')
 
 module.exports = {
   BaseGenerator,
   ImportGenerator,
-  generateTests,
   ...utils
 }

package/index.test-d.ts

@@ -1,22 +1,16 @@
 import { expectAssignable } from 'tsd'
 import { BaseGenerator } from './lib/base-generator'
-import { generatePlugins, generateTests } from './index'
-import { FileGenerator } from './lib/file-generator'
 
 expectAssignable<BaseGenerator.ConfigFieldDefinition>({
   label: 'PLT_TESTING',
   var: 'testing',
   default: 'hello world',
   type: 'string',
-  configValue: 'someConfigValue',
+  configValue: 'someConfigValue'
 })
 
 expectAssignable<BaseGenerator.ConfigField>({
   var: 'testing',
   configValue: 'someConfigValue',
-  value: 'asd123',
+  value: 'asd123'
 })
-
-expectAssignable<FileGenerator.FileObject[]>(generatePlugins(true))
-
-expectAssignable<FileGenerator.FileObject[]>(generateTests(true, '@platformatic/service'))

package/lib/base-generator.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { generateDashedName } = require('@platformatic/utils')
+const { generateDashedName } = require('@platformatic/foundation')
 const { readFile } = require('node:fs/promises')
 const {
   convertServiceNameToPrefix,
@@ -12,7 +12,6 @@ const {
 } = require('./utils')
 const { join } = require('node:path')
 const { FileGenerator } = require('./file-generator')
-const { generateTests, generatePlugins } = require('./create-plugin')
 const { PrepareError, MissingEnvVariable, ModuleNeeded } = require('./errors')
 const { generateGitignore } = require('./create-gitignore')
 const { getServiceTemplateFromSchemaUrl } = require('./utils')
@@ -28,6 +27,8 @@ const fakeLogger = {
 }
 /* c8 ignore start */
 
+const DEFAULT_SERVICES_PATH = 'services'
+
 class BaseGenerator extends FileGenerator {
   constructor (opts = {}) {
     super(opts)
@@ -40,12 +41,17 @@ class BaseGenerator extends FileGenerator {
     this.config = this.getDefaultConfig()
     this.packages = []
     this.module = opts.module
+    this.runtime = null
     this.runtimeConfig = opts.runtimeConfig ?? 'platformatic.json'
     if (!this.module) {
       throw ModuleNeeded()
     }
   }
 
+  setRuntime (runtime) {
+    this.runtime = runtime
+  }
+
   getDefaultConfig () {
     return {
       port: 3042,
@@ -213,24 +219,6 @@ class BaseGenerator extends FileGenerator {
 
         await this.generateEnv()
 
-        if (this.config.typescript) {
-          // create tsconfig.json
-          this.addFile({
-            path: '',
-            file: 'tsconfig.json',
-            contents: JSON.stringify(this.getTsConfig(), null, 2)
-          })
-        }
-
-        if (this.config.plugin) {
-          // create plugin
-          this.files.push(...generatePlugins(this.config.typescript))
-          if (this.config.tests) {
-            // create tests
-            this.files.push(...generateTests(this.config.typescript, this.module))
-          }
-        }
-
         this.files.push(generateGitignore())
 
         await this._afterPrepare()
@@ -272,30 +260,6 @@ class BaseGenerator extends FileGenerator {
     return true
   }
 
-  getTsConfig () {
-    return {
-      compilerOptions: {
-        module: 'commonjs',
-        esModuleInterop: true,
-        target: 'es2020',
-        sourceMap: true,
-        pretty: true,
-        noEmitOnError: true,
-        incremental: true,
-        strict: true,
-        outDir: 'dist',
-        skipLibCheck: true
-      },
-      watchOptions: {
-        watchFile: 'fixedPollingInterval',
-        watchDirectory: 'fixedPollingInterval',
-        fallbackPolling: 'dynamicPriority',
-        synchronousWatchDirectory: true,
-        excludeDirectories: ['**/node_modules', 'dist']
-      }
-    }
-  }
-
   async prepareQuestions () {
     if (!this.config.isRuntimeContext) {
       if (!this.config.targetDirectory) {
@@ -307,19 +271,6 @@ class BaseGenerator extends FileGenerator {
         })
       }
 
-      if (!this.config.skipTypescript) {
-        this.questions.push({
-          type: 'list',
-          name: 'typescript',
-          message: 'Do you want to use TypeScript?',
-          default: false,
-          choices: [
-            { name: 'yes', value: true },
-            { name: 'no', value: false }
-          ]
-        })
-      }
-
       // port
       if (!this.config.skipPort) {
         this.questions.push({
@@ -403,15 +354,13 @@ class BaseGenerator extends FileGenerator {
         ...this.config.dependencies
       },
       engines: {
-        node: '^22.14.0 || ^20.6.0'
+        node: '>=22.18.0'
       }
     }
 
     if (this.config.typescript) {
       const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', 'package.json'), 'utf-8'))
         .devDependencies.typescript
-      template.scripts.clean = 'rm -fr ./dist'
-      template.scripts.build = 'platformatic compile'
       template.devDependencies.typescript = typescriptVersion
     }
     return template
@@ -470,7 +419,7 @@ class BaseGenerator extends FileGenerator {
 
   async loadFromDir (serviceName, runtimeRootPath) {
     const runtimePkgConfigFileData = JSON.parse(await readFile(join(runtimeRootPath, this.runtimeConfig), 'utf-8'))
-    const servicesPath = runtimePkgConfigFileData.autoload.path
+    const servicesPath = runtimePkgConfigFileData.autoload?.path ?? DEFAULT_SERVICES_PATH
     const servicePkgJsonFileData = JSON.parse(
       await readFile(join(runtimeRootPath, servicesPath, serviceName, 'platformatic.json'), 'utf-8')
     )

package/lib/file-generator.js

@@ -1,5 +1,5 @@
 'use strict'
-const { createDirectory } = require('@platformatic/utils')
+const { createDirectory } = require('@platformatic/foundation')
 const { dirname, join, isAbsolute } = require('node:path')
 const { writeFile, readFile } = require('node:fs/promises')
 

package/lib/import-generator.js

@@ -1,12 +1,10 @@
 'use strict'
 
-const { findConfigurationFile } = require('@platformatic/config')
-const { safeRemove } = require('@platformatic/utils')
-const { glob } = require('glob')
+const { safeRemove, findConfigurationFileRecursive } = require('@platformatic/foundation')
 const { BaseGenerator } = require('./base-generator')
 const { spawnSync } = require('node:child_process')
-const { stat, readFile } = require('node:fs/promises')
-const { join, dirname } = require('node:path')
+const { stat, readFile, readdir } = require('node:fs/promises')
+const { join, dirname, resolve, relative } = require('node:path')
 
 class ImportGenerator extends BaseGenerator {
   constructor (options = {}) {
@@ -120,7 +118,7 @@ class ImportGenerator extends BaseGenerator {
   async #generateConfigFile (originalPath, updatedPath) {
     // Determine if there is a watt.json file in the application path - If it's missing, insert one
     // For import it means we don't update  the file, for copy it means it was already copied in #copy.
-    const existingConfig = await findConfigurationFile(originalPath)
+    const existingConfig = await findConfigurationFileRecursive(originalPath)
 
     if (existingConfig) {
       return
@@ -203,30 +201,29 @@ class ImportGenerator extends BaseGenerator {
   }
 
   async #copy (root) {
-    const files = await glob('**/*', {
-      cwd: root,
-      dot: true,
-      ignore: ['node_modules/**', 'package-lock.json', 'pnpm-lock.yaml', 'yarn.lock'],
-      withFileTypes: true
-    })
+    const files = await readdir(root, { withFileTypes: true, recursive: true })
+
+    for await (const file of files) {
+      const absolutePath = resolve(file.parentPath, file.name)
+      let path = relative(root, dirname(absolutePath))
 
-    for (const file of files) {
-      if (file.isDirectory()) {
+      if (
+        file.isDirectory() ||
+        ['package-lock.json', 'pnpm-lock.yaml', 'yarn.lock'].includes(file.name) ||
+        path.includes('node_modules')
+      ) {
         continue
       }
 
       /* c8 ignore next 6 */
-      let path = dirname(file.relative())
       if (path === '.') {
         path = ''
-      } else if (path.startsWith('./')) {
-        path = path.substring(2)
       }
 
       this.addFile({
         path,
         file: file.name,
-        contents: await readFile(file.fullpath())
+        contents: await readFile(resolve(file.parentPath, file.name))
       })
     }
   }

package/lib/utils.js

@@ -6,7 +6,7 @@ const { request } = require('undici')
 const { setTimeout } = require('timers/promises')
 const PLT_ROOT = 'PLT_ROOT'
 const { EOL } = require('node:os')
-const { createDirectory } = require('@platformatic/utils')
+const { createDirectory } = require('@platformatic/foundation')
 
 /**
  * Strip all extra characters from a simple semver version string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "2.74.3",
+  "version": "3.0.0-alpha.2",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -11,11 +11,9 @@
     "change-case-all": "^2.1.0",
     "execa": "^9.6.0",
     "fastify": "^5.0.0",
-    "glob": "^11.0.2",
-    "pino": "^9.0.0",
+    "pino": "^9.9.0",
     "undici": "^7.0.0",
-    "@platformatic/config": "2.74.3",
-    "@platformatic/utils": "2.74.3"
+    "@platformatic/foundation": "3.0.0-alpha.2"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",
@@ -26,6 +24,9 @@
     "tsd": "^0.32.0",
     "typescript": "^5.5.4"
   },
+  "engines": {
+    "node": ">=22.18.0"
+  },
   "scripts": {
     "lint": "eslint",
     "test": "pnpm run lint && borp --timeout=1200000 -C -X fixtures -X test --concurrency=1 && tsd"

package/lib/create-plugin.d.ts

@@ -1,13 +0,0 @@
-import { FileGenerator } from './file-generator'
-
-type HelperCustomization = {
-  pre: string
-  post: string
-  config: string
-  requires: string
-}
-
-export function generatePluginWithTypesSupport (typescript: boolean): FileGenerator.FileObject
-export function generateRouteWithTypesSupport (typescript: boolean): FileGenerator.FileObject
-export function generateTests (typescript: boolean, type: string, customization?: HelperCustomization): Array<FileGenerator.FileObject>
-export function generatePlugins (typescript: boolean): Array<FileGenerator.FileObject>

package/lib/create-plugin.js

@@ -1,255 +0,0 @@
-'use strict'
-
-const { join } = require('path')
-
-const JS_PLUGIN_WITH_TYPES_SUPPORT = `\
-/// <reference path="../global.d.ts" />
-'use strict'
-/** @param {import('fastify').FastifyInstance} fastify */
-module.exports = async function (fastify, opts) {
-  fastify.decorate('example', 'foobar')
-}
-`
-
-const TS_PLUGIN_WITH_TYPES_SUPPORT = `\
-/// <reference path="../global.d.ts" />
-import { FastifyInstance, FastifyPluginOptions } from 'fastify'
-
-export default async function (fastify: FastifyInstance, opts: FastifyPluginOptions) {
-  fastify.decorate('example', 'foobar')
-}
-`
-
-const JS_ROUTES_WITH_TYPES_SUPPORT = `\
-/// <reference path="../global.d.ts" />
-'use strict'
-/** @param {import('fastify').FastifyInstance} fastify */
-module.exports = async function (fastify, opts) {
-  fastify.get('/example', async (request, reply) => {
-    return { hello: fastify.example }
-  })
-}
-`
-
-const TS_ROUTES_WITH_TYPES_SUPPORT = `\
-/// <reference path="../global.d.ts" />
-import { FastifyInstance, FastifyPluginOptions } from 'fastify'
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    example: string
-  }
-}
-
-export default async function (fastify: FastifyInstance, opts: FastifyPluginOptions) {
-  fastify.get('/example', async (request, reply) => {
-    return { hello: fastify.example }
-  })
-}
-`
-
-function testHelperJS (mod, customization = { pre: '', post: '', config: '' }) {
-  return `\
-'use strict'
-
-const { join } = require('node:path')
-const { readFile } = require('node:fs/promises')
-const { buildServer } = require('${mod}')
-${customization.requires || ''}
-
-async function getServer (t) {
-${customization.pre || ''}
-  const config = JSON.parse(await readFile(join(__dirname, '..', 'watt.json'), 'utf8'))
-  // Add your config customizations here. For example you want to set
-  // all things that are set in the config file to read from an env variable
-  config.server ||= {}
-  config.server.logger ||= {}
-  config.watch = false
-${customization.config || ''}
-  // Add your config customizations here
-  const server = await buildServer(config)
-  t.after(() => server.close())
-${customization.post || ''}
-  return server
-}
-
-module.exports.getServer = getServer
-`
-}
-
-const TEST_ROUTES_JS = `\
-'use strict'
-
-const test = require('node:test')
-const assert = require('node:assert')
-const { getServer } = require('../helper')
-
-test('example', async (t) => {
-  const server = await getServer(t)
-  const res = await server.inject({
-    method: 'GET',
-    url: '/example'
-  })
-
-  assert.strictEqual(res.statusCode, 200)
-  assert.deepStrictEqual(res.json(), {
-    hello: 'foobar'
-  })
-})
-`
-
-const TEST_PLUGIN_JS = `\
-'use strict'
-
-const test = require('node:test')
-const assert = require('node:assert')
-const { getServer } = require('../helper')
-
-test('example decorator', async (t) => {
-  const server = await getServer(t)
-
-  assert.strictEqual(server.example, 'foobar')
-})
-`
-
-function testHelperTS (mod, customizations = { pre: '', post: '', config: '', requires: '' }) {
-  return `\
-import { join } from 'node:path'
-import { readFile } from 'node:fs/promises'
-import { buildServer } from '${mod}'
-import { test } from 'node:test'
-${customizations.requires}
-
-type testfn = Parameters<typeof test>[0]
-type TestContext = Parameters<Exclude<testfn, undefined>>[0]
-
-export async function getServer (t: TestContext) {
-${customizations.pre}
-  // We go up two folder because this files executes in the dist folder
-  const config = JSON.parse(await readFile(join(__dirname, '..', '..', 'watt.json'), 'utf8'))
-  // Add your config customizations here. For example you want to set
-  // all things that are set in the config file to read from an env variable
-  config.server ||= {}
-  config.server.logger ||= {}
-  config.server.logger.level = 'warn'
-  config.watch = false
-${customizations.config}
-  // Add your config customizations here
-  const server = await buildServer(config)
-  t.after(() => server.close())
-${customizations.post}
-  return server
-}
-  `
-}
-
-const TEST_ROUTES_TS = `\
-import test from 'node:test'
-import assert from 'node:assert'
-import { getServer } from '../helper'
-
-test('root', async (t) => {
-  const server = await getServer(t)
-  const res = await server.inject({
-    method: 'GET',
-    url: '/example'
-  })
-
-  assert.strictEqual(res.statusCode, 200)
-  assert.deepStrictEqual(res.json(), {
-    hello: 'foobar'
-  })
-})
-`
-
-const TEST_PLUGIN_TS = `\
-import test from 'node:test'
-import assert from 'node:assert'
-import { getServer } from '../helper'
-
-test('example decorator', async (t) => {
-  const server = await getServer(t)
-
-  assert.strictEqual(server.example, 'foobar')
-})
-`
-
-function generatePluginWithTypesSupport (typescript) {
-  const pluginTemplate = typescript
-    ? TS_PLUGIN_WITH_TYPES_SUPPORT
-    : JS_PLUGIN_WITH_TYPES_SUPPORT
-  const pluginName = typescript
-    ? 'example.ts'
-    : 'example.js'
-  return {
-    path: 'plugins',
-    file: pluginName,
-    contents: pluginTemplate,
-  }
-}
-
-function generateRouteWithTypesSupport (typescript) {
-  const routesTemplate = typescript
-    ? TS_ROUTES_WITH_TYPES_SUPPORT
-    : JS_ROUTES_WITH_TYPES_SUPPORT
-  const routesName = typescript
-    ? 'root.ts'
-    : 'root.js'
-  return {
-    path: 'routes',
-    file: routesName,
-    contents: routesTemplate,
-  }
-}
-
-function generateTests (typescript, mod, customizations) {
-  const output = []
-  if (typescript) {
-    output.push({
-      path: 'test',
-      file: 'helper.ts',
-      contents: testHelperTS(mod, customizations),
-    })
-    output.push({
-      path: join('test', 'plugins'),
-      file: 'example.test.ts',
-      contents: TEST_PLUGIN_TS,
-    })
-    output.push({
-      path: join('test', 'routes'),
-      file: 'root.test.ts',
-      contents: TEST_ROUTES_TS,
-    })
-  } else {
-    output.push({
-      path: 'test',
-      file: 'helper.js',
-      contents: testHelperJS(mod, customizations),
-    })
-    output.push({
-      path: join('test', 'plugins'),
-      file: 'example.test.js',
-      contents: TEST_PLUGIN_JS,
-    })
-    output.push({
-      path: join('test', 'routes'),
-      file: 'root.test.js',
-      contents: TEST_ROUTES_JS,
-    })
-  }
-  return output
-}
-
-function generatePlugins (typescript) {
-  const files = []
-  files.push(generatePluginWithTypesSupport(typescript))
-  files.push(generateRouteWithTypesSupport(typescript))
-  return files
-}
-
-module.exports = {
-  generatePluginWithTypesSupport,
-  generateRouteWithTypesSupport,
-  generatePlugins,
-  generateTests,
-}