'add' command for CLI

License: MIT
Signed-off-by: Adam Uhlir <[email protected]>

Author: AuHau

.gitignore

@@ -25,4 +25,4 @@ build
 dist
 
 # Dependency directory
-node_modules/
+/node_modules

migrations/index.js

@@ -1,4 +1,16 @@
+'use strict'
+
+// Do not modify this file manually as it will be overridden when running 'add' CLI command.
+// Modify migration-templates.js file
+
+const emptyMigration = {
+  description: 'Empty migration.',
+  reversible: true,
+  migrate: () => {},
+  revert: () => {},
+  empty: true,
+}
 
 module.exports = [
-        // Place to hook up migrations
+  require('./migration-8'),
 ]

src/cli.js

@@ -31,6 +31,7 @@ async function main(args) {
     .command(commands.migrate)
     .command(commands.revert)
     .command(commands.status)
+    .command(commands.add)
     .demandCommand(1, 'You need at least one command before continuing')
     .strict()
     .fail((msg, err, yargs) => {

src/commands.js

@@ -2,20 +2,28 @@
 
 const os = require('os')
 const path = require('path')
+const fs = require('fs')
 const process = require('process')
+const util = require('util');
+
+const writeFile = util.promisify(fs.writeFile)
+const mkdir = util.promisify(fs.mkdir)
+const exec = util.promisify(require('child_process').exec);
 
 const chalk = require('chalk')
 
 const repoVersion = require('./repo/version')
 const migrator = require('./index')
+const templates = require('./migration-templates')
+const migrations = require('../migrations')
 
 function asyncClosure(fnc) {
   return function asyncWrapper({resolve, ...options}) {
     resolve(fnc(options))
   }
 }
 
-function reportingClosure(action){
+function reportingClosure(action) {
   return (migration, currentlyMigrated, totalToMigrate) =>
     process.stdout.write(`${chalk.green(`[${currentlyMigrated}/${totalToMigrate}]`)} Successfully ${action} ${chalk.bold(migration.version)}: ${migration.description}\n`)
 }
@@ -41,6 +49,44 @@ async function status({repoPath}) {
   return `${statusString}\nCurrent repo version: ${version}\nLast migration's version: ${lastMigrationVersion}`
 }
 
+async function getAuthor() {
+  try {
+    const name = (await exec('git config --get user.name'))['stdout']
+    const email = (await exec('git config --get user.email'))['stdout']
+    return `${name.replace('\n', '')} <${email.replace('\n', '')}>`
+  } catch (e) {
+    return ''
+  }
+}
+
+async function add({repoPath, empty}) {
+  const newMigrationVersion = migrator.getLatestMigrationVersion() + 1
+  const newMigrationFolder = path.join(__dirname, '..', 'migrations', 'migration-' + newMigrationVersion)
+
+  const migrationsImport = migrations.map((migration) => migration.empty ? `  Object.assign({version: ${migration.version}}, emptyMigration),` : `  require('./migration-${migration.version}'),`)
+  if (empty) {
+    migrationsImport.push(`  Object.assign({version: ${newMigrationVersion}}, emptyMigration),`)
+  } else {
+    migrationsImport.push(`  require('./migration-${newMigrationVersion}'),`)
+  }
+  const migrationsIndexJsContent = templates.migrationsIndexJs
+    .replace('{{imports}}', migrationsImport.join('\n'))
+  ;await writeFile(path.join(newMigrationFolder, '..', 'index.js'), migrationsIndexJsContent)
+
+  if (empty) return
+
+  await mkdir(newMigrationFolder)
+
+  const packageJsonContent = templates.packageJson
+    .replace(/{{version}}/gi, newMigrationVersion)
+    .replace(/{{author}}/gi, await getAuthor())
+  ;await writeFile(path.join(newMigrationFolder, 'package.json'), packageJsonContent)
+
+  const indexJsContent = templates.indexJs
+    .replace(/{{version}}/gi, newMigrationVersion)
+  ;await writeFile(path.join(newMigrationFolder, 'index.js'), indexJsContent)
+}
+
 module.exports = {
   migrate: {
     command: 'migrate',
@@ -74,5 +120,15 @@ module.exports = {
     command: 'status',
     describe: 'Display status of IPFS repo',
     handler: asyncClosure(status),
-  }
+  },
+  add: {
+    command: 'add',
+    describe: 'Bootstrap new migration',
+    handler: asyncClosure(add),
+    builder: yargv => yargv
+      .option('empty', {
+        describe: 'Creates empty migration',
+        type: 'boolean'
+      })
+  },
 }

src/migration-templates.js

@@ -0,0 +1,75 @@
+'use strict'
+
+module.exports = {
+  packageJson: `{
+  "name": "ipfs-repo-migration-{{version}}",
+  "version": "0.1.0",
+  "description": "Migration",
+  "author": "{{author}}",
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "node_modules"
+  ],
+  "engines": {
+    "node": ">=10.0.0",
+    "npm": ">=3.0.0"
+  },
+  "dependencies": {
+  },
+  "license": "MIT"
+}`,
+
+  indexJs: `'use strict'
+
+const Dastore = require('datastore-fs')
+const log = require('debug')('jsipfs-repo-migrations:migration-{{version}}')
+
+async function migrate(repoPath, isBrowser) {
+  const store = new Dastore(repoPath, {extension: '', createIfMissing: false})
+  store.open()
+
+  try {
+    // Your migration
+  } finally {
+    await store.close()
+  }
+}
+
+async function revert(repoPath, isBrowser) {
+  const store = new Dastore(repoPath, {extension: '', createIfMissing: false})
+  store.open()
+
+  try {
+    // Your reversion of migration (if supported)
+  } finally {
+    await store.close()
+  }
+}
+
+module.exports = {
+  version: {{version}},
+  description: '', // <--- Fill in your description here
+  reversible: true,
+  migrate,
+  revert,
+}`,
+
+  migrationsIndexJs: `'use strict'
+
+// Do not modify this file manually as it will be overridden when running 'add' CLI command.
+// Modify migration-templates.js file
+
+const emptyMigration = {
+  description: 'Empty migration.',
+  reversible: true,
+  migrate: () => {},
+  revert: () => {},
+  empty: true,
+}
+
+module.exports = [
+{{imports}}
+]
+`
+}