create-platformatic 0.13.1 → 0.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.13.1",
+  "version": "0.15.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -18,7 +18,7 @@
     "commist": "^3.2.0",
     "desm": "^1.3.0",
     "es-main": "^1.2.0",
-    "execa": "^6.1.0",
+    "execa": "^7.0.0",
     "fastify": "^4.10.2",
     "help-me": "^4.2.0",
     "inquirer": "^9.1.4",
@@ -42,6 +42,7 @@
     "yaml": "^2.1.3"
   },
   "scripts": {
-    "test": "standard | snazzy && NODE_OPTIONS=--loader=esmock c8 --100 tap --no-coverage test/*test.mjs test/*/*test.mjs"
+    "test": "standard | snazzy && NODE_OPTIONS=--loader=esmock c8 --100 tap --no-coverage test/*test.mjs test/*/*test.mjs",
+    "lint": "standard | snazzy"
   }
 }

package/src/create-gitignore.mjs

@@ -24,6 +24,12 @@ lerna-debug.log*
 
 # Dependency directories
 node_modules/
+
+# ctags
+tags
+
+# clinicjs
+.clinic/
 `
 
 export const createGitignore = async (logger, dir = '.') => {

package/src/ghaction.mjs

@@ -19,6 +19,9 @@ on:
 
 jobs:
   build_and_deploy:
+    permissions:
+      contents: read
+      pull-requests: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout application project repository

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, getSupportedNodeVersions, isCurrentVersionSupported } from './utils.mjs'
+import { getUsername, getVersion, minimumSupportedNodeVersions, isCurrentVersionSupported } from './utils.mjs'
 
 const createPlatformatic = async (argv) => {
   const help = helpMe({
@@ -33,7 +33,7 @@ const createPlatformatic = async (argv) => {
     const currentVersion = process.versions.node
     const supported = isCurrentVersionSupported(currentVersion)
     if (!supported) {
-      const supportedVersions = getSupportedNodeVersions().join(' or >= ')
+      const supportedVersions = minimumSupportedNodeVersions.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}.`)
     }

package/src/utils.mjs

