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

package/lib/file-generator.d.ts

@@ -4,27 +4,27 @@ 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
-    loadFile(): Promise<FileObject>
-    getFileObject(file: string, path?: string): FileObject
+
+    constructor (opts?: FileGeneratorOptions)
+
+    setTargetDirectory (dir: string): void
+    addFile (file: FileObject): void
+    appendfile (file: FileObject): void
+    reset (): void
+    writeFiles (): Promise<void>
+    listFiles (): FileObject
+    loadFile (): Promise<FileObject>
+    getFileObject (file: string, path?: string): FileObject
   }
-  
+
 }

package/lib/file-generator.js

@@ -1,5 +1,5 @@
 'use strict'
-const { safeMkdir } = require('./utils')
+const { createDirectory } = require('@platformatic/utils')
 const { join } = require('node:path')
 const { writeFile, readFile } = require('node:fs/promises')
 
@@ -9,7 +9,7 @@ const fakeLogger = {
   warn: () => {},
   debug: () => {},
   trace: () => {},
-  error: () => {}
+  error: () => {},
 }
 /* c8 ignore start */
 
@@ -59,14 +59,14 @@ class FileGenerator {
     if (!this.targetDirectory) {
       throw new Error('No target directory set.')
     }
-    await safeMkdir(this.targetDirectory)
+    await createDirectory(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)
+        await createDirectory(baseDir)
       }
       const fullFilePath = join(baseDir, fileToWrite.file)
       await writeFile(fullFilePath, fileToWrite.contents, fileToWrite.options)

package/lib/stackable-generator.js

@@ -18,7 +18,7 @@ const fakeLogger = {
   warn: () => {},
   debug: () => {},
   trace: () => {},
-  error: () => {}
+  error: () => {},
 }
 /* c8 ignore start */
 
@@ -41,7 +41,7 @@ class StackableGenerator extends FileGenerator {
       typescript: false,
       initGitRepository: false,
       dependencies: {},
-      devDependencies: {}
+      devDependencies: {},
     }
   }
 
@@ -59,7 +59,7 @@ class StackableGenerator extends FileGenerator {
     this.config = {
       ...this.getDefaultConfig(),
       ...oldConfig,
-      ...config
+      ...config,
     }
 
     if (this.config.targetDirectory) {
@@ -74,7 +74,7 @@ class StackableGenerator extends FileGenerator {
       const newConfig = await this.inquirer.prompt(this.questions)
       this.setConfig({
         ...this.config,
-        ...newConfig
+        ...newConfig,
       })
     }
   }
@@ -92,7 +92,7 @@ class StackableGenerator extends FileGenerator {
       this.addFile({
         path: '',
         file: 'package.json',
-        contents: JSON.stringify(template, null, 2)
+        contents: JSON.stringify(template, null, 2),
       })
 
       if (this.config.typescript) {
@@ -100,7 +100,7 @@ class StackableGenerator extends FileGenerator {
         this.addFile({
           path: '',
           file: 'tsconfig.json',
-          contents: JSON.stringify(this.getTsConfig(), null, 2)
+          contents: JSON.stringify(this.getTsConfig(), null, 2),
         })
       }
 
@@ -116,7 +116,7 @@ class StackableGenerator extends FileGenerator {
       await this._afterPrepare()
 
       return {
-        targetDirectory: this.targetDirectory
+        targetDirectory: this.targetDirectory,
       }
     } catch (err) {
       if (err.code?.startsWith('PLT_GEN')) {
@@ -140,15 +140,15 @@ class StackableGenerator extends FileGenerator {
         noEmitOnError: true,
         incremental: true,
         strict: true,
-        outDir: 'dist'
+        outDir: 'dist',
       },
       watchOptions: {
         watchFile: 'fixedPollingInterval',
         watchDirectory: 'fixedPollingInterval',
         fallbackPolling: 'dynamicPriority',
         synchronousWatchDirectory: true,
-        excludeDirectories: ['**/node_modules', 'dist']
-      }
+        excludeDirectories: ['**/node_modules', 'dist'],
+      },
     }
   }
 
@@ -159,7 +159,7 @@ class StackableGenerator extends FileGenerator {
         type: 'input',
         name: 'targetDirectory',
         message: 'Where would you like to create your project?',
-        default: 'platformatic'
+        default: 'platformatic',
       })
     }
 
