Create migrate script to change mocha.opts to [json | js | yml | yaml]

lib/cli/cli.js

@@ -18,6 +18,7 @@ const path = require('path');
 const {loadOptions, YARGS_PARSER_CONFIG} = require('./options');
 const commands = require('./commands');
 const ansi = require('ansi-colors');
+const migrateOpts = require('../../scripts/migrate-opts-init');
 const {repository, homepage, version, gitter} = require('../../package.json');
 
 /**
@@ -40,6 +41,7 @@ exports.main = (argv = process.argv.slice(2)) => {
     .scriptName('mocha')
     .command(commands.run)
     .command(commands.init)
+    .command(migrateOpts.init)
     .updateStrings({
       'Positionals:': 'Positional Arguments',
       'Options:': 'Other Options',

package-scripts.js

@@ -77,6 +77,7 @@ module.exports = {
             'test.node.exports',
             'test.node.unit',
             'test.node.integration',
+            'test.node.migrateOpts',
             'test.node.jsapi',
             'test.node.requires',
             'test.node.reporters',
@@ -128,6 +129,11 @@ module.exports = {
           description: 'Run tests concerning mocha.opts',
           hiddenFromHelp: true
         },
+        migrateOpts: {
+          script: test('migrateOpts', 'test/migrate-opts'),
+          description: 'Run tests concerning migrate mocha.opts script',
+          hiddenFromHelp: true
+        },
         jsapi: {
           script: 'node test/jsapi',
           description: 'Run Node.js Mocha JavaScript API tests',

package.json

@@ -525,7 +525,10 @@
     "glob": "7.1.3",
     "growl": "1.10.5",
     "he": "1.2.0",
+    "js-beautify": "^1.10.2",
     "js-yaml": "3.13.1",
+    "json2yaml": "^1.1.0",
+    "jsonfile": "^5.0.0",
     "log-symbols": "2.2.0",
     "minimatch": "3.0.4",
     "mkdirp": "0.5.1",

scripts/migrate-opts-init.js

@@ -0,0 +1,8 @@
+'use strict';
+/**
+ * Exports Yargs commands
+ * @see https://git.io/fpJ0G
+ * @private
+ * @module
+ */
+exports.init = require('./migrate-opts.js');

scripts/migrate-opts.js

@@ -0,0 +1,59 @@
+'use strict';
+/**
+ * Command module for "migrate" command
+ * Interface : mocha migrate-opts -file ./test/mocha.opts --json
+ * Migrate opts
+ * Read opts file and change to othter file like yaml, yml, js, json
+ * @see https://mochajs.org/#configuring-mocha-nodejs
+ * @private
+ * @module
+ */
+const path = require('path');
+const YAML = require('json2yaml');
+const jsonfile = require('jsonfile');
+const beautify = require('js-beautify').js;
+const fs = require('fs');
+const loadMochaOpts = require('../lib/cli/options.js').loadMochaOpts;
+const setJsType = content =>
+  beautify(`(module.exports = ${JSON.stringify(content)})`);
+const setYamlType = content => YAML.stringify(content);
+const writeFile = {
+  yaml: (content, _path) =>
+    fs.writeFileSync(path.join(_path, `.mocharc.yaml`), setYamlType(content)),
+  yml: (content, _path) =>
+    fs.writeFileSync(path.join(_path, `.mocharc.yml`), setYamlType(content)),
+  js: (content, _path) =>
+    fs.writeFileSync(path.join(_path, `.mocharc.js`), setJsType(content)),
+  json: (content, _path) =>
+    jsonfile.writeFileSync(path.join(_path, `.mocharc.json`), content, {
+      spaces: 1
+    })
+};
+const writeConfig = (type, content, _path) => {
+  if (type === 'yaml') {
+    writeFile.yaml(content, _path);
+  } else if (type === 'yml') {
+    writeFile.yml(content, _path);
+  } else if (type === 'js') {
+    writeFile.js(content, _path);
+  } else {
+    writeFile.json(content, _path);
+  }
+  return content;
+};
+
+exports.init = (filepath, type, _path = process.cwd()) => {
+  const content = loadMochaOpts({opts: filepath});
+  writeConfig(type, content, _path);
+};
+exports.command = 'migrate-opts';
+
+exports.description = 'Migrate opts file to type that user wanted';
+
+exports.builder = yargs => yargs.option('file').option('type');
+
+exports.handler = argv => {
+  const filepath = path.join(process.cwd(), argv.file[0]);
+  const type = argv.type;
+  this.init(filepath, type);
+};

test/migrate-opts/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+var Mocha = require('../../');
+
+var mocha = new Mocha({
+  ui: 'bdd',
+  globals: ['okGlobalA', 'okGlobalB', 'okGlobalC', 'callback*'],
+  growl: true,
+  timeout: 1000
+});
+
+require('../setup');
+
+mocha.addFile('test/migrate-opts/migrate-opts.spec.js');
+
+mocha.run(function() {});

test/migrate-opts/migrate-opts.spec.js

@@ -0,0 +1,35 @@
+'use strict';
+var fs = require('fs');
+var path = require('path');
+var expect = require('chai').expect;
+var migrateOpts = require('../../scripts/migrate-opts');
+var types = ['json', 'js', 'yml', 'yaml'];
+
+describe('Test migrate-opts.js script', function() {
+  types.forEach(function(type) {
+    it('should be worked writeFile ' + type, function() {
+      var filepath = path.join(process.cwd(), './test/migrate-opts/mocha.opts');
+      var _path = path.join(process.cwd(), './test/migrate-opts');
+      migrateOpts.init(filepath, type, _path);
+      var __path = path.join(
+        process.cwd(),
+        './test/migrate-opts',
+        '.mocharc.' + type
+      );
+      var isFile = fs.existsSync(__path);
+      expect(isFile).to.equal(true);
+      if (isFile) fs.unlinkSync(__path);
+    });
+  });
+  after(function() {
+    types.forEach(function(type) {
+      var __path = path.join(
+        process.cwd(),
+        './test/migrate-opts',
+        '.mocharc.' + type
+      );
+      var isFile = fs.existsSync(__path);
+      if (isFile) fs.unlinkSync(__path);
+    });
+  });
+});

test/migrate-opts/mocha.opts

@@ -0,0 +1,4 @@
+--reporter dot  
+--growl
+--extension mjs
+--extension js