refactor: migrate to using esms

.editorconfig

@@ -0,0 +1,7 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintrc.cjs

@@ -0,0 +1,29 @@
+/**
+ * @type {import('eslint').Linter.Config}
+ */
+module.exports = {
+  extends: [require.resolve('@vercel/style-guide/eslint/node')],
+  root: true,
+  reportUnusedDisableDirectives: true,
+  parserOptions: {
+    babelOptions: {
+      plugins: [
+        [
+          '@babel/plugin-syntax-import-attributes',
+          {
+            deprecatedAssertSyntax: true,
+          },
+        ],
+      ],
+    },
+  },
+  rules: {},
+  overrides: [
+    {
+      files: 'bin/title.js',
+      rules: {
+        'no-console': 'off',
+      },
+    },
+  ],
+};

.github/workflows/ci.yaml

@@ -9,11 +9,18 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 16
+          - 18
+          - 20
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm install
-      - run: npm test
+          cache: 'pnpm'
+      - run: pnpm install
+      - run: pnpm run test
+      - run: pnpm run lint
+      - run: pnpm run format

.gitignore

@@ -1,3 +1,4 @@
 *.log
 node_modules
-.vscode
+.vscode
+dist/

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# Disable concurrency to avoid potential race condition between file editing
+# tasks.
+pnpm exec lint-staged --concurrent false

.prettierignore

@@ -0,0 +1,2 @@
+dist/
+pnpm-lock.yaml

bin/title.js

@@ -1,14 +1,12 @@
 #!/usr/bin/env node
 
 // Packages
-const parse = require('arg')
-const { red, grey, blue } = require('chalk')
-const clipboardy = require('clipboardy')
-
-// Utilities
-const pkg = require('../package')
-const convert = require('../')
-const help = require('../lib/help')
+import parse from 'arg';
+import chalk from 'chalk';
+import clipboardy from 'clipboardy';
+import pkg from '../package.json' assert { type: 'json' };
+import convert from '../lib/index.js';
+import { helpText } from '../lib/help.js';
 
 // Parse the supplied commands and options
 const { _, ...args } = parse({
@@ -19,44 +17,48 @@ const { _, ...args } = parse({
   '-v': '--version',
   '-h': '--help',
   '-n': '--no-copy',
-  '-s': '--special'
-})
+  '-s': '--special',
+});
 
 // Output the package's version if
 // the `--version was supplied
 if (args['--version']) {
-  console.log(pkg.version)
-  process.exit(0)
+  console.log(pkg.version);
+  process.exit(0);
 }
 
 if (args['--help']) {
-  console.log(help)
-  process.exit(0)
+  console.log(helpText);
+  process.exit(0);
 }
 
 const main = async () => {
-  const sub = _.join(' ')
+  const sub = _.join(' ');
 
   if (!sub) {
-    console.error(`${red('Error!')} Please specify an input: ${grey('title "input"')}`)
-    process.exit(1)
+    console.error(
+      `${chalk.red('Error!')} Please specify an input: ${chalk.grey(
+        'title "input"',
+      )}`,
+    );
+    process.exit(1);
   }
 
-  const specials = args['--special']
+  const specials = args['--special'];
 
-  const output = convert(sub, { specials })
-  const copy = !args['--no-copy']
+  const output = convert(sub, { specials });
+  const copy = !args['--no-copy'];
 
   if (copy) {
     try {
-      await clipboardy.write(output)
+      await clipboardy.write(output);
     } catch (err) {
-      console.error(`${red('Error!')} Could not write to clipboard`)
-      process.exit(1)
+      console.error(`${chalk.red('Error!')} Could not write to clipboard`);
+      process.exit(1);
     }
   }
 
-  console.log(`${output}${copy ? ' ' + blue('[copied]') : ''}`)
-}
+  console.log(`${output}${copy ? ` ${chalk.blue('[copied]')}` : ''}`);
+};
 
-main()
+main();

build.config.ts

@@ -0,0 +1,10 @@
+import { defineBuildConfig } from 'unbuild';
+
+export default defineBuildConfig([
+  {
+    entries: ['./lib/index.js', './bin/title.js'],
+    rollup: {
+      emitCJS: true,
+    },
+  },
+]);

lib/help.js

@@ -1,13 +1,13 @@
 // Packages
-const { yellow, grey } = require('chalk')
+import chalk from 'chalk';
 
-module.exports = `
-  Usage: ${yellow('title')} [options] <input>
+export const helpText = `
+  Usage: ${chalk.yellow('title')} [options] <input>
 
   Options:
 
-    ${yellow('-h, --help')}      Show the usage information
-    ${yellow('-v, --version')}   Show the version number
-    ${yellow('-s, --special')}   Words to capitalize as they are passed
-    ${yellow('-n, --no-copy')}   Don't copy output to clipboard
-`
+    ${chalk.yellow('-h, --help')}      Show the usage information
+    ${chalk.yellow('-v, --version')}   Show the version number
+    ${chalk.yellow('-s, --special')}   Words to capitalize as they are passed
+    ${chalk.yellow('-n, --no-copy')}   Don't copy output to clipboard
+`;

