chore!: use pure ES modules

Author: ehmicky

.eslintrc.yml

@@ -2,6 +2,9 @@ plugins: [node, prettier]
 env:
   node: true
   es6: true
+parserOptions:
+  ecmaVersion: 2021
+  sourceType: module
 extends:
   - plugin:import/errors
   - plugin:import/warnings

ava.config.js

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 // eslint-disable-next-line node/shebang
-const { exit } = require('process')
+import { exit, argv } from 'process'
 
-const yargs = require('yargs')
-const filterObj = require('filter-obj')
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import filterObj from 'filter-obj'
 
-const { init } = require('./main.js')
-const { VARIABLES } = require('./variables/main.js')
+import { init } from './main.js'
+import { VARIABLES } from './variables/main.js'
 
 // CLI entry point of `npm run init`
 const runCli = async function () {
@@ -23,7 +24,7 @@ const runCli = async function () {
 
 // Parse CLI flags
 const parseFlags = function () {
-  return yargs.options(FLAGS).usage(USAGE).parse()
+  return yargs(hideBin(argv)).options(FLAGS).usage(USAGE).parse()
 }
 
 // Retrieve CLI flags
@@ -36,10 +37,12 @@ const getVariableFlag = function ({
   description,
   default: defaultValue,
 }) {
+  const defaultDescription =
+    typeof defaultValue === 'string' ? `\nDefault: ${defaultValue}` : ''
   return {
     [name]: {
       string: true,
-      describe: `${description}.\nDefault: ${defaultValue}`,
+      describe: `${description}.${defaultDescription}`,
     },
   }
 }

init/bin.js

@@ -1,31 +1,27 @@
-const { readFile, writeFile } = require('fs')
-const { promisify } = require('util')
+import { readFile, writeFile } from 'fs/promises'
+import { fileURLToPath } from 'url'
 
-const del = require('del')
-const omit = require('omit.js').default
-const filterObj = require('filter-obj')
+import del from 'del'
+import omit from 'omit.js'
+import filterObj from 'filter-obj'
 
-const PACKAGE_ROOT = `${__dirname}/..`
+const PACKAGE_ROOT = fileURLToPath(new URL('..', import.meta.url))
 const SCRIPTS_DIR = `${PACKAGE_ROOT}/init`
 const PACKAGE_JSON = `${PACKAGE_ROOT}/package.json`
 
-const pReadFile = promisify(readFile)
-const pWriteFile = promisify(writeFile)
-
 // Remove all files, properties and logic needed by `npm run init` once
 // `npm run init` is done.
-const cleanRepo = async function () {
+export const cleanRepo = async function () {
   await Promise.all([del(SCRIPTS_DIR, { force: true }), cleanPackageJson()])
 }
 
 // Remove `npm run init` in `package.json` and all `devDependencies`.
 const cleanPackageJson = async function () {
-  const content = await pReadFile(PACKAGE_JSON, 'utf8')
-  const { scripts, dependencies, devDependencies, ...packageJson } = JSON.parse(
-    content,
-  )
+  const content = await readFile(PACKAGE_JSON, 'utf8')
+  const { scripts, dependencies, devDependencies, ...packageJson } =
+    JSON.parse(content)
 
-  const scriptsA = omit(scripts, ['init'])
+  const scriptsA = omit.default(scripts, ['init'])
   const devDependenciesA = filterObj(devDependencies, shouldKeepDevDependency)
   const packageJsonA = {
     ...packageJson,
@@ -35,7 +31,7 @@ const cleanPackageJson = async function () {
   }
 
   const contentA = JSON.stringify(packageJsonA, null, 2)
-  await pWriteFile(PACKAGE_JSON, contentA)
+  await writeFile(PACKAGE_JSON, contentA)
 }
 
 // Remove devDependencies used only for initialization
@@ -57,5 +53,3 @@ const DEV_DEPENDENCIES = [
   'prettier',
   'release-it',
 ]
-
-module.exports = { cleanRepo }

init/clean.js

@@ -1,13 +1,14 @@
-const cpy = require('cpy')
+import cpy from 'cpy'
 
-const PACKAGE_ROOT = `${__dirname}/..`
+import { fileURLToPath } from 'url'
+
+const INIT_DIR = fileURLToPath(new URL('.', import.meta.url))
+const PACKAGE_ROOT = fileURLToPath(new URL('..', import.meta.url))
 
 // Copy some files during initialization
-const copyFiles = async function () {
-  const files = FILES.map((file) => `${__dirname}/${file}`)
+export const copyFiles = async function () {
+  const files = FILES.map((file) => `${INIT_DIR}/${file}`)
   await cpy(files, PACKAGE_ROOT)
 }
 
 const FILES = ['README.md']
-
-module.exports = { copyFiles }

init/copy.js

@@ -1,15 +1,15 @@
-const execa = require('execa')
-const { red } = require('chalk')
+import execa from 'execa'
+import chalk from 'chalk'
 
-const { getOptions } = require('./options.js')
-const { copyFiles } = require('./copy.js')
-const { applyTemplates } = require('./template.js')
-const { cleanRepo } = require('./clean.js')
-// const { createSite } = require('./site.js')
+import { getOptions } from './options.js'
+import { copyFiles } from './copy.js'
+import { applyTemplates } from './template.js'
+import { cleanRepo } from './clean.js'
+// import { createSite } from './site.js'
 
 // `npm run init` main logic.
 // Initialize/scaffold the template repository.
-const init = async function (options) {
+export const init = async function (options) {
   const { variables } = await getOptions(options)
 
   try {
@@ -21,7 +21,7 @@ const init = async function (options) {
     await execa.command('git commit -m Init')
     // Revert changes on errors
   } catch (error) {
-    console.error(red('Error: Initialization failed.'))
+    console.error(chalk.red('Error: Initialization failed.'))
     await execa.command('git reset --hard')
     await npmInstall()
     throw error
@@ -35,5 +35,3 @@ const npmInstall = async function () {
     stdio: 'inherit',
   })
 }
-
-module.exports = { init }

init/main.js

@@ -1,12 +1,10 @@
-const { getVariables } = require('./variables/main.js')
+import { getVariables } from './variables/main.js'
 
 // Retrieve options and apply default values
-const getOptions = async function (options = {}) {
+export const getOptions = async function (options = {}) {
   const optionsA = { ...DEFAULT_OPTIONS, ...options }
   const variables = await getVariables(optionsA)
   return { ...optionsA, variables }
 }
 
 const DEFAULT_OPTIONS = {}
-
-module.exports = { getOptions }

init/options.js

@@ -1,14 +1,14 @@
-const execa = require('execa')
-const { bold } = require('chalk')
-const stripAnsi = require('strip-ansi')
+import execa from 'execa'
+import chalk from 'chalk'
+import stripAnsi from 'strip-ansi'
 
-const { getRepo } = require('./variables/repo.js')
-const { applyTemplates } = require('./template.js')
+import { getRepo } from './variables/repo.js'
+import { applyTemplates } from './template.js'
 
 // Create a Netlify Site for the new repository
-const createSite = async function ({ name }) {
+export const createSite = async function ({ name }) {
   try {
-    console.log(bold(`\nCreating a new Netlify Site...\n`))
+    console.log(chalk.bold(`\nCreating a new Netlify Site...\n`))
     await login()
     const username = await getUsername()
     const siteId = await createNewSite(name, username)
@@ -60,9 +60,7 @@ const createNewSite = async function (name, username) {
   }
 
   const accountSlug = getAccountSlug(username)
-  const {
-    all: allA,
-  } = await execa.command(
+  const { all: allA } = await execa.command(
     `netlify sites:create --name netlify-plugin-${name} ${accountSlug}`,
     { all: true },
   )
@@ -93,5 +91,3 @@ const getAccountSlug = function (username) {
   }
   return `--account-slug=${username}`
 }
-
-module.exports = { createSite }

init/site.js

@@ -1,17 +1,14 @@
-const { readFile, writeFile } = require('fs')
-const { promisify } = require('util')
+import { readFile, writeFile } from 'fs/promises'
+import { fileURLToPath } from 'url'
 
-const fastGlob = require('fast-glob')
+import fastGlob from 'fast-glob'
 
-const PACKAGE_ROOT = `${__dirname}/..`
+const PACKAGE_ROOT = fileURLToPath(new URL('..', import.meta.url))
 // Files that have template variables
 const TEMPLATES = ['*.{json,md}', '{src,.github}/**']
 
-const pReadFile = promisify(readFile)
-const pWriteFile = promisify(writeFile)
-
 // Substitute template variables {{var}} in all source files
-const applyTemplates = async function (variables) {
+export const applyTemplates = async function (variables) {
   const templates = TEMPLATES.map(addPackageRoot)
   const files = await fastGlob(templates)
   await Promise.all(files.map((file) => applyTemplate(file, variables)))
@@ -22,9 +19,9 @@ const addPackageRoot = function (path) {
 }
 
 const applyTemplate = async function (file, variables) {
-  const content = await pReadFile(file, 'utf8')
+  const content = await readFile(file, 'utf8')
   const contentA = replaceVariables(content, variables)
-  await pWriteFile(file, contentA)
+  await writeFile(file, contentA)
 }
 
 const replaceVariables = function (content, variables) {
@@ -51,5 +48,3 @@ const replaceVariable = function (content, [name, value]) {
 
 const DUMMY_NAME = 'netlify-plugin-example'
 const NODE_VERSION = '^12.20.0 || ^14.14.0 || >=16.0.0'
-
-module.exports = { applyTemplates }

init/template.js

@@ -1,10 +1,10 @@
-const username = require('username')
-const execa = require('execa')
+import username from 'username'
+import execa from 'execa'
 
-const { trim } = require('./trim.js')
+import { trim } from './trim.js'
 
 // {{author}} template variable
-const AUTHOR_VARIABLE = {
+export const AUTHOR_VARIABLE = {
   name: 'author',
   description: 'Author name',
   // Try to guess current username
@@ -20,5 +20,3 @@ const AUTHOR_VARIABLE = {
   },
   filter: trim,
 }
-
-module.exports = { AUTHOR_VARIABLE }

init/variables/author.js

@@ -1,11 +1,9 @@
-const { trimTitleize } = require('./trim.js')
+import { trimTitleize } from './trim.js'
 
 // {{description}} template variable
-const DESCRIPTION_VARIABLE = {
+export const DESCRIPTION_VARIABLE = {
   name: 'description',
   description: 'Description',
   default: 'Example description',
   filter: trimTitleize,
 }
-
-module.exports = { DESCRIPTION_VARIABLE }

init/variables/description.js

@@ -1,10 +1,10 @@
-const { validate: validateEmail } = require('email-validator')
-const execa = require('execa')
+import { validate as validateEmail } from 'email-validator'
+import execa from 'execa'
 
-const { trim } = require('./trim.js')
+import { trim } from './trim.js'
 
 // {{email}} template variable
-const EMAIL_VARIABLE = {
+export const EMAIL_VARIABLE = {
   name: 'email',
   description: 'Author email address',
   // Try guessing current user's development email
@@ -25,5 +25,3 @@ const EMAIL_VARIABLE = {
     }
   },
 }
-
-module.exports = { EMAIL_VARIABLE }

init/variables/email.js

@@ -1,9 +1,9 @@
-const spdxLicenseList = require('spdx-license-list')
-const fuzzy = require('fuzzy')
+import spdxLicenseList from 'spdx-license-list'
+import fuzzy from 'fuzzy'
 
 // {{license}} template variable.
 // Autocompleted from the list of valid SPDX licenses.
-const LICENSE_VARIABLE = {
+export const LICENSE_VARIABLE = {
   type: 'autocomplete',
   name: 'license',
   description: 'Software license',
@@ -21,5 +21,3 @@ const LICENSES = [
   'BSD-3-Clause',
   ...Object.keys(spdxLicenseList),
 ]
-
-module.exports = { LICENSE_VARIABLE }

init/variables/license.js

@@ -1,20 +1,22 @@
-const inquirer = require('inquirer')
-const inquirerAutocomplete = require('inquirer-autocomplete-prompt')
-const { bold } = require('chalk')
+import inquirer from 'inquirer'
+import inquirerAutocomplete from 'inquirer-autocomplete-prompt'
+import chalk from 'chalk'
 
-const { NAME_VARIABLE } = require('./name.js')
-const { DESCRIPTION_VARIABLE } = require('./description.js')
-const { AUTHOR_VARIABLE } = require('./author.js')
-const { EMAIL_VARIABLE } = require('./email.js')
-const { LICENSE_VARIABLE } = require('./license.js')
-const { REPO_VARIABLE } = require('./repo.js')
-const { NODE_VERSION_VARIABLE } = require('./node_version.js')
+import { NAME_VARIABLE } from './name.js'
+import { DESCRIPTION_VARIABLE } from './description.js'
+import { AUTHOR_VARIABLE } from './author.js'
+import { EMAIL_VARIABLE } from './email.js'
+import { LICENSE_VARIABLE } from './license.js'
+import { REPO_VARIABLE } from './repo.js'
+import { NODE_VERSION_VARIABLE } from './node_version.js'
 
 inquirer.registerPrompt('autocomplete', inquirerAutocomplete)
 
 // Retrieve all template variables from either options or CLI interactive prompt
-const getVariables = async function (options) {
-  console.log(bold('\nWhich Netlify Build plugin would you like to create?\n'))
+export const getVariables = async function (options) {
+  console.log(
+    chalk.bold('\nWhich Netlify Build plugin would you like to create?\n'),
+  )
 
   const questions = VARIABLES.filter(
     ({ name }) => options[name] === undefined,
@@ -25,7 +27,7 @@ const getVariables = async function (options) {
 }
 
 // Each template variable
-const VARIABLES = [
+export const VARIABLES = [
   NAME_VARIABLE,
   DESCRIPTION_VARIABLE,
   AUTHOR_VARIABLE,
@@ -78,5 +80,3 @@ const getCurrentYear = function () {
 }
 
 const YEAR_BASE = 1900
-
-module.exports = { getVariables, VARIABLES }