Merge pull request #339 from SukkaW/ts-init

chore: add tsconfig & bunchee

Author: maltsev

.eslintignore

@@ -1,3 +1,3 @@
-lib/modules/example.mjs
+src/_modules/example.mjs
 test.mjs
 **/*.cjs

.gitignore

@@ -51,3 +51,6 @@ yarn.lock
 # Docs
 /docs/build/
 /docs/.docusaurus/
+
+# Dist
+dist

index.cjs

@@ -2,43 +2,44 @@
   "name": "htmlnano",
   "version": "2.1.2",
   "description": "Modular HTML minifier, built on top of the PostHTML",
-  "main": "index.cjs",
-  "module": "index.mjs",
-  "source": "index.mjs",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "require": "./index.cjs",
-      "import": "./index.mjs"
-    },
-    "./index.mjs": {
-      "types": "./index.d.mts",
-      "import": "./index.mjs"
-    },
-    "./index.cjs": {
-      "types": "./index.d.cts",
-      "require": "./index.cjs"
-    }
-  },
-  "types": "index.d.ts",
   "author": "Kirill Maltsev <[email protected]>",
   "license": "MIT",
   "scripts": {
-    "clean": "rimraf lib/*.cjs lib/**/*.cjs",
-    "compile": "npm run clean && babel -d lib/ lib/ --out-file-extension .cjs",
-    "lint": "eslint --fix *.mjs lib/*.mjs lib/**/*.mjs test/*.mjs test/**/*.mjs",
+    "clean": "rimraf dist",
+    "compile": "npm run clean && bunchee",
+    "lint": "eslint --fix src/*.mjs src/**/*.mjs test/*.mjs test/**/*.mjs",
     "pretest": "npm run lint && npm run compile",
     "test": ":",
-    "posttest": "mocha --timeout 5000 --require @babel/register --recursive --check-leaks --globals addresses",
+    "posttest": "mocha --timeout 5000 --require @swc-node/register --recursive --check-leaks --globals addresses",
     "prepare": "npm run compile"
   },
-  "keywords": [
-    "posthtml",
-    "posthtml-plugin",
-    "html",
-    "postproccessor",
-    "minifier"
+  "files": [
+    "dist"
   ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    "./helpers": {
+      "import": "./dist/helpers.mjs",
+      "require": "./dist/helpers.js"
+    },
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./presets/ampSafe": {
+      "import": "./dist/presets/ampSafe.mjs",
+      "require": "./dist/presets/ampSafe.js"
+    },
+    "./presets/max": {
+      "import": "./dist/presets/max.mjs",
+      "require": "./dist/presets/max.js"
+    },
+    "./presets/safe": {
+      "import": "./dist/presets/safe.mjs",
+      "require": "./dist/presets/safe.js"
+    }
+  },
   "babel": {
     "presets": [
       [
@@ -61,17 +62,24 @@
       ]
     ]
   },
