Converts package to ESM.

__tests__/__snapshots__/index.spec.js.snap

@@ -22,7 +22,7 @@ exports[`should handle mdx 1`] = `
 import something from 'something';
 
 export const meta = {
-    prop: 'value',
+prop: 'value',
 };
 
 # Title
@@ -33,7 +33,7 @@ Paragraph 2.
 
 `;
 
-exports[`should handle no spacing in exceprt comment 1`] = `
+exports[`should handle no spacing in excerpt comment 1`] = `
 # Title
 
 Paragraph 1.
@@ -49,7 +49,7 @@ Paragraph 1.
 
 `;
 
-exports[`should return excerpt using "exceprt" identifier 1`] = `
+exports[`should return excerpt using "excerpt" identifier 1`] = `
 # Title
 
 Paragraph 1.
@@ -94,6 +94,21 @@ Paragraph 2.
 
 `;
 
+exports[`should return unmodified document when comment exists 1`] = `
+# Title
+
+Paragraph 1.
+
+Paragraph 2.
+
+<!-- comment -->
+
+Paragraph 3.
+
+Paragraph 4.
+
+`;
+
 exports[`should return unmodified document when no excerpt exists 1`] = `
 # Title
 

__tests__/fixtures/comment.md

@@ -0,0 +1,11 @@
+# Title
+
+Paragraph 1.
+
+Paragraph 2.
+
+<!-- comment -->
+
+Paragraph 3.
+
+Paragraph 4.

__tests__/index.spec.js

@@ -1,26 +1,36 @@
-const {join} = require('node:path');
+import {dirname, join} from 'node:path';
+import {fileURLToPath} from 'node:url';
 
-const {wrap} = require('jest-snapshot-serializer-raw');
-const remark = require('remark');
-const vfile = require('to-vfile');
+import {wrap} from 'jest-snapshot-serializer-raw';
+import {remark} from 'remark';
+import {toVFile} from 'to-vfile';
 
-const plugin = require('..');
+import plugin from '..';
 
 const processFixture = async (name, options) => {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = dirname(__filename);
     const path = join(__dirname, 'fixtures', name);
-    const file = await vfile.read(path);
+    const file = await toVFile.read(path);
+
     const result = await remark().use(plugin, options).process(file);
 
     return result.toString();
 };
 
+test('should return unmodified document when comment exists', async () => {
+    const result = await processFixture('comment.md');
+
+    expect(wrap(result)).toMatchSnapshot();
+});
+
 test('should return unmodified document when no excerpt exists', async () => {
     const result = await processFixture('no-excerpt.md');
 
     expect(wrap(result)).toMatchSnapshot();
 });
 
-test('should return excerpt using "exceprt" identifier', async () => {
+test('should return excerpt using "excerpt" identifier', async () => {
     const result = await processFixture('excerpt.md');
 
     expect(wrap(result)).toMatchSnapshot();
@@ -77,7 +87,7 @@ test('should handle identifier with spaces', async () => {
     expect(wrap(result)).toMatchSnapshot();
 });
 
-test('should handle no spacing in exceprt comment', async () => {
+test('should handle no spacing in excerpt comment', async () => {
     const result = await processFixture('no-space-in-comment.md');
 
     expect(wrap(result)).toMatchSnapshot();

example/example.js

@@ -1,12 +1,10 @@
-const remark = require('remark');
-const vfile = require('to-vfile');
+import {remark} from 'remark';
+import {toVFile} from 'to-vfile';
 
-const plugin = require('..');
+import plugin from '../index.js';
 
-(async () => {
-    const file = await vfile.read('./example/example.md');
-    const result = await remark().use(plugin).process(file);
+const file = await toVFile.read('./example/example.md');
+const result = await remark().use(plugin).process(file);
 
-    // eslint-disable-next-line no-console
-    console.log(result.toString());
-})();
+// eslint-disable-next-line no-console
+console.log(result.toString());

index.js

@@ -1,4 +1,4 @@
-const visit = require('unist-util-visit');
+import {visit} from 'unist-util-visit';
 
 const isComment = /<!--(.*?)-->/u;
 const getComment = /<!--([\s\S]*?)-->/u;
@@ -34,4 +34,4 @@ const plugin = (options = {}) => {
     return transformer;
 };
 
-module.exports = plugin;
+export default plugin;

jest.config.js

@@ -1,8 +1,9 @@
-module.exports = {
+export default () => ({
     coverageDirectory: '.coverage',
     resetMocks: true,
     resetModules: true,
     restoreMocks: true,
     snapshotSerializers: ['jest-snapshot-serializer-raw'],
     testEnvironment: 'node',
-};
+    transform: {},
+});