@@ -167,7 +167,7 @@ class StackableGenerator extends FileGenerator {
       type: 'input',
       name: 'stackableName',
       message: 'What is the name of the stackable?',
-      default: 'my-stackable'
+      default: 'my-stackable',
     })
 
     // typescript
@@ -176,7 +176,7 @@ class StackableGenerator extends FileGenerator {
       name: 'typescript',
       message: 'Do you want to use TypeScript?',
       default: false,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }],
     })
   }
 
@@ -207,12 +207,12 @@ class StackableGenerator extends FileGenerator {
     const dependencies = {
       '@platformatic/config': `^${this.platformaticVersion}`,
       '@platformatic/service': `^${this.platformaticVersion}`,
-      'json-schema-to-typescript': '^13.0.0'
+      'json-schema-to-typescript': '^13.0.0',
     }
 
     const devDependencies = {
       borp: '^0.10.0',
-      fastify: `^${this.fastifyVersion}`
+      fastify: `^${this.fastifyVersion}`,
     }
 
     const npmPackageName = kebabCase(this.config.stackableName)
@@ -229,7 +229,7 @@ class StackableGenerator extends FileGenerator {
         main: 'dist/index.js',
         bin: {
           [createStackableCommand]: './dist/cli/create.js',
-          [startStackableCommand]: './dist/cli/start.js'
+          [startStackableCommand]: './dist/cli/start.js',
         },
         scripts: {
           build: 'tsc --build',
@@ -237,21 +237,21 @@ class StackableGenerator extends FileGenerator {
           'gen-types': 'json2ts > config.d.ts < schema.json',
           'build:config': 'pnpm run gen-schema && pnpm run gen-types',
           clean: 'rm -fr ./dist',
-          test: 'borp'
+          test: 'borp',
         },
         engines: {
-          node: '^18.8.0 || >=20.6.0'
+          node: '^18.8.0 || >=20.6.0',
         },
         devDependencies: {
           ...devDependencies,
           typescript: typescriptVersion,
-          ...this.config.devDependencies
+          ...this.config.devDependencies,
         },
         dependencies: {
           ...dependencies,
           '@platformatic/generators': `^${this.platformaticVersion}`,
-          ...this.config.dependencies
-        }
+          ...this.config.dependencies,
+        },
       }
     }
 
@@ -261,7 +261,7 @@ class StackableGenerator extends FileGenerator {
       main: 'index.js',
       bin: {
         [createStackableCommand]: './cli/create.js',
-        [startStackableCommand]: './cli/start.js'
+        [startStackableCommand]: './cli/start.js',
       },
       scripts: {
         'gen-schema': 'node lib/schema.js > schema.json',
@@ -269,20 +269,20 @@ class StackableGenerator extends FileGenerator {
         'build:config': 'pnpm run gen-schema && pnpm run gen-types',
         prepublishOnly: 'pnpm run build:config',
         lint: 'standard',
-        test: 'borp'
+        test: 'borp',
       },
       engines: {
-        node: '^18.8.0 || >=20.6.0'
+        node: '^18.8.0 || >=20.6.0',
       },
       devDependencies: {
         ...devDependencies,
         standard: '^17.0.0',
-        ...this.config.devDependencies
+        ...this.config.devDependencies,
       },
       dependencies: {
         ...dependencies,
-        ...this.config.dependencies
-      }
+        ...this.config.dependencies,
+      },
     }
   }
 

package/lib/utils.d.ts

@@ -9,14 +9,13 @@ export type PackageConfiguration = {
 }
 
 export namespace GeneratorUtils {
-  export function safeMkdir(dir: string): Promise<void>
-  export function stripVersion(version: string): string
-  export function convertServiceNameToPrefix(serviceName: string): string
-  export function envObjectToString(env: Env): string
-  export function envStringToObject(env: string): Env
-  export function extractEnvVariablesFromText(text: string): string[]
-  export function getPackageConfigurationObject(config: PackageConfiguration[]): object
-  export function flattenObject(obj: object): object
-  export function getServiceTemplateFromSchemaUrl(schemaUrl: string): string
+  export function stripVersion (version: string): string
+  export function convertServiceNameToPrefix (serviceName: string): string
+  export function envObjectToString (env: Env): string
+  export function envStringToObject (env: string): Env
+  export function extractEnvVariablesFromText (text: string): string[]
+  export function getPackageConfigurationObject (config: PackageConfiguration[]): object
+  export function flattenObject (obj: object): object
+  export function getServiceTemplateFromSchemaUrl (schemaUrl: string): string
   export const PLT_ROOT: string
 }

