Resolves #129: provides dual ESM/CJS module

.eslintignore

@@ -0,0 +1 @@
+lib

.gitignore

@@ -5,4 +5,5 @@ npm-debug.log*
 .nyc_output
 coverage.info
 test/fixtures/*/build
-node_modules
+node_modules
+lib/*.*js

.prettierrc.yml

@@ -4,4 +4,4 @@ semi: false
 singleQuote: true
 bracketSpacing: true
 arrowParens: always
-printWidth: 80
+printWidth: 120

README.md

@@ -25,8 +25,12 @@ yarn add @metalsmith/permalinks
 ## Usage
 
 ```js
-const Metalsmith = require('metalsmith')
-const permalinks = require('@metalsmith/permalinks')
+import { dirname } from 'path'
+import { fileURLToPath } from 'url'
+import Metalsmith from 'metalsmith'
+import permalinks from '@metalsmith/permalinks'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
 
 Metalsmith(__dirname).use(
   permalinks({
@@ -42,10 +46,7 @@ If no pattern is provided, the files won't be remapped, but the `path` metadata
 The `pattern` can also be set as such:
 
 ```js
-const Metalsmith = require('metalsmith')
-const permalinks = require('@metalsmith/permalinks')
-
-Metalsmith(__dirname).use(
+metalsmith.use(
   permalinks({
     // original options would act as the keys of a `default` linkset,
     pattern: ':title',
@@ -91,8 +92,8 @@ would generate the file tree:
 
 ```
 build
-├── category1/with-category.html
-└── no-category.html
+├── category1/with-category/index.html
+└── no-category/index.html
 ```
 
 ### Dates

package.json

@@ -21,7 +21,14 @@
   },
   "version": "2.4.1",
   "license": "MIT",
-  "main": "lib/index.js",
+  "source": "src/index.js",
+  "main": "lib/index.cjs",
+  "module": "lib/index.js",
+  "type": "module",
+  "exports": {
+    "import": "./lib/index.js",
+    "require": "./lib/index.cjs"
+  },
   "scripts": {
     "changelog": "auto-changelog -u --starting-version v2.4.0 --commit-limit false --ignore-commit-pattern '^((dev|chore|ci):|Release|Merge)'",
     "coverage": "nyc report --reporter=text-lcov > ./coverage.info",
@@ -30,8 +37,10 @@
     "lint": "eslint --fix .",
     "lint:check": "eslint --fix-dry-run .",
     "dev": "nodemon --exec \"npm run lint && npm test\"",
-    "test": "nyc mocha",
-    "release": "release-it ."
+    "release": "release-it .",
+    "build": "microbundle --target node --no-sourcemap -f cjs,esm --generateTypes=false",
+    "pretest": "npm run build",
+    "test": "nyc mocha"
   },
   "dependencies": {
     "debug": "^4.3.4",
@@ -49,6 +58,7 @@
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-node": "^11.1.0",
     "metalsmith": "^2.5.0",
+    "microbundle": "^0.15.1",
     "mocha": "^9.2.2",
     "nodemon": "^2.0.19",
     "nyc": "^15.1.0",

lib/index.js → src/index.js

@@ -1,12 +1,10 @@
-'use strict'
+import path from 'path'
+import createDebug from 'debug'
+import moment from 'moment'
+import slugify from 'slugify'
+import route from 'regexparam'
 
-const path = require('path')
-const createDebug = require('debug')
 const debug = createDebug('@metalsmith/permalinks')
-const moment = require('moment')
-const slugify = require('slugify')
-const route = require('regexparam')
-
 const error = debug.extend('error')
 
 /**
@@ -253,7 +251,7 @@ const replace = (pattern, data, options) => {
  * @param {Options} options
  * @returns {import('metalsmith').Plugin}
  */
-function inititalizePermalinks(options) {
+function permalinks(options) {
   options = normalizeOptions(options)
 
   const { linksets } = options
@@ -302,8 +300,7 @@ function inititalizePermalinks(options) {
       return target
     }
 
-    const makeUnique =
-      typeof options.unique === 'function' ? options.unique : defaultUniquePath
+    const makeUnique = typeof options.unique === 'function' ? options.unique : defaultUniquePath
 
     Object.keys(files).forEach((file) => {
       const data = files[file]
@@ -330,10 +327,7 @@ function inititalizePermalinks(options) {
       }
 
       // Override the path with `permalink`  option
-      if (
-        Object.prototype.hasOwnProperty.call(data, 'permalink') &&
-        data.permalink !== false
-      ) {
+      if (Object.prototype.hasOwnProperty.call(data, 'permalink') && data.permalink !== false) {
         ppath = data.permalink
       }
 
@@ -369,4 +363,4 @@ function inititalizePermalinks(options) {
 }
 
 // Expose `plugin`
-module.exports = inititalizePermalinks
+export default permalinks