create-platformatic 0.12.1 → 0.13.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.12.1",
+  "version": "0.13.1",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -24,18 +24,18 @@
     "inquirer": "^9.1.4",
     "log-update": "^5.0.1",
     "minimist": "^1.2.7",
-    "mkdirp": "^1.0.4",
+    "mkdirp": "^2.0.0",
     "ora": "^6.1.2",
     "pino": "^8.8.0",
     "pino-pretty": "^9.1.1",
     "pupa": "^3.1.0",
+    "semver": "^7.3.8",
     "undici": "^5.14.0"
   },
   "devDependencies": {
     "c8": "^7.12.0",
     "dotenv": "^16.0.3",
     "esmock": "^2.1.0",
-    "semver": "^7.3.8",
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.3.2",

package/src/create-gitignore.mjs

@@ -9,6 +9,10 @@ dist
 # dotenv environment variable files
 .env
 
+# database files
+*.sqlite
+*.sqlite3
+
 # Logs
 logs
 *.log

package/src/index.mjs

@@ -5,7 +5,7 @@ import inquirer from 'inquirer'
 import createPlatformaticDB from './db/create-db-cli.mjs'
 import createPlatformaticService from './service/create-service-cli.mjs'
 import commist from 'commist'
-import { getUsername, getVersion } from './utils.mjs'
+import { getUsername, getVersion, getSupportedNodeVersions, isCurrentVersionSupported } from './utils.mjs'
 
 const createPlatformatic = async (argv) => {
   const help = helpMe({
@@ -30,6 +30,14 @@ const createPlatformatic = async (argv) => {
     await say(`${greeting} welcome to ${version ? `Platformatic ${version}!` : 'Platformatic!'}`)
     await say('Let\'s start by creating a new project.')
 
+    const currentVersion = process.versions.node
+    const supported = isCurrentVersionSupported(currentVersion)
+    if (!supported) {
+      const supportedVersions = getSupportedNodeVersions().join(' or >= ')
+      await say(`Platformatic is not supported on Node.js v${currentVersion}.`)
+      await say(`Please use one of the following Node.js versions >= ${supportedVersions}.`)
+    }
+
     const options = await inquirer.prompt({
       type: 'list',
       name: 'type',

package/src/utils.mjs

@@ -3,6 +3,7 @@ import { request } from 'undici'
 import { access, constants, readFile } from 'fs/promises'
 import { resolve, join, dirname } from 'path'
 import { createRequire } from 'module'
+import semver from 'semver'
 
 export const sleep = ms => new Promise((resolve) => setTimeout(resolve, ms))
 export const randomBetween = (min, max) => Math.floor(Math.random() * (max - min + 1) + min)
@@ -18,16 +19,23 @@ export async function isFileAccessible (filename, directory) {
 }
 
 export const getUsername = async () => {
-  const { stdout } = await execa('git', ['config', 'user.name'])
-  if (stdout?.trim()) {
-    return stdout.trim()
+  try {
+    const { stdout } = await execa('git', ['config', 'user.name'])
+    if (stdout?.trim()) {
+      return stdout.trim()
+    }
+  } catch (err) {
+  // ignore: git failed
   }
-  {
+  try {
     const { stdout } = await execa('whoami')
     if (stdout?.trim()) {
       return stdout.trim()
     }
+  } catch (err) {
+  // ignore: whoami failed
   }
+
   return null
 }
 
@@ -93,3 +101,19 @@ export const getDependencyVersion = async (dependencyName) => {
   const packageJson = JSON.parse(packageJsonFile)
   return packageJson.version
 }
+
+export const getSupportedNodeVersions = () => {
+  return ['16.17.0', '18.8.0', '19.0.0']
+}
+
+export const isCurrentVersionSupported = (currentVersion) => {
+  const supportedVersions = getSupportedNodeVersions()
+  for (const version of supportedVersions) {
+    if (semver.gt(currentVersion, version)) { continue }
+    if (semver.lt(currentVersion, version)) {
+      return false
+    }
+    break
+  }
+  return true
+}

package/test/utils.test.mjs

@@ -1,6 +1,6 @@
 import { test, beforeEach } from 'tap'
 import { MockAgent, setGlobalDispatcher } from 'undici'
-import { getVersion, randomBetween, sleep, validatePath, getDependencyVersion, findDBConfigFile, findServiceConfigFile, isFileAccessible } from '../src/utils.mjs'
+import { getVersion, randomBetween, sleep, validatePath, getDependencyVersion, findDBConfigFile, findServiceConfigFile, isFileAccessible, isCurrentVersionSupported, getSupportedNodeVersions } from '../src/utils.mjs'
 import { mkdtempSync, rmSync, writeFileSync } from 'fs'
 import { tmpdir } from 'os'
 import { join } from 'path'
@@ -47,6 +47,45 @@ test('getUsername from whoami', async ({ end, equal }) => {
   equal(username, name)
 })
 
+test('if getUsername from git failed, it tries whoim', async ({ end, equal }) => {
+  const name = 'lukeskywalker'
+
+  const { getUsername } = await esmock.strict('../src/utils.mjs', {
+    execa: {
+      execa: (command) => {
+        if (command === 'git') {
+          throw new Error('git failed')
+        }
+        if (command === 'whoami') {
+          return { stdout: name }
+        }
+
+        return ''
+      }
+    }
+  })
+  const username = await getUsername()
+  equal(username, name)
+})
+
+test('if both git usern.ame and whoami fail, no username is set', async ({ end, equal }) => {
+  const { getUsername } = await esmock.strict('../src/utils.mjs', {
+    execa: {
+      execa: (command) => {
+        if (command === 'git') {
+          throw new Error('git failed')
+        }
+        if (command === 'whoami') {
+          throw new Error('whoami failed')
+        }
+        return ''
+      }
+    }
+  })
+  const username = await getUsername()
+  equal(username, null)
+})
+
 test('getUsername - no username found', async ({ end, equal }) => {
   const { getUsername } = await esmock.strict('../src/utils.mjs', {
     execa: {
@@ -180,3 +219,30 @@ test('isFileAccessible', async ({ end, equal, mock }) => {
   equal(await isFileAccessible(config2), false)
   rmSync(tmpDir1, { recursive: true, force: true })
 })
+
+test('getSupportedNodeVersions', async ({ equal, not }) => {
+  const supportedVersions = getSupportedNodeVersions()
+  equal(Array.isArray(supportedVersions), true)
+  not(supportedVersions.length, 0)
+})
+
+test('isCurrentVersionSupported', async ({ equal }) => {
+  const supportedVersions = getSupportedNodeVersions()
+  const { major, minor, patch } = semver.minVersion(supportedVersions[0])
+  {
+    // major not supported
+    const nodeVersion = `${major - 1}.${minor}.${patch}`
+    const supported = isCurrentVersionSupported(nodeVersion)
+    equal(supported, false)
+  }
+  {
+    // minor not supported
+    const nodeVersion = `${major}.${minor - 1}.${patch}`
+    const supported = isCurrentVersionSupported(nodeVersion)
+    equal(supported, false)
+  }
+  for (const version of supportedVersions) {
+    const supported = isCurrentVersionSupported(version)
+    equal(supported, true)
+  }
+})