+  "keywords": [
+    "posthtml",
+    "posthtml-plugin",
+    "html",
+    "postproccessor",
+    "minifier"
+  ],
   "dependencies": {
     "cosmiconfig": "^9.0.0",
     "posthtml": "^0.16.5"
   },
   "devDependencies": {
     "@aminya/babel-plugin-replace-import-extension": "1.2.0",
-    "@babel/cli": "^7.15.7",
     "@babel/core": "^7.15.5",
     "@babel/eslint-parser": "^7.17.0",
-    "@babel/preset-env": "^7.15.6",
-    "@babel/register": "^7.15.3",
+    "@babel/preset-env": "^7.27.1",
+    "@swc-node/register": "^1.10.10",
+    "bunchee": "^6.5.1",
     "cssnano": "^7.0.0",
     "eslint": "^8.12.0",
     "eslint-plugin-import": "^2.28.1",
@@ -85,6 +93,7 @@
     "srcset": "5.0.1",
     "svgo": "^3.0.2",
     "terser": "^5.21.0",
+    "typescript": "^5.8.3",
     "uncss": "^0.17.3"
   },
   "peerDependencies": {

index.d.cts

@@ -1,4 +1,4 @@
-import htmlnano from '../htmlnano.mjs';
+import htmlnano from '../index.mjs';
 import { isConditionalComment } from '../helpers.mjs';
 
 // Spec: https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/compatibility/ms537512(v=vs.85)

index.d.mts

@@ -47,32 +47,32 @@ const optionalDependencies = {
 
 
 const modules = {
-    collapseAttributeWhitespace: () => import('./modules/collapseAttributeWhitespace.mjs'),
-    collapseBooleanAttributes: () => import('./modules/collapseBooleanAttributes.mjs'),
-    collapseWhitespace: () => import('./modules/collapseWhitespace.mjs'),
-    custom: () => import('./modules/custom.mjs'),
-    deduplicateAttributeValues: () => import('./modules/deduplicateAttributeValues.mjs'),
-    example: () => import('./modules/example.mjs'),
-    mergeScripts: () => import('./modules/mergeScripts.mjs'),
-    mergeStyles: () => import('./modules/mergeStyles.mjs'),
-    minifyConditionalComments: () => import('./modules/minifyConditionalComments.mjs'),
-    minifyCss: () => import('./modules/minifyCss.mjs'),
-    minifyJs: () => import('./modules/minifyJs.mjs'),
-    minifyJson: () => import('./modules/minifyJson.mjs'),
-    minifySvg: () => import('./modules/minifySvg.mjs'),
-    minifyUrls: () => import('./modules/minifyUrls.mjs'),
-    normalizeAttributeValues: () => import('./modules/normalizeAttributeValues.mjs'),
-    removeAttributeQuotes: () => import('./modules/removeAttributeQuotes.mjs'),
-    removeComments: () => import('./modules/removeComments.mjs'),
-    removeEmptyAttributes: () => import('./modules/removeEmptyAttributes.mjs'),
-    removeOptionalTags: () => import('./modules/removeOptionalTags.mjs'),
-    removeRedundantAttributes: () => import('./modules/removeRedundantAttributes.mjs'),
-    removeUnusedCss: () => import('./modules/removeUnusedCss.mjs'),
-    sortAttributes: () => import('./modules/sortAttributes.mjs'),
-    sortAttributesWithLists: () => import('./modules/sortAttributesWithLists.mjs'),
+    collapseAttributeWhitespace: () => import('./_modules/collapseAttributeWhitespace.mjs'),
+    collapseBooleanAttributes: () => import('./_modules/collapseBooleanAttributes.mjs'),
+    collapseWhitespace: () => import('./_modules/collapseWhitespace.mjs'),
+    custom: () => import('./_modules/custom.mjs'),
+    deduplicateAttributeValues: () => import('./_modules/deduplicateAttributeValues.mjs'),
+    example: () => import('./_modules/example.mjs'),
+    mergeScripts: () => import('./_modules/mergeScripts.mjs'),
+    mergeStyles: () => import('./_modules/mergeStyles.mjs'),
+    minifyConditionalComments: () => import('./_modules/minifyConditionalComments.mjs'),
+    minifyCss: () => import('./_modules/minifyCss.mjs'),
+    minifyJs: () => import('./_modules/minifyJs.mjs'),
+    minifyJson: () => import('./_modules/minifyJson.mjs'),
+    minifySvg: () => import('./_modules/minifySvg.mjs'),
+    minifyUrls: () => import('./_modules/minifyUrls.mjs'),
+    normalizeAttributeValues: () => import('./_modules/normalizeAttributeValues.mjs'),
+    removeAttributeQuotes: () => import('./_modules/removeAttributeQuotes.mjs'),
+    removeComments: () => import('./_modules/removeComments.mjs'),
+    removeEmptyAttributes: () => import('./_modules/removeEmptyAttributes.mjs'),
+    removeOptionalTags: () => import('./_modules/removeOptionalTags.mjs'),
+    removeRedundantAttributes: () => import('./_modules/removeRedundantAttributes.mjs'),
+    removeUnusedCss: () => import('./_modules/removeUnusedCss.mjs'),
+    sortAttributes: () => import('./_modules/sortAttributes.mjs'),
+    sortAttributesWithLists: () => import('./_modules/sortAttributesWithLists.mjs'),
 };
 
-function htmlnano(optionsRun, presetRun) {
+export function htmlnano(optionsRun, presetRun) {
     let [options, preset] = loadConfig(optionsRun, presetRun);
 
     return async function minifier(tree) {
@@ -109,7 +109,7 @@ function htmlnano(optionsRun, presetRun) {
 
             const module = moduleName in modules ?
                 await (modules[moduleName]()) :
-                await import(`./modules/${moduleName}.mjs`);
+                await import(`./_modules/${moduleName}.mjs`);
 
             if (typeof module.onAttrs === 'function') {
                 attrsHandlers.push(module.onAttrs(options, moduleOptions));
@@ -170,29 +170,37 @@ function htmlnano(optionsRun, presetRun) {
     };
 }
 
-htmlnano.getRequiredOptionalDependencies = function (optionsRun, presetRun) {
+export function getRequiredOptionalDependencies (optionsRun, presetRun) {
     const [options] = loadConfig(optionsRun, presetRun);
 
     return [...new Set(Object.keys(options).filter(moduleName => options[moduleName]).map(moduleName => optionalDependencies[moduleName]).flat())];
-};
+}
 
 
-htmlnano.process = function (html, options, preset, postHtmlOptions) {
+export function process(html, options, preset, postHtmlOptions) {
     return posthtml([htmlnano(options, preset)])
         .process(html, postHtmlOptions);
-};
+}
 
 // https://github.com/webpack-contrib/html-minimizer-webpack-plugin/blob/faca00f2219514bc671c5942685721f0b5dbaa70/src/utils.js#L74
-htmlnano.htmlMinimizerWebpackPluginMinify = function htmlNano(input, minimizerOptions = {}) {
+export function htmlMinimizerWebpackPluginMinify(input, minimizerOptions = {}) {
     const [[, code]] = Object.entries(input);
     return htmlnano.process(code, minimizerOptions, presets.safe)
         .then(result => {
             return {
                 code: result.html
             };
         });
-};
+}
 
 htmlnano.presets = presets;
+htmlnano.getRequiredOptionalDependencies = getRequiredOptionalDependencies;
+htmlnano.process = process;
+htmlnano.htmlMinimizerWebpackPluginMinify = htmlMinimizerWebpackPluginMinify;
 
 export default htmlnano;
+
+if (typeof module !== 'undefined') {
+    // eslint-disable-next-line import/no-commonjs -- CJS compat, will remove once we fully migrated to TS
+    module.exports = htmlnano;
+}

index.mjs

@@ -1,5 +1,5 @@
 import { expect } from 'expect';
-import { isAmpBoilerplate, isComment, isConditionalComment, isStyleNode, extractCssFromStyleNode, optionalImport } from '../lib/helpers.mjs';
+import { isAmpBoilerplate, isComment, isConditionalComment, isStyleNode, extractCssFromStyleNode, optionalImport } from '../src/helpers.mjs';
 
 describe('[helpers]', () => {
     context('isAmpBoilerplate()', () => {

package.json

@@ -1,10 +1,9 @@
 import { expect } from 'expect';
 import posthtml from 'posthtml';
-import htmlnano from '../index.mjs';
-import safePreset from '../lib/presets/safe.mjs';
-import ampSafePreset from '../lib/presets/ampSafe.mjs';
-import maxPreset from '../lib/presets/max.mjs';
-import { loadConfig } from '../lib/htmlnano.mjs';
+import htmlnano, { loadConfig } from '../dist/index.mjs';
+import safePreset from '../dist/presets/safe.mjs';
+import ampSafePreset from '../dist/presets/ampSafe.mjs';
+import maxPreset from '../dist/presets/max.mjs';
 
 
 describe('[htmlnano]', () => {

lib/modules/collapseAttributeWhitespace.mjs renamed to src/_modules/collapseAttributeWhitespace.mjs

@@ -1,6 +1,6 @@
 const { expect } = require('expect');
 const posthtml = require('posthtml');
-const htmlnano = require('../index.cjs');
+const htmlnano = require('../dist/index.js');
 
 
 describe('[commonjs usage]', () => {

lib/modules/collapseBooleanAttributes.mjs renamed to src/_modules/collapseBooleanAttributes.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
 
 
 describe('collapseAttributeWhitespace', () => {

lib/modules/collapseWhitespace.mjs renamed to src/_modules/collapseWhitespace.mjs

@@ -1,6 +1,6 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
-import ampSafePreset from '../../lib/presets/ampSafe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
+import ampSafePreset from '../../dist/presets/ampSafe.mjs';
 
 
 describe('collapseBooleanAttributes', () => {

lib/modules/custom.mjs renamed to src/_modules/custom.mjs

@@ -1,6 +1,6 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
-import maxPreset from '../../lib/presets/max.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
+import maxPreset from '../../dist/presets/max.mjs';
 
 
 describe('collapseWhitespace', () => {

lib/modules/deduplicateAttributeValues.mjs renamed to src/_modules/deduplicateAttributeValues.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
 
 
 describe('deduplicateAttributeValues', () => {

lib/modules/example.mjs renamed to src/_modules/example.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import maxPreset from '../../lib/presets/max.mjs';
+import maxPreset from '../../dist/presets/max.mjs';
 
 
 describe('mergeScripts', () => {

lib/modules/mergeScripts.mjs renamed to src/_modules/mergeScripts.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import maxPreset from '../../lib/presets/max.mjs';
+import maxPreset from '../../dist/presets/max.mjs';
 
 
 describe('mergeStyles', () => {

lib/modules/mergeStyles.mjs renamed to src/_modules/mergeStyles.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
 
 
 describe('minifyConditionalComments', () => {

lib/modules/minifyConditionalComments.mjs renamed to src/_modules/minifyConditionalComments.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
 
 
 describe('minifyCss', function () {

lib/modules/minifyCss.mjs renamed to src/_modules/minifyCss.mjs

@@ -1,6 +1,6 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
-import ampSafePreset from '../../lib/presets/ampSafe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
+import ampSafePreset from '../../dist/presets/ampSafe.mjs';
 
 
 describe('minifyJs', () => {

lib/modules/minifyJs.mjs renamed to src/_modules/minifyJs.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
 
 
 describe('minifyJson', () => {

lib/modules/minifyJson.mjs renamed to src/_modules/minifyJson.mjs

@@ -1,6 +1,6 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
-import maxPreset from '../../lib/presets/max.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
+import maxPreset from '../../dist/presets/max.mjs';
 
 
 describe('minifySvg', () => {

lib/modules/minifySvg.mjs renamed to src/_modules/minifySvg.mjs

@@ -1,7 +1,7 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
-import maxPreset from '../../lib/presets/max.mjs';
-import ampSafePreset from '../../lib/presets/ampSafe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
+import maxPreset from '../../dist/presets/max.mjs';
+import ampSafePreset from '../../dist/presets/ampSafe.mjs';
 
 describe('minifyUrls', () => {
     it('shouldn\'t be enabled with safe preset', () => {

lib/modules/minifyUrls.mjs renamed to src/_modules/minifyUrls.mjs

@@ -1,5 +1,5 @@
 import { init } from '../htmlnano.mjs';
-import safePreset from '../../lib/presets/safe.mjs';
+import safePreset from '../../dist/presets/safe.mjs';
 
 describe('normalizeAttributeValues', () => {
     const options = {