add migration template

snippets/migration/index.js

@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of snippeteer which is released under BSD-3-Clause.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, January 2020
+ */
+
+/* eslint-disable no-sync */
+/* eslint-disable no-console */
+
+const fs = require ('fs-extra');
+const path = require ('path');
+
+/**
+ * copies the full template to a new folder named after arg[0]
+ *
+ * @param {string} folder folder to run in
+ * @param {Array} args function arguments
+ */
+async function run (folder, args) {
+  const template = path.join (__dirname, 'template.js');
+  const dest = path.join (folder, `${args[0]}.js`);
+  await fs.writeFile (dest, await fs.readFile (template));
+}
+
+/**
+ * checks if the arguments meet the requirements
+ *
+ * @param {string} folder folder to run in
+ * @param {Array} args function arguments
+ * @returns {boolean} true if arguments match requirements
+ */
+function assert (folder, args) {
+  const tests = [
+    {
+      f:      () => (args.length < 2),
+      reason: 'too many arguments'
+    },
+    {
+      f:      () => (args.length === 1 && typeof args[0] === 'string'),
+      reason: 'name is not a string'
+    },
+    {
+      f:      () => ((/^[0-9]+-[a-z]+$/iu).test (args[0])),
+      reason: 'name has to match /^[0-9]+-[a-z]+$/'
+    },
+    {
+      f:      () => (typeof folder === 'string'),
+      reason: 'cwd is not a folder (internal error)'
+    },
+    {
+      f:      () => (fs.existsSync (folder)),
+      reason: 'cwd does not exist (internal error)'
+    },
+    {
+      f:      () => (!fs.existsSync (path.join (folder, args[0]))),
+      reason: 'migration already exists'
+    }
+  ];
+  for (const test of tests)
+    if (!test.f ()) {
+      console.log (test.reason);
+      return false;
+    }
+
+  return true;
+}
+
+module.exports = { run, assert };

snippets/migration/template.js

@@ -0,0 +1,24 @@
+/* eslint-disable no-magic-numbers */
+
+/**
+ * execute migration
+ *
+ * @param {any} knex database connections
+ */
+async function up (knex) {
+  await knex.schema.createTable ('template', (table) => {
+    table.increments ('id');
+    table.string ('text', 64);
+  });
+}
+
+/**
+ * revert migration
+ *
+ * @param {any} knex database connections
+ */
+async function down (knex) {
+  await knex.schema.dropTable ('template');
+}
+
+module.exports = { up, down };