WRP-1050: Migrated docs-utils to ES Modules

.eslintrc.js → .eslintrc.cjs

@@ -11,7 +11,8 @@ module.exports = {
 		'mocha': true
 	},
 	parserOptions: {
-		'ecmaVersion': 'latest'
+		'ecmaVersion': 'latest',
+		'sourceType': 'module'
 	},
 	root: true,
 	extends: ['eslint:recommended'],

index.js

@@ -1,30 +1,28 @@
 #!/usr/bin/env node
 
-'use strict';
-
 /* eslint-env node */
 // For `--standalone` the `--path` needs to include the library name or point to `packages`, no
 //	trailing `/`.  Defaults to the current working directory.
 
 // TODO: Allow for configuring output and input dirs better
 // TODO: Consider returning useful values from functions instead of just outputting/saving/etc.
 
-const shelljs = require('shelljs'),
-	fs = require('fs'),
-	os = require('os'),
-	pathModule = require('path'),
-	ProgressBar = require('progress'),
-	elasticlunr = require('elasticlunr'),
-	jsonata = require('jsonata'),
-	readdirp = require('readdirp'),
-	mkdirp = require('mkdirp'),
-	toc = require('markdown-toc'),
-	jsonfile = require('jsonfile'),
-	chalk = require('chalk'),
-	matter = require('gray-matter'),
-	parseArgs = require('minimist');
-const documentation = import('documentation');
+import chalk from 'chalk';
+import elasticlunr from 'elasticlunr';
+import fs from 'fs';
+import matter from 'gray-matter';
+import jsonata from 'jsonata';
+import jsonfile from 'jsonfile';
+import toc from 'markdown-toc';
+import parseArgs from 'minimist';
+import {mkdirpSync} from 'mkdirp';
+import os from 'os';
+import pathModule from 'path';
+import ProgressBar from 'progress';
+import readdirp from 'readdirp';
+import shelljs from 'shelljs';
 
+const documentation = import('documentation');
 let documentationResponse;
 const generateDocumentationResponse = async () => {
 	documentationResponse = await documentation.then(result => result);
@@ -50,7 +48,7 @@ const allowedErrorTags = ['@curried', '@hoc', '@hocconfig', '@omit', '@required'
  * @param {string} [pattern=*.js] - An optional regex string to be used for filtering files
  * @returns {string[]} - A list of paths of matching files
  */
-const getValidFiles = (modules, pattern = '*.js') => {
+export const getValidFiles = (modules, pattern = '*.js') => {
 	const files = [];
 	let cmd, moduleFiles;
 
@@ -92,7 +90,7 @@ const getValidFiles = (modules, pattern = '*.js') => {
  * @param {boolean} noSave - If `true`, no files are written to disk
  * @returns {Promise[]} - An array of promises that represent the scanning process
  */
-const getDocumentation = (paths, strict, noSave) => {
+export const getDocumentation = (paths, strict, noSave) => {
 	const docOutputPath = pathModule.join('src', 'pages', 'docs', 'modules');
 	// TODO: Add @module to all files and scan files and combine json
 	const validPaths = paths.reduce((prev, path) => {
@@ -273,7 +271,7 @@ async function validate (docs, componentDirectory, strict) {
  * @param {boolean} ignoreExternal - If `true`, any modules not scanned will be excluded from
  *	validation (i.e. standalone libraries will not warn for referencing core libraries)
  */
-function postValidate (strict, ignoreExternal) {
+export function postValidate (strict, ignoreExternal) {
 	const moduleRegex = /^((\w+\/\w+)(\.\w+)?)/,
 		exceptions = ['spotlight/Spotlight'];
 
@@ -361,7 +359,7 @@ function prependTableOfContents (contents) {
  * @param {string} [path] - Parent directory of `/docs/config.json`
  * @returns {object} Configuration object
  */
-function getDocsConfig (path = process.cwd()) {
+export function getDocsConfig (path = process.cwd()) {
 	const configFilename = `${path}/docs/config.json`,
 		// don't parse CLI or eslint-config-enact for source
 		parseSource = (path.indexOf('/cli') + path.indexOf('eslint')) < 0,
@@ -394,7 +392,7 @@ function getDocsConfig (path = process.cwd()) {
  * @param {string} config.source - Path to search for docs directory (parent of docs dir)
  * @param {string} config.outputTo - Path to copy static docs
  */
-function copyStaticDocs ({source, outputTo: outputBase, icon}) {
+export function copyStaticDocs ({source, outputTo: outputBase, icon}) {
 	let files = [];
 
 	if (os.platform() === 'win32') {
@@ -489,7 +487,7 @@ function copyStaticDocs ({source, outputTo: outputBase, icon}) {
  * @param {boolean} [strict] - If `true`, set process exit code on warnings
  * @returns {object} - keys = library names  values = object {desc: description, version: version, etc.}
  */
-function extractLibraryDescription ({path, hasPackageDir, description, ...rest}, strict) {
+export function extractLibraryDescription ({path, hasPackageDir, description, ...rest}, strict) {
 	const output = {};
 	let libraryPaths;
 
@@ -576,7 +574,7 @@ function extractLibraryDescription ({path, hasPackageDir, description, ...rest},
  *
  * @param {string} outputFilename - Filename for the generated index file
  */
-function generateIndex (docIndexFile) {
+export function generateIndex (docIndexFile) {
 	// Note: The $map($string) is needed because spotlight has a literal 'false' in a return type!
 	const expression = `{
 	  "title": name,
@@ -652,10 +650,10 @@ function generateIndex (docIndexFile) {
 }
 
 function makeDataDir () {
-	mkdirp.mkdirpSync(dataDir);
+	mkdirpSync(dataDir);
 }
 
-function saveLibraryDescriptions (descriptions) {
+export function saveLibraryDescriptions (descriptions) {
 	makeDataDir();
 	// generate a json file that contains the description to the corresponding libraries
 	jsonfile.writeFileSync(libraryDescriptionFile, descriptions);
@@ -680,14 +678,3 @@ function init () {
 }
 
 init();
-
-module.exports = {
-	getValidFiles,
-	getDocumentation,
-	postValidate,
-	copyStaticDocs,
-	generateIndex,
-	getDocsConfig,
-	extractLibraryDescription,
-	saveLibraryDescriptions
-};

package.json

@@ -1,11 +1,12 @@
 {
   "name": "@enact/docs-utils",
   "description": "Utilities for parsing and validating JSDoc in Enact projects",
+  "type": "module",
   "version": "0.4.2",
   "engines": {
     "node": ">=14"
   },
-  "main": "index.js",
+  "exports": "./index.js",
   "bin": {
     "validate-docs": "index.js"
   },