@platformatic/service 1.17.0 → 1.19.0

package/help/create.txt

@@ -0,0 +1,11 @@
+Creates a new Platformatic Service application.
+
+Options are
+
+* `dir <string>` - the directory where to create the project (Default: `process.cwd() + 'platformatic-composer'`)
+* `port <string>` - the port where the application will listen (Default: `3042`)
+* `hostname <string>` - the hostname where the application will listen (Default: `0.0.0.0`)
+* `git <boolean>` - Init the git repository (Default: `true`)
+* `typescript <boolean>` - Use Typescript (Default: `false`)
+* `install <boolean>` - Run or not `npm install` after creating the files (Default: `true`)
+* `plugin <boolean>` - Creates a sample plugin and tests (Default: `true`)

package/help/help.txt

@@ -1,5 +1,6 @@
 Available commands:
 
+* `create` - creates a new Platformatic Service application.
 * `help` - show this help message.
 * `help <command>` - show more information about a command.
 * `start` - start the server.

package/lib/create.mjs

@@ -0,0 +1,85 @@
+'use strict'
+import minimist from 'minimist'
+import { Generator } from '../lib/generator/service-generator.js'
+import { join } from 'node:path'
+import { getPkgManager } from '@platformatic/utils'
+import { execa } from 'execa'
+import ora from 'ora'
+import { Table } from 'console-table-printer'
+import pino from 'pino'
+import pinoPretty from 'pino-pretty'
+
+function printAppSummary (args, logger) {
+  logger.info('Creating a Platformatic Service app with this config: ')
+  const table = [
+    { config: 'Directory', value: args.dir },
+    { config: 'Language', value: args.typescript ? 'Typescript' : 'Javascript' },
+    { config: 'Init Git Repository', value: args.git },
+    { config: 'Install Dependencies', value: args.install },
+    { config: 'Sample Plugin and Tests', value: args.plugin }
+  ]
+
+  const p = new Table({
+    columns: [
+      { name: 'config', alignment: 'right' },
+      { name: 'value', alignment: 'left' }
+    ]
+  })
+
+  p.addRows(table)
+  p.printTable()
+}
+async function createService (_args) {
+  const stream = pinoPretty({
+    translateTime: 'SYS:HH:MM:ss',
+    ignore: 'hostname,pid',
+    minimumLevel: 'debug',
+    sync: true
+  })
+
+  const logger = pino(stream)
+
+  const args = minimist(process.argv.slice(2), {
+    string: ['dir', 'port', 'hostname'],
+    boolean: ['typescript', 'install', 'plugin', 'git'],
+    default: {
+      dir: join(process.cwd(), 'platformatic-service'),
+      port: 3042,
+      hostname: '0.0.0.0',
+      plugin: true,
+      typescript: false,
+      git: false,
+      install: true
+    }
+
+  })
+
+  printAppSummary(args, logger)
+
+  const gen = new Generator({})
+  gen.setConfig({
+    port: args.port,
+    hostname: args.hostname,
+    plugin: args.plugin,
+    tests: args.plugin,
+    typescript: args.typescript,
+    initGitRepository: args.git,
+    targetDirectory: args.dir
+  })
+
+  try {
+    await gen.run()
+    if (args.install) {
+      const pkgManager = getPkgManager()
+      const spinner = ora('Installing dependencies...').start()
+      await execa(pkgManager, ['install'], { cwd: args.dir })
+      spinner.succeed()
+    }
+
+    logger.info('Done! 🎉')
+  } catch (err) {
+    logger.error(err.message)
+  }
+}
+
+export { createService }

package/lib/plugins/openapi.js

@@ -58,8 +58,14 @@ async function setupOpenAPI (app, opts) {
   const routePrefix = openapi.swaggerPrefix || '/documentation'
 
   /** Serve spec file in yaml and json */
-  app.get(`${routePrefix}/json`, { schema: { hide: true } }, async () => app.swagger())
-  app.get(`${routePrefix}/yaml`, { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+  app.get(`${routePrefix}/json`, {
+    schema: { hide: true },
+    logLevel: 'warn'
+  }, async () => app.swagger())
+  app.get(`${routePrefix}/yaml`, {
+    schema: { hide: true },
+    logLevel: 'warn'
+  }, async () => app.swagger({ yaml: true }))
 
   app.register(ScalarApiReference, {
     ...opts,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -58,6 +58,7 @@
     "code-block-writer": "^12.0.0",
     "colorette": "^2.0.20",
     "commist": "^3.2.0",
+    "console-table-printer": "^2.11.2",
     "desm": "^1.3.0",
     "env-schema": "^5.2.0",
     "es-main": "^1.3.0",
@@ -71,19 +72,20 @@
     "mercurius": "^13.1.0",
     "minimist": "^1.2.8",
     "openapi-schema-diff": "^0.0.1",
+    "ora": "^6.3.1",
     "pino": "^8.15.3",
     "pino-pretty": "^10.2.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.36",
     "undici": "^6.0.0",
-    "@platformatic/authenticate": "1.17.0",
-    "@platformatic/client": "1.17.0",
-    "@platformatic/config": "1.17.0",
-    "@platformatic/generators": "1.17.0",
-    "@platformatic/metaconfig": "1.17.0",
-    "@platformatic/scalar-theme": "1.17.0",
-    "@platformatic/telemetry": "1.17.0",
-    "@platformatic/utils": "1.17.0"
+    "@platformatic/authenticate": "1.19.0",
+    "@platformatic/client": "1.19.0",
+    "@platformatic/config": "1.19.0",
+    "@platformatic/generators": "1.19.0",
+    "@platformatic/scalar-theme": "1.19.0",
+    "@platformatic/telemetry": "1.19.0",
+    "@platformatic/utils": "1.19.0",
+    "@platformatic/metaconfig": "1.19.0"
   },
   "standard": {
     "ignore": [

package/service.mjs

@@ -11,7 +11,7 @@ import { generateJsonSchemaConfig } from './lib/gen-schema.js'
 import { bumpVersion } from './lib/bump-version.js'
 import { updateVersion } from './lib/update-version.js'
 import { generateTypes } from './lib/gen-types.mjs'
-
+import { createService } from './lib/create.mjs'
 import { buildCompileCmd } from './lib/compile.js'
 
 import { start, platformaticService } from './index.js'
@@ -43,6 +43,7 @@ program.register('start', (argv) => {
   start(platformaticService, argv).catch(printAndExitLoadConfigError)
 })
 
+program.register('create', wrapCommand(createService))
 program.register('compile', buildCompileCmd(platformaticService))
 program.register('types', wrapCommand(generateTypes))
 program.register('schema config', wrapCommand(generateJsonSchemaConfig))