BREAKING: Make ESM only

Author: voxpelli

.eslintrc

@@ -1,4 +1,4 @@
 {
-  "extends": "@voxpelli",
+  "extends": "@voxpelli/eslint-config/esm",
   "root": true
 }

README.md

@@ -4,7 +4,7 @@ Renders a [`htm`](https://www.npmjs.com/package/htm) tagged template asyncly int
 
 [![npm version](https://img.shields.io/npm/v/async-htm-to-string.svg?style=flat)](https://www.npmjs.com/package/async-htm-to-string)
 [![npm downloads](https://img.shields.io/npm/dm/async-htm-to-string.svg?style=flat)](https://www.npmjs.com/package/async-htm-to-string)
-[![Module type: CJS+ESM](https://img.shields.io/badge/module%20type-cjs%2Besm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
+[![Module type: ESM](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
 [![Types in JS](https://img.shields.io/badge/types_in_js-yes-brightgreen)](https://github.com/voxpelli/types-in-js)
 [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg)](https://github.com/voxpelli/eslint-config)
 [![Follow @voxpelli@mastodon.social](https://img.shields.io/mastodon/follow/109247025527949675?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@voxpelli)
@@ -18,7 +18,7 @@ npm install async-htm-to-string
 ```
 
 ```javascript
-const { html, renderToString } = require('async-htm-to-string');
+import { html, renderToString } from 'async-htm-to-string';
 
 const customTag = ({ prefix }, children) => html`<div>${prefix}-${children}</div>`;
 const dynamicContent = 'bar';

index.js

@@ -1,10 +1,5 @@
-// @ts-check
-
-'use strict';
-
-const htm = require('htm'); // linemod-replace-with: import htm from 'htm';
-
-const escape = require('stringify-entities'); // linemod-replace-with: import escape from 'stringify-entities';
+import htm from 'htm';
+import { stringifyEntities } from 'stringify-entities';
 
 // *** REACT BORROWED ***
 const ATTRIBUTE_NAME_START_CHAR =
@@ -129,7 +124,7 @@ const omittedCloseTags = {
  * @param {ElementProps} props
  * @returns {Generator<string>}
  */
-const _renderProps = function * (props) {
+function * _renderProps (props) {
   // *** REACT BORROWED https://github.com/facebook/react/blob/779a472b0901b2d28e382f3850b2ad09a555b014/packages/react-dom/src/server/DOMMarkupOperations.js#L48-L72 ***
   for (const propKey in props) {
     if (!Object.prototype.hasOwnProperty.call(props, propKey)) {
@@ -151,7 +146,7 @@ const _renderProps = function * (props) {
     } else if (propValue === '') {
       yield ` ${propKey}=""`;
     } else if (typeof propValue === 'string') {
-      yield ` ${propKey}="${escape(propValue, { useNamedReferences: true })}"`;
+      yield ` ${propKey}="${stringifyEntities(propValue, { escapeOnly: true, useNamedReferences: true })}"`;
     } else if (typeof propValue === 'number') {
       yield ` ${propKey}="${propValue}"`;
     } else {
@@ -160,15 +155,15 @@ const _renderProps = function * (props) {
     }
   }
   // *** END REACT BORROWED ***
-};
+}
 
 /**
  * @yields {string}
  * @template {ElementProps} Props
  * @param {StringRenderableElement<Props>} item
  * @returns {AsyncIterableIterator<string>}
  */
-const _renderStringItem = async function * (item) {
+async function * _renderStringItem (item) {
   const { children, props, type } = item;
 
   const tag = type.toLowerCase();
@@ -186,15 +181,15 @@ const _renderStringItem = async function * (item) {
     yield * _render(children);
     yield `</${tag}>`;
   }
-};
+}
 
 /**
  * @yields {string}
  * @template {ElementProps} Props
  * @param {BasicRenderableElement<Props>} item
  * @returns {AsyncIterableIterator<string>}
  */
-const _renderElement = async function * (item) {
+async function * _renderElement (item) {
   const { children, props, skipStringEscape, type } = item;
 
   if (type === undefined) {
@@ -215,29 +210,29 @@ const _renderElement = async function * (item) {
   } else {
     throw new TypeError(`Invalid element type: ${typeof type}`);
   }
-};
+}
 
 /**
  * @yields {string}
  * @param {IterableIteratorMaybeAsync<RenderableElement>} iterator
  * @returns {AsyncIterableIterator<string>}
  */
-const _renderIterable = async function * (iterator) {
+async function * _renderIterable (iterator) {
   for await (const item of iterator) {
     yield * _render(item);
   }
-};
+}
 
 /**
  * @yields {string}
  * @param {RenderableElement|IterableIteratorMaybeAsync<RenderableElement>} item
  * @returns {AsyncIterableIterator<string>}
  */
-const _render = async function * (item) {
+async function * _render (item) {
   if (item === undefined || item === null) {
     yield '';
   } else if (typeof item === 'string') {
-    yield escape(item, { useNamedReferences: true });
+    yield stringifyEntities(item, { escapeOnly: true, useNamedReferences: true });
   } else if (typeof item === 'number') {
     yield item + '';
   } else {
@@ -249,14 +244,14 @@ const _render = async function * (item) {
       throw new TypeError(`Invalid render item type: ${typeof item}`);
     }
   }
-};
+}
 
 /**
  * @yields {string}
  * @param {HtmlMethodResult} item
  * @returns {AsyncIterableIterator<string>}
  */
-const render = async function * (item) { // linemod-prefix-with: export
+export async function * render (item) {
   if (item === undefined) throw new TypeError('Expected an argument');
   if (!item) throw new TypeError(`Expected a non-falsy argument, got: ${item}`);
   if (Array.isArray(item)) {
@@ -268,25 +263,27 @@ const render = async function * (item) { // linemod-prefix-with: export
   } else {
     throw new TypeError(`Expected a string or an object, got: ${typeof item}`);
   }
-};
+}
 
 /**
  * @param {IterableIteratorMaybeAsync<string>} generator
  * @returns {Promise<string>}
  */
-const generatorToString = async (generator) => { // linemod-prefix-with: export
+export async function generatorToString (generator) {
   let result = '';
   for await (const item of generator) {
     result += item;
   }
   return result;
-};
+}
 
 /**
  * @param {HtmlMethodResult} item
  * @returns {Promise<string>}
  */
-const renderToString = async (item) => generatorToString(render(item)); // linemod-prefix-with: export
+export async function renderToString (item) {
+  return generatorToString(render(item));
+}
 
 /**
  * @template {ElementProps} T
@@ -295,9 +292,9 @@ const renderToString = async (item) => generatorToString(render(item)); // linem
  * @param  {...RenderableElement} children
  * @returns {BasicRenderableElement<T>}
  */
-const h = (type, props, ...children) => { // linemod-prefix-with: export
+export function h (type, props, ...children) {
   return { type, props: props || {}, children };
-};
+}
 
 /** @type {(strings: TemplateStringsArray, ...values: Array<ElementPropsValue|ElementProps|RenderableElementFunction<any>|RenderableElement|RenderableElement[]>) => unknown} */
 const _internalHtml =
@@ -308,7 +305,7 @@ const _internalHtml =
  * @param {unknown} result
  * @returns {BasicRenderableElement<ElementProps>|string}
  */
-const _checkHtmlResult = (result) => {
+function _checkHtmlResult (result) {
   if (typeof result === 'number') {
     return result + '';
   } else if (!result) {
@@ -332,14 +329,14 @@ const _checkHtmlResult = (result) => {
   } else {
     throw new TypeError(`Resolved to invalid value type: ${typeof result}`);
   }
-};
+}
 
 /**
  * @param {TemplateStringsArray} strings
  * @param  {...ElementPropsValue|ElementProps|RenderableElementFunction<any>|RenderableElement|RenderableElement[]} values
  * @returns {HtmlMethodResult}
  */
-const html = (strings, ...values) => { // linemod-prefix-with: export
+export function html (strings, ...values) {
   const result = _internalHtml(strings, ...values);
 
   if (!Array.isArray(result)) return _checkHtmlResult(result);
@@ -348,24 +345,15 @@ const html = (strings, ...values) => { // linemod-prefix-with: export
   const unknownArray = result;
 
   return unknownArray.map(item => _checkHtmlResult(item));
-};
+}
 
 /**
  * @param {TemplateStringsArray|string} strings
  * @param  {...(string|number)} values
  * @returns {BasicRenderableElement<{}>}
  */
-const rawHtml = (strings, ...values) => { // linemod-prefix-with: export
+export function rawHtml (strings, ...values) {
   /** @type {RenderableElementFunction<{}>} */
   const type = () => typeof strings === 'string' ? strings : String.raw(strings, ...values);
   return { type, props: {}, children: [], skipStringEscape: true };
-};
-
-module.exports = {   // linemod-remove
-  generatorToString, // linemod-remove
-  html,              // linemod-remove
-  h,                 // linemod-remove
-  rawHtml,           // linemod-remove
-  render,            // linemod-remove
-  renderToString,    // linemod-remove
-};                   // linemod-remove
+}

index.test-d.ts

@@ -14,7 +14,7 @@ import {
   RenderableElement,
   RenderableElementFunction,
   BasicRenderableElement
-} from '.';
+} from './index.js';
 
 type ExtendableRenderableElementFunction<Props extends ElementProps = ElementProps> = (props: Props, children: RenderableElement[]) => HtmlMethodResult;
 

package.json

@@ -9,13 +9,9 @@
     "type": "git",
     "url": "git://github.com/voxpelli/async-htm-to-string.git"
   },
-  "main": "index.js",
-  "module": "index.mjs",
+  "type": "module",
+  "exports": "./index.js",
   "types": "index.d.ts",
-  "exports": {
-    "require": "./index.js",
-    "import": "./index.mjs"
-  },
   "engines": {
     "node": ">=16.0.0"
   },
@@ -40,9 +36,7 @@
   ],
   "scripts": {
     "build:0": "run-s clean",
-    "build:1:declaration": "tsc -p declaration.tsconfig.json",
-    "build:1:commonjs": "linemod -e mjs index.js",
-    "build:1": "run-p build:1:*",
+    "build:1": "tsc -p declaration.tsconfig.json",
     "build": "run-s build:*",
     "check:0": "run-s clean",
     "check:1:dependency-check": "dependency-check *.js 'test/**/*.js' --no-dev -i type-fest",
@@ -52,7 +46,7 @@
     "check:1:tsc": "tsc",
     "check:1:type-coverage": "type-coverage --detail --strict --at-least 99 --ignore-files 'test/*'",
     "check:1": "run-p -c --aggregate-output check:1:*",
-    "check:2": "run-s build:1:declaration",
+    "check:2": "run-s build:1",
     "check:3": "tsd",
     "check": "run-s check:*",
     "clean:declarations": "rm -rf $(find . -maxdepth 2 -type f -name '*.d.ts*')",
@@ -69,7 +63,7 @@
   },
   "dependencies": {
     "htm": "^3.0.4",
-    "stringify-entities": "^3.1.0"
+    "stringify-entities": "^4.0.3"
   },
   "devDependencies": {
     "@skypack/package-check": "^0.2.2",
@@ -100,7 +94,6 @@
     "ghat": "^0.14.0",
     "husky": "^8.0.3",
     "installed-check": "^7.0.0",
-    "linemod": "^0.3.0",
     "mocha": "^10.2.0",
     "nodemon": "^2.0.22",
     "npm-run-all2": "^6.0.5",

test/fixtures.js

@@ -1,10 +1,8 @@
-'use strict';
+/** @type {import('../index.js').HtmlMethodResult} */
+export const ELEMENT_FIXTURE = Object.freeze({ type: 'div', props: {}, children: [] });
 
-/** @type {import('..').HtmlMethodResult} */
-const ELEMENT_FIXTURE = Object.freeze({ type: 'div', props: {}, children: [] });
-
-/** @type {import('..').HtmlMethodResult} */
-const ELEMENT_ARRAY_CHILD_FIXTURE = Object.freeze({
+/** @type {import('../index.js').HtmlMethodResult} */
+export const ELEMENT_ARRAY_CHILD_FIXTURE = Object.freeze({
   type: 'ul',
   props: {},
   children: [
@@ -13,28 +11,21 @@ const ELEMENT_ARRAY_CHILD_FIXTURE = Object.freeze({
   ],
 });
 
-const ELEMENT_FIXTURE_INVALID_TYPE = Object.freeze({ type: true, props: {}, children: [] });
+export const ELEMENT_FIXTURE_INVALID_TYPE = Object.freeze({ type: true, props: {}, children: [] });
 
-const PrototypeIncludingClass = function () {
+function PrototypeIncludingClass () {
   this.a = 1;
   this.b = 2;
-};
+}
 
 // add properties in f function's prototype
 PrototypeIncludingClass.prototype.b = 3;
 PrototypeIncludingClass.prototype.c = 4;
 
-/** @type {import('..').HtmlMethodResult} */
+/** @type {import('../index.js').HtmlMethodResult} */
 // @ts-ignore
-const ELEMENT_FIXTURE_WITH_COMPLEX_PROPS = Object.freeze({
+export const ELEMENT_FIXTURE_WITH_COMPLEX_PROPS = Object.freeze({
   type: 'div',
   props: new PrototypeIncludingClass(),
   children: [],
 });
-
-module.exports = {
-  ELEMENT_FIXTURE,
-  ELEMENT_ARRAY_CHILD_FIXTURE,
-  ELEMENT_FIXTURE_INVALID_TYPE,
-  ELEMENT_FIXTURE_WITH_COMPLEX_PROPS,
-};