refactor: convert project to ESM

Author: anthony-redFox

__tests__/bin-readme.js

@@ -1,7 +1,11 @@
-const path = require('path');
-const exec = require('child_process').exec;
-const tmp = require('tmp');
-const fs = require('fs-extra');
+import path from 'path';
+import { exec } from 'child_process';
+import tmp from 'tmp';
+import fs from 'fs-extra';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 function documentation(args, options, parseJSON) {
   return new Promise((resolve, reject) => {

__tests__/bin-watch-serve.js

@@ -1,9 +1,9 @@
-const path = require('path');
-const os = require('os');
-const get = require('./utils').get;
-const spawn = require('child_process').spawn;
-const fs = require('fs');
-const pEvent = require('p-event');
+import path from 'path';
+import os from 'os';
+import { get } from './utils';
+import { spawn } from 'child_process';
+import fs from 'fs';
+import pEvent from 'p-event';
 
 function documentation(args, options) {
   if (!options) {

__tests__/bin.js

@@ -1,10 +1,10 @@
 /* global jasmine */
 
-const path = require('path');
-const os = require('os');
-const exec = require('child_process').exec;
-const tmp = require('tmp');
-const fs = require('fs-extra');
+import path from 'path';
+import os from 'os';
+import { exec } from 'child_process';
+import tmp from 'tmp';
+import fs from 'fs-extra';
 
 function documentation(args, options, parseJSON) {
   if (!options) {
@@ -157,7 +157,8 @@ describe('invalid arguments', function () {
   });
 });
 
-const semver = /\bv?(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)(?:-[\da-z-]+(?:\.[\da-z-]+)*)?(?:\+[\da-z-]+(?:\.[\da-z-]+)*)?\b/gi;
+const semver =
+  /\bv?(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)(?:-[\da-z-]+(?:\.[\da-z-]+)*)?(?:\+[\da-z-]+(?:\.[\da-z-]+)*)?\b/gi;
 test.skip('--config', async function () {
   const dst = path.join(os.tmpdir(), (Date.now() + Math.random()).toString());
   fs.mkdirSync(dst);

__tests__/format_type.js

@@ -1,9 +1,10 @@
 /*eslint max-len: 0 */
 
-const _formatType = require('../src/output/util/format_type');
-const LinkerStack = require('../src/output/util/linker_stack');
-const remark = require('remark');
-const parse = require('doctrine-temporary-fork').parse;
+import _formatType from '../src/output/util/format_type.js';
+import LinkerStack from '../src/output/util/linker_stack';
+import remark from 'remark';
+import doctrine from 'doctrine-temporary-fork';
+const parse = doctrine.parse;
 
 function stringify(children) {
   return remark().stringify({

__tests__/index.js

@@ -1,7 +1,7 @@
-const documentation = require('../src/');
-const os = require('os');
-const path = require('path');
-const fs = require('fs');
+import * as documentation from '../src/index.js';
+import os from 'os';
+import path from 'path';
+import fs from 'fs';
 
 function inputs(contents) {
   const dirEntry = os.tmpdir();

__tests__/lib/filter_access.js

@@ -1,6 +1,6 @@
-const filterAccess = require('../../src/filter_access');
+import filterAccess from '../../src/filter_access.js';
 
-test('filterAccess ignore', function() {
+test('filterAccess ignore', function () {
   expect(
     filterAccess(
       ['public', 'protected', 'undefined'],
@@ -14,7 +14,7 @@ test('filterAccess ignore', function() {
   ).toEqual([]);
 });
 
-test('filterAccess public, protected, undefined, no private', function() {
+test('filterAccess public, protected, undefined, no private', function () {
   expect(
     filterAccess(
       ['public', 'protected', 'undefined'],
@@ -46,7 +46,7 @@ test('filterAccess public, protected, undefined, no private', function() {
   ]);
 });
 
-test('filterAccess explicit public', function() {
+test('filterAccess explicit public', function () {
   expect(
     filterAccess(
       ['public'],
@@ -64,7 +64,7 @@ test('filterAccess explicit public', function() {
   ]);
 });
 
-test('filterAccess override', function() {
+test('filterAccess override', function () {
   expect(
     filterAccess(
       ['private'],
@@ -81,7 +81,7 @@ test('filterAccess override', function() {
   ]);
 });
 
-test('filterAccess nesting', function() {
+test('filterAccess nesting', function () {
   expect(
     filterAccess(
       ['public', 'protected', 'undefined'],

__tests__/lib/flow_doctrine.js

@@ -1,6 +1,6 @@
-const flowDoctrine = require('../../src/flow_doctrine.js');
-const parse = require('../../src/parsers/javascript');
-const FLOW_TYPES = require('@babel/types').FLOW_TYPES;
+import flowDoctrine from '../../src/flow_doctrine.js';
+import parse from '../../src/parsers/javascript';
+import { FLOW_TYPES } from '@babel/types';
 
 function toComment(fn, filename) {
   return parse(
@@ -12,8 +12,8 @@ function toComment(fn, filename) {
   )[0];
 }
 
-test('flowDoctrine', function() {
-  const types = FLOW_TYPES.filter(function(type) {
+test('flowDoctrine', function () {
+  const types = FLOW_TYPES.filter(function (type) {
     return type.match(/\wTypeAnnotation$/);
   });
 

__tests__/lib/git/find_git.js

@@ -1,9 +1,13 @@
-const mock = require('mock-fs');
-const mockRepo = require('../../utils').mockRepo;
-const path = require('path');
-const findGit = require('../../../src/git/find_git');
+import mock from 'mock-fs';
+import { mockRepo } from '../../utils.js';
+import path from 'path';
+import findGit from '../../../src/git/find_git.js';
+import { fileURLToPath } from 'url';
 
-test('findGit', function() {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+test('findGit', function () {
   mock(mockRepo.master);
   const root =
     path.parse(__dirname).root + path.join('my', 'repository', 'path');

__tests__/lib/git/url_prefix.js

@@ -1,9 +1,11 @@
-const mock = require('mock-fs');
-const mockRepo = require('../../utils').mockRepo;
-const getGithubURLPrefix = require('../../../src/git/url_prefix');
-const parsePackedRefs = getGithubURLPrefix.parsePackedRefs;
+import mock from 'mock-fs';
+import { mockRepo } from '../../utils.js';
+import {
+  getGithubURLPrefix,
+  parsePackedRefs
+} from '../../../src/git/url_prefix.js';
 
-test('getGithubURLPrefix', function() {
+test('getGithubURLPrefix', function () {
   mock(mockRepo.master);
   const masterUrl = getGithubURLPrefix({
     git: '/my/repository/path/.git',
@@ -34,7 +36,7 @@ test('getGithubURLPrefix', function() {
   expect(submoduleUrl).toBe('https://github.com/foo/bar/blob/this_is_the_sha/');
 });
 
-test('parsePackedRefs', function() {
+test('parsePackedRefs', function () {
   const input =
     '# pack-refs with: peeled fully-peeled\n' +
     '4acd658617928bd17ae7364ef2512630d97c007a refs/heads/babel-6\n' +

__tests__/lib/github.js

@@ -1,10 +1,13 @@
 /* eslint no-unused-vars: 0 */
+import mock from 'mock-fs';
+import path from 'path';
+import { mockRepo } from '../utils.js';
+import parse from '../../src/parsers/javascript.js';
+import github from '../../src/github.js';
+import { fileURLToPath } from 'url';
 
-const mock = require('mock-fs');
-const path = require('path');
-const mockRepo = require('../utils').mockRepo;
-const parse = require('../../src/parsers/javascript');
-const github = require('../../src/github');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 // mock-fs is causing some unusual side effects with jest-resolve
 // not being able to resolve modules so we've disabled these tests
@@ -29,15 +32,15 @@ function evaluate(fn) {
   );
 }
 
-afterEach(function() {
+afterEach(function () {
   mock.restore();
 });
 
-test.skip('github', function() {
+test.skip('github', function () {
   mock(mockRepo.master);
 
   expect(
-    evaluate(function() {
+    evaluate(function () {
       /**
        * get one
        * @returns {number} one
@@ -52,11 +55,11 @@ test.skip('github', function() {
   });
 });
 
-test.skip('malformed repository', function() {
+test.skip('malformed repository', function () {
   mock(mockRepo.malformed);
 
   expect(
-    evaluate(function() {
+    evaluate(function () {
       /**
        * get one
        * @returns {number} one
@@ -68,11 +71,11 @@ test.skip('malformed repository', function() {
   ).toBe(undefined);
 });
 
-test.skip('enterprise repository', function() {
+test.skip('enterprise repository', function () {
   mock(mockRepo.enterprise);
 
   expect(
-    evaluate(function() {
+    evaluate(function () {
       /**
        * get one
        * @returns {number} one
@@ -83,16 +86,15 @@ test.skip('enterprise repository', function() {
     })[0].context.github
   ).toEqual({
     path: 'index.js',
-    url:
-      'https://github.enterprise.com/foo/bar/blob/this_is_the_sha/index.js#L6-L8'
+    url: 'https://github.enterprise.com/foo/bar/blob/this_is_the_sha/index.js#L6-L8'
   });
 });
 
-test.skip('typedef', function() {
+test.skip('typedef', function () {
   mock(mockRepo.master);
 
   expect(
-    evaluate(function() {
+    evaluate(function () {
       /**
        * A number, or a string containing a number.
        * @typedef {(number|string)} NumberLike