@@ -71,10 +71,7 @@ export const validatePath = async projectPath => {
   // if the folder does not exist, check if the parent folder exists:
   const parentDir = dirname(projectDir)
   const canAccessParent = await isDirectoryWriteable(parentDir)
-  if (canAccessParent) {
-    return true
-  }
-  return false
+  return canAccessParent
 }
 
 const findConfigFile = async (directory, type) => {
@@ -102,18 +99,14 @@ export const getDependencyVersion = async (dependencyName) => {
   return packageJson.version
 }
 
-export const getSupportedNodeVersions = () => {
-  return ['16.17.0', '18.8.0', '19.0.0']
-}
+export const minimumSupportedNodeVersions = ['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
+  // TODO: add try/catch if some unsupported node version is passed
+  for (const version of minimumSupportedNodeVersions) {
+    if (semver.major(currentVersion) === semver.major(version) && semver.gte(currentVersion, version)) {
+      return true
     }
-    break
   }
-  return true
+  return false
 }

package/test/ghaction.test.mjs

@@ -37,13 +37,16 @@ test('creates gh action', async ({ end, equal }) => {
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-deploy.yml'), 'utf8')
   const ghAction = parse(ghFile)
-  const steps = ghAction.jobs.build_and_deploy.steps
+  const { steps, permissions } = ghAction.jobs.build_and_deploy
   equal(steps.length, 3)
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Deploy project')
   equal(steps[2].env.DATABASE_URL, 'mydbconnectionstring')
   equal(steps[2].env.PLT_SERVER_LOGGER_LEVEL, 'info')
+
+  equal(permissions.contents, 'read')
+  equal(permissions['pull-requests'], 'write')
 })
 
 test('creates gh action with TS build step', async ({ end, equal }) => {
@@ -53,7 +56,7 @@ test('creates gh action with TS build step', async ({ end, equal }) => {
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-deploy.yml'), 'utf8')
   const ghAction = parse(ghFile)
-  const steps = ghAction.jobs.build_and_deploy.steps
+  const { steps, permissions } = ghAction.jobs.build_and_deploy
   equal(steps.length, 4)
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
@@ -61,6 +64,9 @@ test('creates gh action with TS build step', async ({ end, equal }) => {
   equal(steps[3].name, 'Deploy project')
   equal(steps[3].env.DATABASE_URL, 'mydbconnectionstring')
   equal(steps[3].env.PLT_SERVER_LOGGER_LEVEL, 'info')
+
+  equal(permissions.contents, 'read')
+  equal(permissions['pull-requests'], 'write')
 })
 
 test('do not create gitignore file because already present', async ({ end, equal }) => {

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, isCurrentVersionSupported, getSupportedNodeVersions } from '../src/utils.mjs'
+import { getVersion, randomBetween, sleep, validatePath, getDependencyVersion, findDBConfigFile, findServiceConfigFile, isFileAccessible, isCurrentVersionSupported, minimumSupportedNodeVersions } from '../src/utils.mjs'
 import { mkdtempSync, rmSync, writeFileSync } from 'fs'
 import { tmpdir } from 'os'
 import { join } from 'path'
@@ -220,28 +220,62 @@ test('isFileAccessible', async ({ end, equal, mock }) => {
   rmSync(tmpDir1, { recursive: true, force: true })
 })
 
-test('getSupportedNodeVersions', async ({ equal, not }) => {
-  const supportedVersions = getSupportedNodeVersions()
-  equal(Array.isArray(supportedVersions), true)
-  not(supportedVersions.length, 0)
+test('minimumSupportedNodeVersions', async ({ equal, not }) => {
+  equal(Array.isArray(minimumSupportedNodeVersions), true)
+  not(minimumSupportedNodeVersions.length, 0)
 })
 
 test('isCurrentVersionSupported', async ({ equal }) => {
-  const supportedVersions = getSupportedNodeVersions()
-  const { major, minor, patch } = semver.minVersion(supportedVersions[0])
+  const { major, minor, patch } = semver.minVersion(minimumSupportedNodeVersions[0])
   {
-    // major not supported
+    // v15 major not supported
     const nodeVersion = `${major - 1}.${minor}.${patch}`
     const supported = isCurrentVersionSupported(nodeVersion)
     equal(supported, false)
   }
   {
-    // minor not supported
+    // v17 major not supported
+    const nodeVersion = `${major + 1}.${minor}.${patch}`
+    const supported = isCurrentVersionSupported(nodeVersion)
+    equal(supported, false)
+  }
+  {
+    // v16 minor not supported
     const nodeVersion = `${major}.${minor - 1}.${patch}`
     const supported = isCurrentVersionSupported(nodeVersion)
     equal(supported, false)
   }
-  for (const version of supportedVersions) {
+  {
+    // v16 more than minimum is supported
+    const supported = isCurrentVersionSupported(`${major}.${minor + 2}.${patch}`)
+    equal(supported, true)
+  }
+  // node version 18 test, to check greater and lesser major version
+  const { major: major18, minor: minor18, patch: patch18 } = semver.minVersion(minimumSupportedNodeVersions[1])
+  {
+    // v17 major not supported
+    const nodeVersion = `${major18 - 1}.${minor18}.${patch18}`
+    const supported = isCurrentVersionSupported(nodeVersion)
+    equal(supported, false)
+  }
+  {
+    // v19 is supported
+    const nodeVersion = `${major18 + 1}.${minor18}.${patch18}`
+    const supported = isCurrentVersionSupported(nodeVersion)
+    equal(supported, true)
+  }
+  {
+    // v18 minor not supported
+    const nodeVersion = `${major18}.${minor18 - 2}.${patch18}`
+    const supported = isCurrentVersionSupported(nodeVersion)
+    equal(supported, false)
+  }
+  {
+    // v18 supported
+    const supported = isCurrentVersionSupported(`${major18}.${minor18 + 1}.${patch18}`)
+    equal(supported, true)
+  }
+  for (const version of minimumSupportedNodeVersions) {
     const supported = isCurrentVersionSupported(version)
     equal(supported, true)
   }