lib/index.js

@@ -1,54 +1,61 @@
 // Utilities
-const lowerCase = require('./lower-case')
-const specials = require('./specials')
+import { lowerCaseWords } from './lower-case.js';
+import { specials } from './specials.js';
 
-const word = "[^\\s'’\\(\\)!?;:\"-]"
-const regex = new RegExp(`(?:(?:(\\s?(?:^|[.\\(\\)!?;:"-])\\s*)(${word}))|(${word}))(${word}*[’']*${word}*)`, "g")
+const word = '[^\\s\'’\\(\\)!?;:"-]';
+const regex = new RegExp(
+  `(?:(?:(\\s?(?:^|[.\\(\\)!?;:"-])\\s*)(${word}))|(${word}))(${word}*[’']*${word}*)`,
+  'g',
+);
 
-const convertToRegExp = specials => specials.map(s => [new RegExp(`\\b${s}\\b`, 'gi'), s])
+const convertToRegExp = (specials) =>
+  specials.map((s) => [new RegExp(`\\b${s}\\b`, 'gi'), s]);
 
 function parseMatch(match) {
-  const firstCharacter = match[0]
+  const firstCharacter = match[0];
 
   // test first character
   if (/\s/.test(firstCharacter)) {
     // if whitespace - trim and return
-    return match.slice(1)
+    return match.slice(1);
   }
-  if (/[\(\)]/.test(firstCharacter)) {
+  if (/[()]/.test(firstCharacter)) {
     // if parens - this shouldn't be replaced
-    return null
+    return null;
   }
 
-  return match
+  return match;
 }
 
-module.exports = (str, options = {}) => {
-  str = str.toLowerCase().replace(regex, (m, lead = '', forced, lower, rest, offset, string) => {
-    const isLastWord = m.length + offset >= string.length;
+// eslint-disable-next-line import/no-default-export -- Fixing the issue would be a breaking change.
+export default (str, options = {}) => {
+  let title = str
+    .toLowerCase()
+    .replace(regex, (m, lead = '', forced, lower, rest, offset, string) => {
+      const isLastWord = m.length + offset >= string.length;
 
-    const parsedMatch = parseMatch(m)
-    if (!parsedMatch) {
-      return m
-    }
-    if (!forced) {
-      const fullLower = lower + rest
+      const parsedMatch = parseMatch(m);
+      if (!parsedMatch) {
+        return m;
+      }
+      if (!forced) {
+        const fullLower = lower + rest;
 
-      if (lowerCase.has(fullLower) && !isLastWord) {
-        return parsedMatch
+        if (lowerCaseWords.has(fullLower) && !isLastWord) {
+          return parsedMatch;
+        }
       }
-    }
 
-    return lead + (lower || forced).toUpperCase() + rest
-  })
+      return lead + (lower || forced).toUpperCase() + rest;
+    });
 
-  const customSpecials = options.special || []
-  const replace = [...specials, ...customSpecials]
-  const replaceRegExp = convertToRegExp(replace)
+  const customSpecials = options.special || [];
+  const replace = [...specials, ...customSpecials];
+  const replaceRegExp = convertToRegExp(replace);
 
   replaceRegExp.forEach(([pattern, s]) => {
-    str = str.replace(pattern, s)
-  })
+    title = title.replace(pattern, s);
+  });
 
-  return str
-}
+  return title;
+};

lib/lower-case.js

@@ -1,18 +1,6 @@
-const conjunctions = [
-  'for',
-  'and',
-  'nor',
-  'but',
-  'or',
-  'yet',
-  'so'
-]
+const conjunctions = ['for', 'and', 'nor', 'but', 'or', 'yet', 'so'];
 
-const articles = [
-  'a',
-  'an',
-  'the'
-]
+const articles = ['a', 'an', 'the'];
 
 const prepositions = [
   'aboard',
@@ -83,11 +71,11 @@ const prepositions = [
   'via',
   'with',
   'within',
-  'without'
-]
+  'without',
+];
 
-module.exports = new Set([
+export const lowerCaseWords = new Set([
   ...conjunctions,
   ...articles,
-  ...prepositions
-])
+  ...prepositions,
+]);

lib/specials.js

@@ -1,4 +1,4 @@
-const intended = [
+export const specials = [
   'ZEIT',
   'ZEIT Inc.',
   'Vercel',
@@ -57,7 +57,5 @@ const intended = [
   'GraphQL',
   'GraphiQL',
   'JWT',
-  'JWTs'
-]
-
-module.exports = intended
+  'JWTs',
+];

lint-staged.config.js

@@ -0,0 +1,8 @@
+/**
+ * @type {import('lint-staged').Config}
+ */
+// eslint-disable-next-line import/no-default-export -- The tool expects a default export.
+export default {
+  '*': 'pnpm run format --write',
+  '*.js': 'pnpm run lint-js --fix',
+};