@opencrvs/create-countryconfig 2.1.0-rc.511e19f → 2.1.0-rc.517ffcd

package/index.js

@@ -11,93 +11,141 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 
-const { execSync } = require('child_process')
 const path = require('path')
 const fs = require('fs')
+const degit = require('degit').default
+
+const INFRASTRUCTURE_REPOSITORY = 'opencrvs/infrastructure'
+const CORE_REPOSITORY = 'opencrvs/opencrvs-core'
+const COUNTRYCONFIG_TEMPLATE_REPOSITORY_SUBPATH =
+  'packages/countryconfig-template'
+
+function joinValues(values, separator) {
+  return values
+    .filter((value) => !!value)
+    .join(separator)
+    .trim()
+}
 
-const COUNTRYCONFIG_REPO_URL =
-  'https://github.com/opencrvs/opencrvs-countryconfig.git'
-const INFRASTRUCTURE_REPO_URL =
-  'https://github.com/opencrvs/infrastructure.git'
+/**
+ * Clones a repository from GitHub to a target directory.
+ *
+ * @param {*} param0 repository - The repository to clone (e.g., 'opencrvs/opencrvs-core').
+ * @param {*} param0 repositorySubPath - The subpath within the repository to clone (optional). Otherwise the entire repository will be cloned.
+ * @param {*} param0 branch - The branch to clone (optional). Defaults to the default branch if not specified.
+ *
+ * @param {*} targetDir - The target directory where the repository will be cloned.
+ */
+async function cloneRepository(
+  { repository, repositorySubPath, branch },
+  targetDir
+) {
+  const repositoryPath = joinValues([repository, repositorySubPath], '/')
+  const fullPath = joinValues([repositoryPath, branch], '#')
 
-const projectName = process.argv[2]
+  console.log(`Cloning repository from ${fullPath} to ${targetDir}...`)
 
-if (!projectName) {
-  console.error(
-    'Please specify a project name:\n\n  npm create @opencrvs/countryconfig <project-name>\n'
-  )
-  process.exit(1)
-}
+  const emitter = degit(fullPath, {
+    mode: 'git'
+  })
 
-const countryconfigDirName = projectName + '-countryconfig'
-const infrastructureDirName = projectName + '-infrastructure'
+  await emitter.clone(targetDir)
+  console.log(`Copied files from ${fullPath} to ${targetDir} succesfully.`)
+}
 
