create-platformatic 1.17.0 → 1.18.0

package/src/create-git-repository.mjs

@@ -1,105 +0,0 @@
-import { execa } from 'execa'
-
-export const GIT_FIRST_COMMIT_MESSAGE = 'Platformatic project started! 🚀'
-export const GIT_MAIN_BRANCH = 'main'
-
-/**
- * Creates a Git repository and performs the initial commit if it doesn't already exist.
- *
- * This function checks if Git is installed, initializes a Git repository in the specified
- * directory if it's not already a Git repository, and performs the initial commit.
- *
- * @param {import('pino.').BaseLogger} logger - The logger interface for logging messages.
- * @param {string} [dir='.'] - The target directory where the Git repository should be created.
- */
-export async function createGitRepository (logger, dir = '.') {
-  if (!await isGitInstalled()) {
-    logger.error('Git is not installed')
-    return
-  }
-
-  if (!await gitInit(logger, dir)) {
-    return
-  }
-
-  if (!await gitCommit(logger, dir)) {
-    return
-  }
-
-  logger.info('Git repository initialized.')
-}
-
-/**
- * Checks if Git is installed on the system.
- *
- * @async
- * @returns {Promise<boolean>} A Promise that resolves to true if Git is installed, false otherwise.
- */
-async function isGitInstalled () {
-  try {
-    await execa('git', ['--version'])
-    return true
-  } catch (err) {
-    return false
-  }
-}
-
-/**
- * Checks if a Git repository exists in the specified directory.
- *
- * @async
- * @param {string} dir - The directory to check for a Git repository.
- * @returns {Promise<boolean>} A Promise that resolves to true if a Git repository exists in the directory, false otherwise.
- */
-async function doesGitRepositoryExist (dir) {
-  try {
-    await execa('git', ['rev-parse', '--is-inside-work-tree'], { cwd: dir })
-    return true
-  } catch (e) {
-    return false
-  }
-}
-
-/**
- * Initializes a Git repository in the specified directory if it doesn't already exist.
- *
- * @async
- * @param {import('pino.').BaseLogger} - The logger object for logging messages.
- * @param {string} dir - The directory where the Git repository should be initialized.
- * @returns {Promise<boolean>} A Promise that resolves to true if the Git repository is successfully initialized, false otherwise.
- */
-async function gitInit (logger, dir) {
-  try {
-    if (await doesGitRepositoryExist(dir)) {
-      logger.info('Git repository already exists.')
-      return false
-    }
-
-    await execa('git', ['init', '-b', GIT_MAIN_BRANCH], { cwd: dir })
-    logger.debug('Git repository initialized.')
-    return true
-  } catch (err) {
-    logger.error('Git repository init failed.', err)
-    return false
-  }
-}
-
-/**
- * Commits changes in a Git repository located in the specified directory.
- *
- * @async
- * @param {import('pino.').BaseLogger} - The logger object for logging messages.
- * @param {string} dir - The directory of the Git repository where changes should be committed.
- * @returns {Promise<boolean>} A Promise that resolves to true if the Git commit is successful, false otherwise.
- */
-async function gitCommit (logger, dir) {
-  try {
-    await execa('git', ['add', '-A'], { cwd: dir })
-    await execa('git', ['commit', '-m', GIT_FIRST_COMMIT_MESSAGE], { cwd: dir })
-    logger.debug('Git commit done.')
-    return true
-  } catch (err) {
-    logger.error('Git commit failed.', err)
-    return false
-  }
-}

package/src/create-gitignore.mjs

@@ -1,42 +0,0 @@
-import { writeFile } from 'fs/promises'
-import { join } from 'node:path'
-
-const gitignore = `\
-dist
-.DS_Store
-
-# dotenv environment variable files
-.env
-
-# database files
-*.sqlite
-*.sqlite3
-
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Dependency directories
-node_modules/
-
-# ctags
-tags
-
-# clinicjs
-.clinic/
-`
-/**
- * Creates a standard Platformatic app .gitignore file
- * @param {import('pino').BaseLogger} logger Logger Interface
- * @param {string} dir Target directory
- */
-export const createGitignore = async (logger, dir = '.') => {
-  const gitignoreFileName = join(dir, '.gitignore')
-  await writeFile(gitignoreFileName, gitignore)
-  logger.debug(`Gitignore file ${gitignoreFileName} successfully created.`)
-}

package/src/create-package-json.mjs

@@ -1,58 +0,0 @@
-import { writeFile, readFile } from 'fs/promises'
-import { join } from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-/**
- * Creates a package.json template file
- * @param {boolean} addTSBuild Whether to add TS Build or not
- * @param {string} fastifyVersion Fastify Version
- * @param {string} platVersion Platformatic Version
- */
-const packageJsonTemplate = async (addTSBuild, fastifyVersion, platVersion) => {
-  const __dirname = fileURLToPath(new URL('.', import.meta.url))
-
-  const pkg = {
-    scripts: {
-      start: 'platformatic start',
-      test: 'node --test test/**'
-    },
-    devDependencies: {
-      fastify: `^${fastifyVersion}`
-    },
-    dependencies: {
-      platformatic: `^${platVersion}`
-    },
-    engines: {
-      node: '^18.8.0 || >=20.6.0'
-    }
-  }
-
-  if (addTSBuild) {
-    const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', 'package.json'), 'utf-8')).devDependencies.typescript
-    pkg.scripts.clean = 'rm -fr ./dist'
-    pkg.scripts.build = 'platformatic compile'
-    pkg.devDependencies.typescript = typescriptVersion
-  }
-
-  return pkg
-}
-
-/**
- * Creates a Platformatic app package.json file
- * @param {string} platVersion Platformatic Version
- * @param {string} fastifyVersion Fastify Version
- * @param {import('pino').BaseLogger} logger Logger Interface
- * @param {string} dir Target directory where to create the file
- * @param {boolean} addTSBuild Whether to add TS Build or not
- * @param {object} scripts Package.json scripts list
- * @param {object} dependencies Package.json dependencies list
- */
-export const createPackageJson = async (platVersion, fastifyVersion, logger, dir, addTSBuild = false, scripts = {}, dependencies = {}, devDependencies = {}) => {
-  const packageJsonFileName = join(dir, 'package.json')
-  const pkg = await packageJsonTemplate(addTSBuild, fastifyVersion, platVersion)
-  Object.assign(pkg.scripts, scripts)
-  Object.assign(pkg.dependencies, dependencies)
-  Object.assign(pkg.devDependencies, devDependencies)
-  await writeFile(packageJsonFileName, JSON.stringify(pkg, null, 2))
-  logger.debug(`${packageJsonFileName} successfully created.`)
-}

