@platformatic/generators 3.0.0 → 3.0.2

package/index.d.ts

@@ -1,2 +1,160 @@
-export * from './lib/base-generator'
-export * from './lib/file-generator'
+import { BaseLogger } from 'pino'
+
+export type EnvVarValue = string | number | boolean
+
+export type Env = {
+  [key: string]: EnvVarValue
+}
+
+export type KeyValue = {
+  [key: string]: string | number | undefined | null | boolean | object
+}
+
+export type JSONValue = string | number | boolean | { [x: string]: JSONValue } | object | Array<JSONValue>
+
+export type Dependency = {
+  [key: string]: string
+}
+
+export type WhereClause = {
+  before?: string
+  after?: string
+}
+
+export type GeneratorMetadata = {
+  targetDirectory: string
+  env: KeyValue
+}
+
+export type ConfigFieldDefinition = {
+  label: string
+  var: string
+  default: string
+  type: 'number' | 'string' | 'boolean' | 'path'
+  configValue?: string
+}
+
+export type ConfigField = {
+  var: string
+  configValue?: string
+  value: string
+}
+
+export type AddEnvVarOptions = {
+  overwrite: boolean
+}
+
+export type PackageConfiguration = {
+  type: 'number' | 'string' | 'boolean' | 'path'
+  path: string
+  value: number | string | boolean
+}
+
+export type PackageDefinition = {
+  name: string
+  options: PackageConfiguration
+}
+
+export declare function stripVersion (version: string): string
+export declare function convertApplicationNameToPrefix (applicationName: string): string
+export declare function addPrefixToServiceName (applicationName: string, prefix: string): string
+export declare function envObjectToString (env: Env): string
+export declare function envStringToObject (env: string): Env
+export declare function extractEnvVariablesFromText (text: string): string[]
+export declare function getPackageConfigurationObject (config: PackageConfiguration[]): object
+export declare function flattenObject (obj: object): object
+export declare function getApplicationTemplateFromSchemaUrl (schemaUrl: string): string
+export declare const PLT_ROOT: string
+
+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
+}
+
+export type BaseGeneratorOptions = FileGeneratorOptions & {
+  module: string
+  inquirer?: object
+}
+
+export type BaseGeneratorConfig = Record<string, any> & {
+  port?: number
+  hostname?: string
+  plugin?: boolean
+  dependencies?: Dependency
+  devDependencies?: Dependency
+  typescript?: boolean
+  initGitRepository?: boolean
+  env?: KeyValue
+  isRuntimeContext?: boolean
+  applicationName?: string
+  envPrefix?: string
+}
+
+export class BaseGenerator extends FileGenerator {
+  logger: BaseLogger
+  platformaticVersion: string
+  fastifyVersion: string
+
+  config: BaseGeneratorConfig
+  questions: Array<object>
+
+  packages: PackageConfiguration[]
+  constructor (opts?: BaseGeneratorOptions)
+
+  setConfig (config?: BaseGeneratorConfig): void
+
+  getEnvVarName (envVarName: string): string
+  addEnvVars (envVars: Env, opts: AddEnvVarOptions): void
+  addEnvVar (envVarName: string, envVarValue: EnvVarValue, opts: AddEnvVarOptions): void
+  getEnvVar (envVarName: string): EnvVarValue
+  setEnvVars (env?: Env): void
+
+  getDefaultConfig (): { [x: string]: JSONValue }
+
+  getFastifyVersion (): Promise<string>
+  getPlatformaticVersion (): Promise<string>
+
+  addPackage (pkg: PackageDefinition): Promise<void>
+
+  loadFromDir (dir: string): Promise<void>
+  prepare (): Promise<GeneratorMetadata>
+  run (): Promise<GeneratorMetadata>
+  addQuestion (question: any, where?: WhereClause): Promise<void>
+  removeQuestion (variableName: string): void
+  getTSConfig (): { [x: string]: JSONValue }
+
+  getConfigFieldsDefinitions (): ConfigFieldDefinition[]
+  setConfigFields (fields: ConfigField[]): void
+
+  generateConfigFile (): Promise<void>
+  readPackageJsonFile (): Promise<JSONValue>
+  generatePackageJson (): Promise<{ [x: string]: JSONValue }>
+  getConfigFileName (): string
+  checkEnvVariablesInConfigFile (): boolean
+  _beforePrepare (): Promise<void>
+  _afterPrepare (): Promise<void | JSONValue>
+  _getConfigFileContents (): Promise<{ [x: string]: JSONValue }>
+
+  postInstallActions (): Promise<void>
+}

package/index.test-d.ts

@@ -1,7 +1,7 @@
 import { expectAssignable } from 'tsd'
-import { BaseGenerator } from './lib/base-generator'
+import { ConfigField, ConfigFieldDefinition } from './index.js'
 
