feat!: convert to ESM (#180)

Author: jzempel

bin/index.js

@@ -7,18 +7,22 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-const Command = require('commander').Command;
+import { Command } from 'commander';
+import chalk from 'chalk';
+import cmd from '../dist/cmd/index.js';
+import { createRequire } from 'module';
+import dotenv from 'dotenv';
+import figlet from 'figlet';
+import github from '../dist/github/index.js';
+import lerna from '../dist/lerna/index.js';
+import netlify from '../dist/netlify/index.js';
+import ora from 'ora';
+
 const program = new Command();
-const chalk = require('chalk');
-const textSync = require('figlet').textSync;
-const spinner = require('ora')();
-const version = require('../package.json').version;
-const cmd = require('../dist/cmd');
-const github = require('../dist/github');
-const lerna = require('../dist/lerna');
-const netlify = require('../dist/netlify');
+const spinner = ora();
+const version = createRequire(import.meta.url)('../package.json').version;
 
-require('dotenv').config();
+dotenv.config();
 
 program
   .version(version)
@@ -38,7 +42,7 @@ program
   .addCommand(netlify.siteIdCommand(spinner))
   .addCommand(netlify.tokenCommand(spinner))
   .action(() => {
-    console.log(chalk.hex('#5EAE91')(textSync('garden')));
+    console.log(chalk.hex('#5EAE91')(figlet.textSync('garden')));
     console.log();
     program.help();
   })

package.json

@@ -9,6 +9,7 @@
   "bugs": {
     "url": "https://github.com/zendeskgarden/scripts/issues"
   },
+  "type": "module",
   "main": "dist/index.js",
   "bin": {
     "garden": "bin/index.js"
@@ -20,7 +21,7 @@
   "scripts": {
     "build": "yarn tsc",
     "format": "prettier-package-json --write && yarn format:all --write",
-    "format:all": "prettier --loglevel warn '**/*.{js,ts,json,md}' '!CHANGELOG.md' '!dist/**' '!.github/ISSUE_TEMPLATE.md'",
+    "format:all": "prettier --log-level warn '**/*.{js,ts,json,md}' '!CHANGELOG.md' '!dist/**' '!.github/ISSUE_TEMPLATE.md'",
     "lint": "yarn lint:js && yarn lint:md",
     "lint:js": "eslint bin/ src/ --ext js,ts --max-warnings 0",
     "lint:md": "markdownlint README.md src/**/*.md",
@@ -33,25 +34,25 @@
   "dependencies": {
     "@octokit/request-error": "5.0.0",
     "@octokit/rest": "20.0.1",
-    "chalk": "4.1.2",
+    "chalk": "5.3.0",
     "commander": "11.0.0",
-    "comment-parser": "1.3.1",
+    "comment-parser": "1.4.0",
     "dotenv": "16.3.1",
-    "execa": "5.1.1",
+    "execa": "7.2.0",
     "figlet": "1.6.0",
     "fs-extra": "11.1.1",
     "gh-pages": "5.0.0",
-    "globby": "11.1.0",
-    "handlebars": "4.7.7",
+    "globby": "13.2.2",
+    "handlebars": "4.7.8",
     "handlebars-helpers": "0.10.0",
-    "is-interactive": "1.0.0",
+    "is-interactive": "2.0.0",
+    "is-plain-object": "5.0.0",
     "klaw": "4.1.0",
     "lerna-changelog": "2.2.0",
     "lodash": "4.17.21",
-    "netlify": "9.0.0",
-    "netlify-cli": "9.16.7",
-    "node-fetch": "2.6.12",
-    "ora": "5.4.1",
+    "netlify": "13.1.0",
+    "netlify-cli": "15.10.0",
+    "ora": "7.0.1",
     "pluralize": "8.0.0",
     "react-docgen-typescript": "2.2.2",
     "typescript": "5.1.6"
@@ -64,20 +65,19 @@
     "@types/gh-pages": "3.2.1",
     "@types/handlebars-helpers": "0.5.3",
     "@types/klaw": "3.0.3",
-    "@types/lodash": "4.14.195",
-    "@types/node": "18.16.19",
-    "@types/node-fetch": "2.6.4",
+    "@types/lodash": "4.14.196",
+    "@types/node": "20.4.7",
     "@types/pluralize": "0.0.30",
-    "@typescript-eslint/eslint-plugin": "6.1.0",
-    "@typescript-eslint/parser": "6.1.0",
+    "@typescript-eslint/eslint-plugin": "6.2.1",
+    "@typescript-eslint/parser": "6.2.1",
     "@zendeskgarden/eslint-config": "34.0.0",
-    "eslint": "8.45.0",
-    "eslint-config-prettier": "8.8.0",
+    "eslint": "8.46.0",
+    "eslint-config-prettier": "8.10.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-notice": "0.9.10",
     "husky": "8.0.3",
     "markdownlint-cli": "0.35.0",
-    "prettier": "3.0.0",
+    "prettier": "3.0.1",
     "prettier-package-json": "2.8.0",
     "standard-version": "9.5.0"
   },
@@ -87,6 +87,9 @@
     "tools",
     "zendesk"
   ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "publishConfig": {
     "access": "public"
   }

src/cmd/docgen/index.ts

@@ -5,14 +5,18 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
+import { GlobTask, globby } from 'globby';
 import { ParserOptions, withCustomConfig, withDefaultConfig } from 'react-docgen-typescript';
-import commander, { Command } from 'commander';
-import { findConfigFile, sys } from 'typescript';
-import globby, { GlobbyOptions } from 'globby';
-import { handleErrorMessage, handleSuccessMessage, handleWarningMessage } from '../../utils';
+import {
+  handleErrorMessage,
+  handleSuccessMessage,
+  handleWarningMessage
+} from '../../utils/index.js';
+import { Command } from 'commander';
 import { Ora } from 'ora';
 import { parse as parseComment } from 'comment-parser';
 import { resolve } from 'path';
+import ts from 'typescript';
 
 type TAGS = Record<string, string>;
 
@@ -74,7 +78,7 @@ export const execute = async (
         ),
       shouldRemoveUndefinedFromOptional: true
     };
-    const globbyOptions: GlobbyOptions = {
+    const globbyOptions: GlobTask['options'] = {
       expandDirectories: {
         extensions: args.extensions || DEFAULT_EXTENSIONS
       },
@@ -84,7 +88,7 @@ export const execute = async (
     for await (const path of Array.isArray(args.paths) ? args.paths : [args.paths]) {
       const resolvedPath = resolve(path);
       /* eslint-disable-next-line @typescript-eslint/unbound-method */
-      const tsconfigPath = findConfigFile(resolvedPath, sys.fileExists);
+      const tsconfigPath = ts.findConfigFile(resolvedPath, ts.sys.fileExists);
       const parser = tsconfigPath
         ? withCustomConfig(tsconfigPath, parserOptions)
         : withDefaultConfig(parserOptions);
@@ -152,7 +156,7 @@ export const execute = async (
   return retVal;
 };
 
-export default (spinner: Ora): commander.Command => {
+export default (spinner: Ora): Command => {
   const command = new Command('cmd-docgen');
 
   return command

src/cmd/du/index.ts

@@ -5,10 +5,11 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-import commander, { Command } from 'commander';
-import { handleErrorMessage, handleSuccessMessage } from '../../utils';
+import { dirname, resolve } from 'path';
+import { handleErrorMessage, handleSuccessMessage } from '../../utils/index.js';
+import { Command } from 'commander';
 import { Ora } from 'ora';
-import { resolve } from 'path';
+import { fileURLToPath } from 'url';
 import { default as walk } from 'klaw';
 
 /**
@@ -23,7 +24,8 @@ export const execute = async (dir?: string, spinner?: Ora): Promise<number> => {
   let retVal = 0;
 
   try {
-    const root = resolve(dir || __dirname);
+    const currentDir = dirname(fileURLToPath(import.meta.url));
+    const root = resolve(dir || currentDir);
 
     for await (const file of walk(root)) {
       if (file.path !== root) {
@@ -39,7 +41,7 @@ export const execute = async (dir?: string, spinner?: Ora): Promise<number> => {
   return retVal;
 };
 
-export default (spinner: Ora): commander.Command => {
+export default (spinner: Ora): Command => {
   const command = new Command('cmd-du');
 
   return command

src/cmd/index.ts

@@ -5,5 +5,9 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-export { default as docgenCommand, execute as docgen } from './docgen';
-export { default as duCommand, execute as du } from './du';
+import { execute as docgen, default as docgenCommand } from './docgen/index.js';
+import { execute as du, default as duCommand } from './du/index.js';
+
+const commands = { docgenCommand, duCommand };
+
+export { commands as default, docgen, docgenCommand, du, duCommand };

src/github/branch/index.ts

@@ -5,10 +5,10 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-import commander, { Command } from 'commander';
-import { handleErrorMessage, handleSuccessMessage } from '../../utils';
+import { handleErrorMessage, handleSuccessMessage } from '../../utils/index.js';
+import { Command } from 'commander';
 import { Ora } from 'ora';
-import execa from 'execa';
+import { execa } from 'execa';
 
 /**
  * Execute the `github-branch` command.
@@ -46,7 +46,7 @@ export const execute = async (path?: string, spinner?: Ora): Promise<string | un
   return retVal;
 };
 
-export default (spinner: Ora): commander.Command => {
+export default (spinner: Ora): Command => {
   const command = new Command('github-branch');
 
   return command

src/github/commit/index.ts

@@ -5,9 +5,9 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-import commander, { Command } from 'commander';
-import { branch as getBranch, repository as getRepository, token as getToken } from '..';
-import { handleErrorMessage, handleSuccessMessage } from '../../utils';
+import { branch as getBranch, repository as getRepository, token as getToken } from '../index.js';
+import { handleErrorMessage, handleSuccessMessage } from '../../utils/index.js';
+import { Command } from 'commander';
 import { Octokit } from '@octokit/rest';
 import { Ora } from 'ora';
 import { RequestError } from '@octokit/request-error';
@@ -64,7 +64,7 @@ export const execute = async (args: IGitHubCommitArgs = {}): Promise<string | un
   return retVal;
 };
 
-export default (spinner: Ora): commander.Command => {
+export default (spinner: Ora): Command => {
   const command = new Command('github-commit');
 
   return command

src/github/deploy/index.ts

@@ -5,12 +5,12 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-import commander, { Command } from 'commander';
-import { commit as getCommit, repository as getRepository, token as getToken } from '..';
-import { handleErrorMessage, handleSuccessMessage } from '../../utils';
+import { commit as getCommit, repository as getRepository, token as getToken } from '../index.js';
+import { handleErrorMessage, handleSuccessMessage } from '../../utils/index.js';
+import { Command } from 'commander';
 import { Octokit } from '@octokit/rest';
 import { Ora } from 'ora';
-import execa from 'execa';
+import { execa } from 'execa';
 
 interface IGitHubDeployArgs {
   command: (...args: unknown[]) => Promise<string | { url: string; logUrl: string } | undefined>;
@@ -93,7 +93,7 @@ export const execute = async (args: IGitHubDeployArgs): Promise<string | undefin
   return retVal;
 };
 
-export default (spinner: Ora): commander.Command => {
+export default (spinner: Ora): Command => {
   const command = new Command('github-deploy');
 
   return command

src/github/index.ts

@@ -5,10 +5,38 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-export { default as branchCommand, execute as branch } from './branch';
-export { default as commitCommand, execute as commit } from './commit';
-export { default as deployCommand, execute as deploy } from './deploy';
-export { default as pagesCommand, execute as pages } from './pages';
-export { default as releaseCommand, execute as release } from './release';
-export { default as repositoryCommand, execute as repository } from './repository';
-export { default as tokenCommand, execute as token } from './token';
+import { execute as branch, default as branchCommand } from './branch/index.js';
+import { execute as commit, default as commitCommand } from './commit/index.js';
+import { execute as deploy, default as deployCommand } from './deploy/index.js';
+import { execute as pages, default as pagesCommand } from './pages/index.js';
+import { execute as release, default as releaseCommand } from './release/index.js';
+import { execute as repository, default as repositoryCommand } from './repository/index.js';
+import { execute as token, default as tokenCommand } from './token/index.js';
+
+const commands = {
+  branchCommand,
+  commitCommand,
+  deployCommand,
+  pagesCommand,
+  releaseCommand,
+  repositoryCommand,
+  tokenCommand
+};
+
+export {
+  commands as default,
+  branch,
+  branchCommand,
+  commit,
+  commitCommand,
+  deploy,
+  deployCommand,
+  pages,
+  pagesCommand,
+  release,
+  releaseCommand,
+  repository,
+  repositoryCommand,
+  token,
+  tokenCommand
+};

src/github/pages/index.ts

@@ -6,11 +6,11 @@
  */
 
 import { clean, publish } from 'gh-pages';
-import commander, { Command } from 'commander';
-import { repository as getRepository, token as getToken } from '..';
-import { handleErrorMessage, handleSuccessMessage } from '../../utils';
+import { repository as getRepository, token as getToken } from '../index.js';
+import { handleErrorMessage, handleSuccessMessage } from '../../utils/index.js';
+import { Command } from 'commander';
 import { Ora } from 'ora';
-import execa from 'execa';
+import { execa } from 'execa';
 
 interface IGitHubPagesArgs {
   dir: string;
@@ -86,7 +86,7 @@ export const execute = async (args: IGitHubPagesArgs): Promise<string | undefine
   return retVal;
 };
 
-export default (spinner: Ora): commander.Command => {
+export default (spinner: Ora): Command => {
   const command = new Command('github-pages');
 
   return command

src/github/release/index.ts

@@ -5,9 +5,9 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-import commander, { Command } from 'commander';
-import { repository as getRepository, token as getToken } from '..';
-import { handleErrorMessage, handleSuccessMessage } from '../../utils';
+import { repository as getRepository, token as getToken } from '../index.js';
+import { handleErrorMessage, handleSuccessMessage } from '../../utils/index.js';
+import { Command } from 'commander';
 import { Octokit } from '@octokit/rest';
 import { Ora } from 'ora';
 
@@ -61,7 +61,7 @@ export const execute = async (args: IGitHubReleaseArgs): Promise<string | undefi
   return retVal;
 };
 
-export default (spinner: Ora): commander.Command => {
+export default (spinner: Ora): Command => {
   const command = new Command('github-release');
 
   return command