package/src/create-plugins.mjs

@@ -1,220 +0,0 @@
-import { join } from 'path'
-import { writeFile } from 'fs/promises'
-import { safeMkdir } from './utils.mjs'
-
-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')
-})
-`
-
-export async function generatePluginWithTypesSupport (logger, currentDir, isTypescript) {
-  await safeMkdir(join(currentDir, 'plugins'))
-  const pluginTemplate = isTypescript
-    ? TS_PLUGIN_WITH_TYPES_SUPPORT
-    : JS_PLUGIN_WITH_TYPES_SUPPORT
-  const pluginName = isTypescript
-    ? 'example.ts'
-    : 'example.js'
-  await writeFile(join(currentDir, 'plugins', pluginName), pluginTemplate)
-  logger.info('Plugins folder "plugins" successfully created.')
-}
-
-export async function generateRouteWithTypesSupport (logger, currentDir, isTypescript) {
-  await safeMkdir(join(currentDir, 'routes'))
-  const routesTemplate = isTypescript
-    ? TS_ROUTES_WITH_TYPES_SUPPORT
-    : JS_ROUTES_WITH_TYPES_SUPPORT
-  const routesName = isTypescript
-    ? 'root.ts'
-    : 'root.js'
-  await writeFile(join(currentDir, 'routes', routesName), routesTemplate)
-  logger.info('Routes folder "routes" successfully created.')
-}
-
-export async function generateTests (logger, currentDir, isTypescript, mod, customizations) {
-  await safeMkdir(join(currentDir, 'test'))
-  await safeMkdir(join(currentDir, 'test', 'plugins'))
-  await safeMkdir(join(currentDir, 'test', 'routes'))
-
-  if (isTypescript) {
-    await writeFile(join(currentDir, 'test', 'helper.ts'), testHelperTS(mod, customizations))
-    await writeFile(join(currentDir, 'test', 'plugins', 'example.test.ts'), TEST_PLUGIN_TS)
-    await writeFile(join(currentDir, 'test', 'routes', 'root.test.ts'), TEST_ROUTES_TS)
-  } else {
-    await writeFile(join(currentDir, 'test', 'helper.js'), testHelperJS(mod, customizations))
-    await writeFile(join(currentDir, 'test', 'plugins', 'example.test.js'), TEST_PLUGIN_JS)
-    await writeFile(join(currentDir, 'test', 'routes', 'root.test.js'), TEST_ROUTES_JS)
-  }
-
-  logger.info('Test folder "tests" successfully created.')
-}
-
-export async function generatePlugins (logger, currentDir, isTypescript, mod, helperCustomization) {
-  await generatePluginWithTypesSupport(logger, currentDir, isTypescript)
-  await generateRouteWithTypesSupport(logger, currentDir, isTypescript)
-  await generateTests(logger, currentDir, isTypescript, mod, helperCustomization)
-}

package/src/create-readme.mjs

@@ -1,12 +0,0 @@
-'use strict'
-import { readFile, writeFile } from 'fs/promises'
-import { join as desmJoin } from 'desm'
-import { join } from 'path'
-
-export const createReadme = async (logger, dir = '.', type) => {
-  const readmeFileTarget = join(dir, 'README.md')
-  const readmeFileSource = desmJoin(import.meta.url, type, 'README.md')
-  const readme = await readFile(readmeFileSource, 'utf-8')
-  await writeFile(readmeFileTarget, readme)
-  logger.debug(`${readmeFileTarget} successfully created.`)
-}

package/src/db/README.md

@@ -1,38 +0,0 @@
-# Platformatic DB API
-
-This is a generated [Platformatic DB](https://docs.platformatic.dev/docs/reference/db/introduction) application.
-
-## Requirements
-
-Platformatic supports macOS, Linux and Windows ([WSL](https://docs.microsoft.com/windows/wsl/) recommended).
-You'll need to have [Node.js](https://nodejs.org/) >= v18.8.0 or >= v20.6.0
-
-## Setup
-
-1. Install dependencies:
-
-```bash
-npm install
-```
-
-2. Apply migrations:
-
-```bash
-npm run migrate
-```
-
-
-## Usage
-
-Run the API with:
-
-```bash
-npm start
-```
-
-### Explore
-- ⚡ The Platformatic DB server is running at http://localhost:3042/
-- 📔 View the REST API's Swagger documentation at http://localhost:3042/documentation/
-- 🔍 Try out the GraphiQL web UI at http://localhost:3042/graphiql
-
-