Use ESM

Closes GH-43.

Reviewed-by: Dan Flettre <[email protected]>

Author: wooorm

Diff for: README.md

@@ -23,8 +23,9 @@ npm install github-slugger
 ## Usage
 
 ```js
-var GithubSlugger = require('github-slugger')
-var slugger = new GithubSlugger()
+import GithubSlugger from 'github-slugger'
+
+const slugger = new GithubSlugger()
 
 slugger.slug('foo')
 // returns 'foo'
@@ -56,7 +57,7 @@ If you need, you can also use the underlying implementation which does not keep
 track of the previously slugged strings (not recommended):
 
 ```js
-var slug = require('github-slugger').slug;
+import GithubSlugger, {slug} from 'github-slugger'
 
 slug('foo bar baz')
 // returns 'foo-bar-baz'

Diff for: index.js

@@ -1,50 +1,55 @@
-const regex = require('./regex.js')
-
-module.exports = BananaSlug
+import { regex } from './regex.js'
 
 const own = Object.hasOwnProperty
 
-function BananaSlug () {
-  const self = this
-
-  if (!(self instanceof BananaSlug)) return new BananaSlug()
-
-  self.reset()
-}
-
 /**
- * Generate a unique slug.
- * @param  {string} value String of text to slugify
- * @param  {boolean} [false] Keep the current case, otherwise make all lowercase
- * @return {string}       A unique slug string
+ * Slugger.
  */
-BananaSlug.prototype.slug = function (value, maintainCase) {
-  const self = this
-  let slug = slugger(value, maintainCase === true)
-  const originalSlug = slug
-
-  while (own.call(self.occurrences, slug)) {
-    self.occurrences[originalSlug]++
-    slug = originalSlug + '-' + self.occurrences[originalSlug]
+export default class BananaSlug {
+  /**
+   * Create a new slug class.
+   */
+  constructor () {
+    this.reset()
   }
 
-  self.occurrences[slug] = 0
-
-  return slug
-}
+  /**
+   * Generate a unique slug.
+   *
+   * @param  {string} value
+   *   String of text to slugify
+   * @param  {boolean} [maintainCase=false]
+   *   Keep the current case, otherwise make all lowercase
+   * @return {string}
+   *   A unique slug string
+   */
+  slug (value, maintainCase) {
+    const self = this
+    let result = slug(value, maintainCase === true)
+    const originalSlug = result
+
+    while (own.call(self.occurrences, result)) {
+      self.occurrences[originalSlug]++
+      result = originalSlug + '-' + self.occurrences[originalSlug]
+    }
+
+    self.occurrences[result] = 0
+
+    return result
+  }
 
-/**
- * Reset - Forget all previous slugs
- * @return void
- */
-BananaSlug.prototype.reset = function () {
-  this.occurrences = Object.create(null)
+  /**
+   * Reset - Forget all previous slugs
+   *
+   * @return void
+   */
+  reset () {
+    this.occurrences = Object.create(null)
+  }
 }
 
-function slugger (string, maintainCase) {
+export function slug (string, maintainCase) {
   if (typeof string !== 'string') return ''
   if (!maintainCase) string = string.toLowerCase()
   return string.replace(regex, '').replace(/ /g, '-')
 }
-
-BananaSlug.slug = slugger

Diff for: package.json

@@ -10,18 +10,19 @@
   "bugs": {
     "url": "https://github.com/Flet/github-slugger/issues"
   },
+  "type": "module",
   "files": [
     "index.js",
     "regex.js"
   ],
   "devDependencies": {
     "@octokit/rest": "^19.0.0",
     "@unicode/unicode-13.0.0": "^1.0.0",
+    "c8": "^7.0.0",
     "hast-util-select": "^5.0.0",
     "mdast-util-gfm": "^2.0.0",
     "mdast-util-to-markdown": "^1.0.0",
     "node-fetch": "^3.0.0",
-    "nyc": "^15.0.0",
     "regenerate": "^1.0.0",
     "rehype-parse": "^8.0.0",
     "standard": "*",
@@ -49,7 +50,7 @@
   "scripts": {
     "format": "standard --fix",
     "test-api": "tape test | tap-spec",
-    "test-coverage": "nyc --reporter lcov tape test/index.js | tap-spec",
+    "test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api",
     "test": "npm run format && npm run test-coverage"
   },
   "nyc": {

Diff for: regex.js

@@ -56,7 +56,7 @@ async function main () {
   await fs.writeFile('regex.js', [
     '// This module is generated by `script/`.',
     '/* eslint-disable no-control-regex, no-misleading-character-class, no-useless-escape */',
-    'module.exports = ' + generator.toRegExp() + 'g',
+    'export const regex = ' + generator.toRegExp() + 'g',
     ''
   ].join('\n'))
 }

Diff for: script/generate-fixtures.mjs renamed to script/generate-fixtures.js

@@ -1,13 +1,16 @@
-const test = require('tape')
-const GithubSlugger = require('../')
-const gist = require('./fixtures.json')
+import fs from 'node:fs'
+import test from 'tape'
+import GithubSlugger, { slug } from '../index.js'
 
-require('./test-static')
+const fixtures = JSON.parse(
+  String(fs.readFileSync(
+    new URL('fixtures.json', import.meta.url)
+  ))
+)
 
 test('simple stuff', function (t) {
   const slugger = new GithubSlugger()
 
-  t.equals(GithubSlugger().slug('foo'), 'foo', 'should work without new')
   t.equals(slugger.slug(1), '', 'should return empty string for non-strings')
 
   // Note: GH doesn’t support `maintaincase`, so the actual values are commented below.
@@ -17,10 +20,17 @@ test('simple stuff', function (t) {
   t.end()
 })
 
+test('static method', function (t) {
+  t.equals(slug('foo'), 'foo')
+  t.equals(slug('foo bar'), 'foo-bar')
+  t.equals(slug('foo'), 'foo') // idem potent
+  t.end()
+})
+
 test('fixtures', function (t) {
   const slugger = new GithubSlugger()
 
-  gist.forEach((d) => {
+  fixtures.forEach((d) => {
     t.equals(slugger.slug(d.input), d.expected, d.name)
   })