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

[wnghdcjfe]

Description of the Change

add mocha migrate command in cli.
To make mocha migrate -file ./mocha.opts -type [yml | json | js | yaml] possible

Benefits

Help mocha.opts to .mocharc.json, js, yml, yaml

Interface

//test - version
node ./mocha/bin/mocha migrate-opts -file ./mocha.opts -type json
//real - version
mocha migrate -file ./mocha.opts -type yml
mocha migrate -file ./mocha.opts -type yaml
mocha migrate -file ./mocha.opts -type json
mocha migrate -file ./mocha.opts -type js

and then file create like this

{
 "_": [],
 "reporter": "dot",
 "R": "dot",
 "growl": true,
 "G": true,
 "extension": [
  "mjs",
  "js"
 ]
}

For your information, I used the existing code for the most safe results. require('../lib/cli/options.js').loadMochaOpts so "_": [],"G": true, ... lefted but that is no problem with performance.

Applicable issues

close #3910

[coveralls]

Coverage increased (+0.05%) to 92.792% when pulling 40fd762 on wnghdcjfe:migrate into ec8e2f8 on mochajs:master.

[azu]

What is the status of this Pull Request?
Is there anything that I can help with?
(For me, Migration script is blocker to update Mocha@7)

[wnghdcjfe]

@azu I really appreciate your mind once. Based on some feedback from some people,I fixed my code and I think there is no code problems But, I think the maintainers are busy. so This PR has no progress.

[azu]

I've created a standalone migration script.

npx @azu/mocha-migrate migrate-opts -file ./test/mocha.opts -type json

For more details, see README

• https://github.com/azu/mocha-migrate

This script is based on @wnghdcjfe work, Thanks!

However, It is better that mocha has built-in migration script.
husky does it and it looks like success.

[azu]

content includes alias and yargs's property like _.
We need to filter by mocha's options and normalize it.

For example

--require ts-node-test-register
--reporter spec

it's content will be

{
  _: [],
  require: [ 'ts-node-test-register' ],
  r: [ 'ts-node-test-register' ],
  reporter: 'spec',
  R: 'spec'
}

[azu]

My patch that filtering by types.

mocha/lib/cli/run-option-metadata.js

Line 15 in c5fc2be

exports.types = {

  const content = loadMochaOpts({opts: filepath});
  const types = require("./run-option-metadata").types;
  // filtering by types that remove alias and yargs property
  const allowPropertyNames = Object.values(types).reduce((names, flagNames) => {
    return names.concat(flagNames);
  }, []);
  const normalizedContent = Object.keys(content)
      .filter(key => allowPropertyNames.includes(key))
      .reduce((obj, key) => {
        obj[key] = content[key];
        return obj;
      }, {});
  writeConfig(type, normalizedContent, _path);

[JoshuaKGoldberg]

👋 coming back to this @wnghdcjfe, are you still interested in working on this PR? As of #5027 there are again maintainers who can review it now. No worries if you no longer have time - but if you do that'd be great!

[JoshuaKGoldberg]

Closing out to keep the queue small, as this is a migration for a feature removed 3-4 years ago. Cheers! 🤎

[wnghdcjfe]

I just checked this now, I'll join in.