-expectAssignable<BaseGenerator.ConfigFieldDefinition>({
+expectAssignable<ConfigFieldDefinition>({
   label: 'PLT_TESTING',
   var: 'testing',
   default: 'hello world',
@@ -9,7 +9,7 @@ expectAssignable<BaseGenerator.ConfigFieldDefinition>({
   configValue: 'someConfigValue'
 })
 
-expectAssignable<BaseGenerator.ConfigField>({
+expectAssignable<ConfigField>({
   var: 'testing',
   configValue: 'someConfigValue',
   value: 'asd123'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "type": "module",
@@ -23,7 +23,7 @@
     "fastify": "^5.0.0",
     "pino": "^9.9.0",
     "undici": "^7.0.0",
-    "@platformatic/foundation": "3.0.0"
+    "@platformatic/foundation": "3.0.2"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "esnext",
+    "esModuleInterop": true,
+    "lib": ["es2022"],
+    "target": "esnext",
+    "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"]
+  }
+}

package/lib/base-generator.d.ts

@@ -1,122 +0,0 @@
-import { BaseLogger } from 'pino'
-import { FileGenerator } from './file-generator'
-import { PackageConfiguration } from './utils'
-export namespace BaseGenerator {
-  export type BaseGeneratorOptions = FileGenerator.FileGeneratorOptions & {
-    module: string
-    inquirer?: object
-  }
-
-  export type EnvVarValue = string | number | boolean
-  export type Env = {
-    [key: string]: EnvVarValue
-  }
-  type KeyValue = {
-    [key: string]: string | number | undefined | null | boolean | object
-  }
-  type JSONValue =
-    | string
-    | number
-    | boolean
-    | { [x: string]: JSONValue }
-    | object
-    | Array<JSONValue>
-
-  type Dependency = {
-    [key: string]: string
-  }
-
-  type PackageDefinition = {
-    name: string,
-    options: PackageConfiguration
-  }
-  type BaseGeneratorConfig = Record<string, any> & {
-    port?: number
-    hostname?: string
-    plugin?: boolean
-    dependencies?: Dependency
-    devDependencies?: Dependency
-    typescript?: boolean
-    initGitRepository?: boolean
-    env?: KeyValue,
-    isRuntimeContext?: boolean,
-    applicationName?: string,
-    envPrefix?: string
-  }
-
-  type WhereClause = {
-    before?: string
-    after?: string
-  }
-
-  type GeneratorMetadata = {
-    targetDirectory: string
-    env: KeyValue
-  }
-
-  type ConfigFieldDefinition = {
-    label: string
-    var: string
-    default: string
-    type: 'number' | 'string' | 'boolean' | 'path'
-    configValue?: string
-  }
-
-  type ConfigField = {
-    var: string
-    configValue?: string
-    value: string
-  }
-
-  type AddEnvVarOptions = {
-    overwrite: boolean
-  }
-
-  export class BaseGenerator extends FileGenerator.FileGenerator {
-    logger: BaseLogger
-    platformaticVersion: string
-    fastifyVersion: string
-
-    config: BaseGeneratorConfig
-    questions: Array<object>
-
-    packages: PackageConfiguration[]
-    constructor (opts?: BaseGeneratorOptions)
-
-    setConfig (config?: BaseGeneratorConfig): void
-
-    getEnvVarName (envVarName: string): string
-    addEnvVars (envVars: Env, opts: AddEnvVarOptions): void
-    addEnvVar (envVarName: string, envVarValue: EnvVarValue, opts: AddEnvVarOptions): void
-    getEnvVar (envVarName: string): EnvVarValue
-    setEnvVars (env?: Env): void
-
-    getDefaultConfig (): { [x: string]: JSONValue }
-
-    getFastifyVersion (): Promise<string>
-    getPlatformaticVersion (): Promise<string>
-
-    addPackage (pkg: PackageDefinition): Promise<void>
-
-    loadFromDir (dir: string): Promise<void>
-    prepare (): Promise<GeneratorMetadata>
-    run (): Promise<GeneratorMetadata>
-    addQuestion (question: any, where?: WhereClause): Promise<void>
-    removeQuestion (variableName: string): void
-    getTSConfig (): { [x: string]: JSONValue }
-
-    getConfigFieldsDefinitions (): ConfigFieldDefinition[]
-    setConfigFields (fields: ConfigField[]): void
-
-    generateConfigFile (): Promise<void>
-    readPackageJsonFile (): Promise<JSONValue>
-    generatePackageJson (): Promise<{ [x: string]: JSONValue }>
-    getConfigFileName (): string
-    checkEnvVariablesInConfigFile (): boolean
-    _beforePrepare (): Promise<void>
-    _afterPrepare (): Promise<void | JSONValue>
-    _getConfigFileContents (): Promise<{ [x: string]: BaseGenerator.JSONValue }>
-
-    postInstallActions (): Promise<void>
-  }
-}

package/lib/file-generator.d.ts

@@ -1,30 +0,0 @@
-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
-    loadFile (): Promise<FileObject>
-    getFileObject (file: string, path?: string): FileObject
-  }
-
-}

package/lib/utils.d.ts

@@ -1,22 +0,0 @@
-type Env = {
-  [key: string]: string
-}
-
-export type PackageConfiguration = {
-  type: 'number' | 'string' | 'boolean' | 'path'
-  path: string
-  value: number | string | boolean
-}
-
-export namespace GeneratorUtils {
-  export function stripVersion (version: string): string
-  export function convertApplicationNameToPrefix (applicationName: string): string
-  export function addPrefixToServiceName (applicationName: string, prefix: 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 getApplicationTemplateFromSchemaUrl (schemaUrl: string): string
-  export const PLT_ROOT: string
-}