@platformatic/generators 1.13.0

package/lib/create-plugin.js

@@ -0,0 +1,252 @@
+'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('@platformatic/${mod}')
+${customization.requires || ''}
+
+async function getServer (t) {
+${customization.pre || ''}
+  const config = JSON.parse(await readFile(join(__dirname, '..', 'platformatic.${mod}.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.logger.level = 'warn'
+  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 '@platformatic/${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, '..', '..', 'platformatic.${mod}.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.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, type, customizations) {
+  const output = []
+  if (typescript) {
+    output.push({
+      path: 'test',
+      file: 'helper.ts',
+      contents: testHelperTS(type, 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(type, 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
+}

package/lib/errors.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const createError = require('@fastify/error')
+
+const ERROR_PREFIX = 'PLT_GEN'
+
+module.exports = {
+  NoQuestionsError: createError(`${ERROR_PREFIX}_NO_QUESTIONS_ERROR`, 'No questions added.'),
+  PrepareError: createError(`${ERROR_PREFIX}_PREPARE_ERROR`, 'Error while generating the files: %s.'),
+  MissingEnvVariable: createError(`${ERROR_PREFIX}_MISSING_ENV_VAR`, 'Env variable %s is defined in config file %s, but not in config.env object.')
+}

package/lib/file-generator.d.ts

@@ -0,0 +1,29 @@
+import { BaseLogger } from 'pino'
+
+export namespace FileGenerator {
+  export type FileGeneratorOptions = {
+    logger?: BaseLogger
+  }
+  
+  export type FileObject = {
+    path: string,
+    file: string,
+    contents: string
+  }
+  
+  export class FileGenerator {
+    files: FileObject[]
+    targetDirectory: string
+  
+    constructor(opts?: FileGeneratorOptions)
+  
+    setTargetDirectory(dir: string): void
+    addFile(file: FileObject): void
+    appendfile(file: FileObject): void
+    reset(): void
+    writeFiles(): Promise<void>
+    listFiles(): FileObject
+    getFileObject(file: string, path?: string): FileObject
+  }
+  
+}

package/lib/file-generator.js

@@ -0,0 +1,90 @@
+'use strict'
+const { safeMkdir } = require('./utils')
+const { join } = require('node:path')
+const { writeFile } = require('node:fs/promises')
+
+/* c8 ignore start */
+const fakeLogger = {
+  info: () => {},
+  warn: () => {},
+  debug: () => {},
+  trace: () => {},
+  error: () => {}
+}
+/* c8 ignore start */
+
+class FileGenerator {
+  constructor (opts = {}) {
+    this.files = []
+    this.logger = opts.logger || fakeLogger
+    this.targetDirectory = opts.targetDirectory || null
+  }
+
+  setTargetDirectory (dir) {
+    this.targetDirectory = dir
+  }
+
+  addFile ({ path, file, contents }) {
+    const fileObject = this.getFileObject(file, path)
+    if (path.startsWith('/')) {
+      path = path.substring(1)
+    }
+    if (fileObject) {
+      fileObject.contents = contents
+    } else {
+      this.files.push({ path, file, contents })
+    }
+  }
+
+  appendfile ({ path, file, contents }) {
+    if (path.startsWith('/')) {
+      path = path.substring(1)
+    }
+    const fileObject = this.getFileObject(file, path)
+    if (fileObject) {
+      fileObject.contents += `\n${contents}`
+    } else {
+      this.files.push({ path, file, contents })
+    }
+  }
+
+  async writeFiles () {
+    if (!this.targetDirectory) {
+      throw new Error('No target directory set.')
+    }
+    await safeMkdir(this.targetDirectory)
+    for (const fileToWrite of this.files) {
+      if (fileToWrite.contents.length === 0) {
+        continue
+      }
+      const baseDir = join(this.targetDirectory, fileToWrite.path)
+      if (fileToWrite.path !== '') {
+        await safeMkdir(baseDir)
+      }
+      const fullFilePath = join(baseDir, fileToWrite.file)
+      await writeFile(fullFilePath, fileToWrite.contents)
+      this.logger.info(`${fullFilePath} written!`)
+    }
+  }
+
+  getFileObject (name, path = '') {
+    const output = this.files.find((file) => {
+      return file.path === path && file.file === name
+    })
+    if (!output) { return null }
+    return output
+  }
+
+  listFiles () {
+    return this.files.map((fileObject) => {
+      return join(fileObject.path, fileObject.file)
+    })
+  }
+
+  reset () {
+    this.files = []
+  }
+}
+
+module.exports = FileGenerator
+module.exports.FileGenerator = FileGenerator

package/lib/utils.d.ts

@@ -0,0 +1,12 @@
+type Env = {
+  [key: string]: string
+}
+
+export namespace GeneratorUtils {
+  export function safeMkdir(dir: string): Promise<void>
+  export function stripVersion(version: string): string
+  export function convertServiceNameToPrefix(serviceName: string): string
+  export function addPrefixToEnv(env: Env, prefix: string): Env
+  export function envObjectToString(env: Env): string
+  export function extractEnvVariablesFromText(text: string): string[]
+}

package/lib/utils.js

@@ -0,0 +1,69 @@
+'use strict'
+
+const { mkdir } = require('node:fs/promises')
+
+async function safeMkdir (dir) {
+  try {
+    await mkdir(dir, { recursive: true })
+    /* c8 ignore next 3 */
+  } catch (err) {
+    // do nothing
+  }
+}
+
+/**
+ * Strip all extra characters from a simple semver version string
+ * @param {string} version
+ * @returns string
+ */
+function stripVersion (version) {
+  const match = version.match(/(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)/)
+  if (match) {
+    return match[0]
+  }
+  return version
+}
+
+function convertServiceNameToPrefix (serviceName) {
+  return serviceName.replace(/-/g, '_').toUpperCase()
+}
+
+function addPrefixToEnv (env, prefix) {
+  const newEnv = {}
+  const prefixRegExp = new RegExp(`^PLT_${prefix}_`)
+  Object.entries(env).forEach((kv) => {
+    if (!kv[0].match(prefixRegExp)) {
+      newEnv[`PLT_${prefix}_${kv[0]}`] = kv[1]
+    } else {
+      newEnv[kv[0]] = kv[1]
+    }
+  })
+  return newEnv
+}
+
+function envObjectToString (env) {
+  const output = []
+  Object.entries(env).forEach((kv) => {
+    output.push(`${kv[0]}=${kv[1]}`)
+  })
+  return output.join('\n')
+}
+
+function extractEnvVariablesFromText (text) {
+  const match = text.match(/\{[a-zA-Z0-9-_]*\}/g)
+  if (match) {
+    return match
+      .map((found) => found.replace('{', '').replace('}', ''))
+      .filter((found) => found !== '')
+  }
+  return []
+}
+
+module.exports = {
+  addPrefixToEnv,
+  convertServiceNameToPrefix,
+  envObjectToString,
+  extractEnvVariablesFromText,
+  safeMkdir,
+  stripVersion
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@platformatic/generators",
+  "version": "1.13.0",
+  "description": "Main classes and utils for generators.",
+  "main": "index.js",
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@fastify/error": "^3.4.1",
+    "boring-name-generator": "^1.0.3",
+    "fastify": "^4.24.3",
+    "pino": "^8.16.1"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^9.0.7",
+    "c8": "^8.0.1",
+    "glob": "^10.3.10",
+    "snazzy": "^9.0.0",
+    "standard": "^17.1.0",
+    "typescript": "^5.2.2"
+  },
+  "scripts": {
+    "lint": "standard | snazzy",
+    "test": "pnpm run lint && c8 --100 -x fixtures -x test node ./test/runner.js"
+  }
+}