package/lib/utils.js

@@ -1,20 +1,12 @@
 'use strict'
 
-const { mkdir } = require('node:fs/promises')
 const { WrongTypeError } = require('./errors')
 const { join } = require('node:path')
 const { request } = require('undici')
 const { setTimeout } = require('timers/promises')
 const PLT_ROOT = 'PLT_ROOT'
 const { EOL } = require('node:os')
-async function safeMkdir (dir) {
-  try {
-    await mkdir(dir, { recursive: true })
-    /* c8 ignore next 3 */
-  } catch (err) {
-    // do nothing
-  }
-}
+const { createDirectory } = require('@platformatic/utils')
 
 /**
  * Strip all extra characters from a simple semver version string
@@ -49,7 +41,7 @@ function addPrefixToString (input, prefix) {
 
 function envObjectToString (env) {
   const output = []
-  Object.entries(env).forEach((kv) => {
+  Object.entries(env).forEach(kv => {
     output.push(`${kv[0]}=${kv[1]}`)
   })
   return output.join(EOL)
@@ -57,12 +49,12 @@ function envObjectToString (env) {
 
 function envStringToObject (envString) {
   const output = {}
-  const split = envString.split(EOL)
+  const split = envString.split(/\r?\n/)
   split
-    .filter((line) => {
+    .filter(line => {
       return line.trim() !== '' && line.indexOf('#') !== 0
     })
-    .forEach((line) => {
+    .forEach(line => {
       const kv = line.split('=')
       output[kv[0]] = kv[1]
     })
@@ -71,16 +63,14 @@ function envStringToObject (envString) {
 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 match.map(found => found.replace('{', '').replace('}', '')).filter(found => found !== '')
   }
   return []
 }
 function getPackageConfigurationObject (config, serviceName = '') {
   const output = {
     config: {},
-    env: {}
+    env: {},
   }
   let current = output.config
   for (const param of config) {
@@ -90,14 +80,14 @@ function getPackageConfigurationObject (config, serviceName = '') {
         let value
         let isPath = false
         switch (param.type) {
-          case 'string' :
+          case 'string':
             value = param.value.toString()
             break
           case 'number':
             value = parseInt(param.value)
             break
           case 'boolean':
-            value = (param.value === 'true')
+            value = param.value === 'true'
             break
           case 'path':
             value = `${join(`{${PLT_ROOT}}`, param.value)}`
@@ -167,7 +157,7 @@ async function getLatestNpmVersion (pkg) {
 function flattenObject (ob) {
   const result = {}
   for (const i in ob) {
-    if ((typeof ob[i]) === 'object' && !Array.isArray(ob[i])) {
+    if (typeof ob[i] === 'object' && !Array.isArray(ob[i])) {
       const temp = flattenObject(ob[i])
       for (const j in temp) {
         result[i + '.' + j] = temp[j]
@@ -181,8 +171,13 @@ function flattenObject (ob) {
 
 function getServiceTemplateFromSchemaUrl (schemaUrl) {
   const splitted = schemaUrl.split('/')
-  return `@platformatic/${splitted[splitted.length - 1]}`
+
+  if (schemaUrl.startsWith('https://platformatic.dev/schemas')) {
+    return `@platformatic/${splitted[splitted.length - 1]}`
+  }
+  return `@platformatic/${splitted[splitted.length - 2]}`
 }
+
 module.exports = {
   addPrefixToString,
   convertServiceNameToPrefix,
@@ -192,8 +187,8 @@ module.exports = {
   extractEnvVariablesFromText,
   flattenObject,
   getServiceTemplateFromSchemaUrl,
-  safeMkdir,
+  createDirectory,
   stripVersion,
   PLT_ROOT,
-  getLatestNpmVersion
+  getLatestNpmVersion,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -12,19 +12,20 @@
     "change-case-all": "^2.1.0",
     "fastify": "^4.26.2",
     "pino": "^8.19.0",
-    "undici": "^6.9.0"
+    "undici": "^6.9.0",
+    "@platformatic/utils": "2.0.0-alpha.3"
   },
   "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"
   }
 }