-const countryconfigTargetDir = path.resolve(process.cwd(), countryconfigDirName)
-const infrastructureTargetDir = path.resolve(process.cwd(), infrastructureDirName)
+function ensureTargetDirectoryDoesNotExist(directoryName) {
+  const targetDirectoryPath = path.resolve(process.cwd(), directoryName)
 
-if (fs.existsSync(countryconfigTargetDir)) {
-  console.error('Error: Directory "' + countryconfigDirName + '" already exists.')
-  process.exit(1)
+  if (fs.existsSync(targetDirectoryPath)) {
+    console.error(
+      'Error: Directory already exists in path "' + targetDirectoryPath + '".'
+    )
+    process.exit(1)
+  }
 }
 
-if (fs.existsSync(infrastructureTargetDir)) {
-  console.error('Error: Directory "' + infrastructureDirName + '" already exists.')
-  process.exit(1)
+function updatePackageJsonName(targetPath, newName) {
+  console.log('\nUpdating package.json with project name: ' + newName + '\n')
+
+  const pkgPath = path.join(targetPath, 'package.json')
+  if (fs.existsSync(pkgPath)) {
+    try {
+      const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+      pkg.name = newName
+      fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+    } catch (err) {
+      console.error('\nFailed to update package.json:', err.message)
+      process.exit(1)
+    }
+  } else {
+    console.warn(
+      '\nWarning: No package.json found in the targetPath: ' +
+        targetPath +
+        '. Project name was not updated.'
+    )
+  }
 }
 
-console.log('\nScaffolding OpenCRVS country config in ./' + countryconfigDirName + '...\n')
+async function main() {
+  const projectName = process.argv[2]
 
-try {
-  execSync('git clone --depth 1 ' + COUNTRYCONFIG_REPO_URL + ' ' + countryconfigDirName, { stdio: 'inherit' })
-} catch (err) {
-  console.error('Failed to clone the country config repository:', err.message)
-  process.exit(1)
-}
+  if (!projectName) {
+    console.error(
+      'Please specify a project name:\n\n  npm create @opencrvs/countryconfig <project-name>\n'
+    )
+    process.exit(1)
+  }
 
-try {
-  fs.rmSync(path.join(countryconfigTargetDir, '.git'), { recursive: true, force: true })
-} catch (err) {
-  console.error('Failed to remove .git directory from country config:', err.message)
-  process.exit(1)
-}
+  const countryconfigDirName = projectName + '-countryconfig'
+  const countryconfigTargetPath = path.resolve(
+    process.cwd(),
+    countryconfigDirName
+  )
+  const infrastructureDirName = projectName + '-infrastructure'
+  const infrastructureTargetPath = path.resolve(
+    process.cwd(),
+    infrastructureDirName
+  )
+
+  ensureTargetDirectoryDoesNotExist(countryconfigDirName)
+  ensureTargetDirectoryDoesNotExist(infrastructureDirName)
 
-const pkgPath = path.join(countryconfigTargetDir, 'package.json')
-if (fs.existsSync(pkgPath)) {
   try {
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
-    pkg.name = countryconfigDirName
-    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+    await cloneRepository(
+      {
+        repository: CORE_REPOSITORY,
+        repositorySubPath: COUNTRYCONFIG_TEMPLATE_REPOSITORY_SUBPATH,
+        branch: 'ocrvs-13179' // @todo: remove this hardcoded branch once the countryconfig-template is merged into main
+      },
+      countryconfigTargetPath
+    )
   } catch (err) {
-    console.error('Failed to update package.json:', err.message)
+    console.error('\nFailed to clone country config template:', err.message)
     process.exit(1)
   }
-} else {
-  console.warn('Warning: No package.json found in the cloned country config repository. Project name was not updated.')
-}
 
-console.log('\nScaffolding OpenCRVS infrastructure in ./' + infrastructureDirName + '...\n')
+  updatePackageJsonName(countryconfigTargetPath, countryconfigDirName)
 
-try {
-  execSync('git clone --depth 1 ' + INFRASTRUCTURE_REPO_URL + ' ' + infrastructureDirName, { stdio: 'inherit' })
-} catch (err) {
-  console.error('Failed to clone the infrastructure repository:', err.message)
-  process.exit(1)
-}
+  try {
+    await cloneRepository(
+      { repository: INFRASTRUCTURE_REPOSITORY },
+      infrastructureTargetPath
+    )
+  } catch (err) {
+    console.error('Failed to clone the infrastructure repository:', err.message)
+    process.exit(1)
+  }
 
-try {
-  fs.rmSync(path.join(infrastructureTargetDir, '.git'), { recursive: true, force: true })
-} catch (err) {
-  console.error('Failed to remove .git directory from infrastructure:', err.message)
-  process.exit(1)
+  console.log('\nDone! Your project has been set up in two directories:\n')
+  console.log('  ./' + countryconfigDirName + '   -- country configuration')
+  console.log('  ./' + infrastructureDirName + '  -- server infrastructure\n')
+  console.log('To get started with the country config:\n')
+  console.log('  cd ' + countryconfigDirName)
+  console.log('  git init')
+  console.log('  tilt up\n')
+  console.log('To get started with the infrastructure:\n')
+  console.log('  cd ' + infrastructureDirName)
+  console.log('  git init\n')
 }
 
-console.log('\nDone! Your project has been set up in two directories:\n')
-console.log('  ./' + countryconfigDirName + '   -- country configuration')
-console.log('  ./' + infrastructureDirName + '  -- server infrastructure\n')
-console.log('To get started with the country config:\n')
-console.log('  cd ' + countryconfigDirName)
-console.log('  git init')
-console.log('  npm install\n')
-console.log('To get started with the infrastructure:\n')
-console.log('  cd ' + infrastructureDirName)
-console.log('  git init\n')
+main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/create-countryconfig",
-  "version": "2.1.0-rc.511e19f",
+  "version": "2.1.0-rc.517ffcd",
   "description": "Scaffold a new OpenCRVS country configuration",
   "bin": {
     "create-countryconfig": "./index.js"
@@ -17,5 +17,8 @@
     "countryconfig",
     "create"
   ],
-  "license": "MPL-2.0"
+  "license": "MPL-2.0",
+  "dependencies": {
+    "degit": "^3.6.5"
+  }
 }