utfu 0.3.0 → 0.4.0

package/.editorconfig

@@ -0,0 +1,10 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

package/.eslintrc

@@ -0,0 +1,57 @@
+{
+  "parserOptions": {
+    "sourceType": "module",
+    "parser": "babel-eslint",
+    "allowImportExportEverywhere": true,
+    "ecmaVersion": 2017,
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "env": {
+    "commonjs": true,
+    "es6": true
+  },
+  "extends": ["plugin:security/recommended"],
+  "plugins": ["import", "node", "prettier", "promise", "security", "standard"],
+  "rules": {
+    "indent": ["off"],
+    "no-eval": ["error"],
+    "no-script-url": ["error"],
+    "linebreak-style": ["warn", "unix"],
+    "quotes": ["warn", "single"],
+    "semi": ["warn", "never"],
+    "no-undef": ["off"],
+    "require-jsdoc": [
+      "off",
+      {
+        "require": null,
+        "FunctionDeclaration": [true],
+        "MethodDefinition": [true],
+        "ClassDeclaration": [true],
+        "ArrowFunctionExpression": [true],
+        "FunctionExpression": [true]
+      }
+    ],
+    "valid-jsdoc": ["warn"],
+    "no-useless-escape": ["off"],
+    "key-spacing": ["off"],
+    "wrap-iife": ["error", "inside"],
+    "handle-callback-err": ["error"],
+    "callback-return": ["error"],
+    "no-mixed-requires": ["error"],
+    "no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "i|res|next|^err"
+      }
+    ],
+    "security/detect-non-literal-fs-filename": ["off"],
+    "security/detect-non-literal-regexp": ["off"],
+    "security/detect-non-literal-require": ["off"],
+    "security/detect-object-injection": ["off"],
+    "vue/html-self-closing": ["off"],
+    "vue/no-v-html": ["off"],
+    "vue/max-attributes-per-line": ["off"]
+  }
+}

package/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: "20"
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run tests
+        run: pnpm test

package/.oxfmtrc.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "ignorePatterns": [
+    "node_modules",
+    "dist"
+  ],
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "printWidth": 120,
+  "proseWrap": "preserve",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2
+}

package/.oxlintrc.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": [
+    "unicorn",
+    "typescript",
+    "oxc"
+  ],
+  "categories": {},
+  "rules": {},
+  "settings": {
+    "jsdoc": {
+      "ignorePrivate": false,
+      "ignoreInternal": false,
+      "ignoreReplacesDocs": true,
+      "overrideReplacesDocs": true,
+      "augmentsExtendsReplacesDocs": false,
+      "implementsReplacesDocs": false,
+      "exemptDestructuredRootsFromChecks": false,
+      "tagNamePreference": {}
+    },
+    "vitest": {
+      "typecheck": false
+    }
+  },
+  "env": {
+    "builtin": true
+  },
+  "globals": {},
+  "ignorePatterns": [
+    "node_modules",
+    "dist"
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "deepscan.enable": true,
+  "editor.defaultFormatter": "oxc.oxc-vscode",
+  "beans.mcp.showStartupNotification": false
+}

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## Unreleased
+
+## [0.4.0] - 2026-02-21
+
+- build: add postbuild script to write a minimal `dist/package.json` with
+  `main`/`module`/`types` and `exports` fields so the published package
+  points at the bundled ESM and CJS outputs.
+- ci: generate `dist/package.json` via `scripts/write-dist-package.js` (ESM)
+- test: add `tests/dist-package.test.ts` to verify `dist/package.json` is
+  created and contains the correct fields after the build
+- fix: remove unsupported `u` flags from regex literals in `src/mappings.ts`
+  so TypeScript compiles with the current target.

package/CONTRIBUTING.md

@@ -0,0 +1,127 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [hello@self.agency](mailto:hello@self.agency).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at
+[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020, Daniel Sieradski
+Copyright (c) 2026, Daniel Sieradski
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -15,4 +15,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # üŧ⨍û ➞ utfu
 
-[![npm](https://img.shields.io/npm/dt/utfu.svg)](https://www.npmjs.com/package/utfu) [![npm](https://img.shields.io/npm/v/utfu.svg)](https://www.npmjs.com/package/utfu) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Twitter: @selfagency_llc](https://img.shields.io/twitter/follow/selfagency_llc.svg?style=social)](https://twitter.com/selfagency_llc)
+[![npm](https://img.shields.io/npm/v/utfu.svg)](https://www.npmjs.com/package/utfu) [![npm](https://img.shields.io/npm/dt/utfu.svg)](https://www.npmjs.com/package/utfu) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 Replaces busted characters carried over from legacy text encodings with the proper UTF-8 characters.
 
@@ -24,7 +24,7 @@ Pass it to either method, `hex`, `htx`, or `txt`, and you'll hopefully get back:
 - `htx` substitutes the HTML escape sequence (ie., `€`)
 - `txt` substitutes the actual character (ie., `€`)
 
-- See substitution chart [here](https://www.i18nqa.com/debug/utf8-debug.html) for mappings, more or less
+- See [substitution chart](https://www.i18nqa.com/debug/utf8-debug.html) for mappings, more or less
 
 ```javascript
 import { hex, htx, txt } from 'utfu'
@@ -47,13 +47,16 @@ const cleanTxt = txt(dirty)
 yarn test
 ```
 
+## CI
+
+This repository includes a GitHub Actions workflow that runs the test suite on push and pull requests (see `.github/workflows/ci.yml`).
+
 ## Author
 
 👤 **Daniel Sieradski <hello@self.agency>**
 
 - Website: [self.agency](https://self.agency)
-- Twitter: [@selfagency_llc](https://twitter.com/selfagency_llc)
-- GitLab: [@selfagency](https://gitlab.com/selfagency)
+- BlueSky: [@self.agency](https://bsky.app/profile/self.agency)
 
 ## Acknowledgements
 

package/package.json

@@ -1,14 +1,8 @@
 {
   "name": "utfu",
+  "version": "0.4.0",
+  "private": false,
   "description": "Replaces busted characters carried over from legacy text encodings with the proper UTF-8 characters.",
-  "version": "0.3.0",
-  "license": "MIT",
-  "files": [
-    "dist-*/",
-    "bin/"
-  ],
-  "pika": true,
-  "sideEffects": false,
   "keywords": [
     "utf",
     "utf-8",
@@ -20,39 +14,26 @@
     "characters"
   ],
   "repository": "https://gitlab.com/selfagency/utfu.git",
-  "dependencies": {
-    "he": "^1.2.0",
-    "windows-1252": "^1.0.0"
-  },
+  "license": "MIT",
+  "author": "Daniel Sieradski <daniel@self.agency>",
+  "type": "module",
+  "types": "dist/index.d.ts",
   "devDependencies": {
-    "@babel/core": "^7.9.0",
-    "@babel/preset-env": "^7.9.6",
-    "@pika/pack": "^0.5.0",
-    "@pika/plugin-build-node": "^0.9.2",
-    "@pika/plugin-build-types": "^0.9.2",
-    "@pika/plugin-build-web": "^0.9.2",
-    "@pika/plugin-bundle-node": "^0.9.2",
-    "@pika/plugin-bundle-web": "^0.9.2",
-    "@pika/plugin-standard-pkg": "^0.9.2",
-    "babel-eslint": "^10.1.0",
-    "babel-jest": "^25.4.0",
-    "babel-loader": "^8.1.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.1.3",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-security": "^1.4.0",
-    "eslint-plugin-standard": "^4.0.1",
-    "jest": "^25.4.0",
-    "pika-plugin-minify": "^0.1.0",
-    "prettier": "^2.0.5",
-    "typescript": "^3.8.3"
+    "@types/he": "^1.2.3",
+    "@types/node": "^25.3.0",
+    "esbuild": "^0.27.3",
+    "he": "^1.2.0",
+    "oxfmt": "^0.34.0",
+    "oxlint": "^1.49.0",
+    "oxlint-tsgolint": "^0.14.2",
+    "tsup": "8.5.1",
+    "typescript": "5.9.3",
+    "vitest": "4.0.18",
+    "windows-1252": "3.0.4"
   },
-  "private": false,
-  "esnext": "dist-src/index.js",
-  "main": "dist-node/index.js",
-  "module": "dist-web/index.js",
-  "types": "dist-types/index.d.ts"
-}
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --out-dir dist",
+    "postbuild": "node ./scripts/write-dist-package.js",
+    "test": "vitest"
+  }
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+onlyBuiltDependencies:
+  - esbuild

package/scripts/verify-mappings.ts

@@ -0,0 +1,98 @@
+import he from 'he';
+import mappings from '../src/mappings.js';
+
+async function fetchText(url: string): Promise<string> {
+  const res = await fetch(url);
+  if (!res.ok) throw new Error(`Fetch failed: ${res.status}`);
+  return res.text();
+}
+
+function normalize(s: unknown): string {
+  if (s == null) return '';
+  // decode HTML entities, normalize NBSP to space, collapse whitespace
+  let out = he.decode(String(s));
+  out = out.replace(/\u00A0/g, ' ');
+  out = out.replace(/\s+/g, ' ').trim();
+  return out;
+}
+
+function parseChartFromHtml(html: string) {
+  const rows: string[][] = [];
+  const trRe = /<tr[\s\S]*?<\/tr>/gi;
+  const tdRe = /<t[dh][^>]*>([\s\S]*?)<\/(?:t[dh])>/gi;
+
+  let tr: RegExpExecArray | null;
+  while ((tr = trRe.exec(html))) {
+    const trHtml = tr[0];
+    const cols: string[] = [];
+    let td: RegExpExecArray | null;
+    tdRe.lastIndex = 0;
+    while ((td = tdRe.exec(trHtml))) {
+      cols.push(normalize(td[1].replace(/<[^>]+>/g, ' ')));
+    }
+    if (cols.length) rows.push(cols);
+  }
+
+  // Build map: misrender (column 4) -> expected char (column 3)
+  // Build map keyed by Unicode code point (column 1: U+XXXX) -> { expected, mis }
+  const map = new Map();
+  for (const cols of rows) {
+    // defensive: expect at least 4 columns
+    if (cols.length >= 4) {
+      const code = cols[0]; // e.g. 'U+20AC'
+      const expected = cols[2];
+      const mis = cols[3];
+      if (code) map.set(code.toUpperCase(), { expected, mis });
+    }
+  }
+  return map;
+}
+
+async function main() {
+  const url = 'https://www.i18nqa.com/debug/utf8-debug.html';
+  console.log('Downloading chart from', url);
+  const html = await fetchText(url);
+
+  const chart = parseChartFromHtml(html);
+
+  const mismatches = [];
+
+  for (const entry of mappings) {
+    // derive Unicode code point from the utf8 char
+    const utfChar = entry.utf8.chars;
+    const cp = utfChar && utfChar.length ? utfChar.codePointAt(0) : null;
+    const cpStr = cp ? 'U+' + cp.toString(16).toUpperCase().padStart(4, '0') : null;
+    if (!cpStr || !chart.has(cpStr)) {
+      mismatches.push({ mis: entry.misrender.chars, expected: entry.utf8.chars, reason: 'codepoint-not-in-chart' });
+      continue;
+    }
+
+    const chartEntry = chart.get(cpStr);
+    const chartExpected = normalize(chartEntry.expected);
+    const ourExpected = normalize(entry.utf8.chars);
+    if (chartExpected !== ourExpected) {
+      mismatches.push({
+        mis: entry.misrender.chars,
+        expected: entry.utf8.chars,
+        found: chartExpected,
+        reason: 'char-mismatch',
+      });
+    }
+  }
+
+  if (mismatches.length === 0) {
+    console.log('All mappings match the i18nqa chart ✅');
+    process.exit(0);
+  }
+
+  console.log('Found mismatches:');
+  for (const mm of mismatches) {
+    console.log('-', mm);
+  }
+  process.exit(2);
+}
+
+main().catch(err => {
+  console.error(err);
+  process.exit(1);
+});

package/scripts/write-dist-package.js

@@ -0,0 +1,40 @@
+import { mkdir, readFile, writeFile } from 'fs/promises';
+import { dirname, resolve } from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+async function main() {
+  const rootPkgPath = resolve(__dirname, '..', 'package.json');
+  const outDir = resolve(__dirname, '..', 'dist');
+  const raw = await readFile(rootPkgPath, 'utf8');
+  const pkg = JSON.parse(raw);
+
+  const distPkg = {
+    name: pkg.name,
+    version: pkg.version,
+    description: pkg.description,
+    license: pkg.license,
+    author: pkg.author,
+    main: './index.cjs',
+    module: './index.js',
+    types: './index.d.ts',
+    files: ['./index.cjs', './index.js', './index.d.ts'],
+    exports: {
+      '.': {
+        import: './index.js',
+        require: './index.cjs'
+      }
+    }
+  };
+
+  await mkdir(outDir, { recursive: true });
+  await writeFile(resolve(outDir, 'package.json'), JSON.stringify(distPkg, null, 2) + '\n', 'utf8');
+  console.log('Wrote', resolve(outDir, 'package.json'));
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exitCode = 1;
+});

package/src/index.ts

@@ -0,0 +1,35 @@
+import * as he from 'he';
+import * as win from 'windows-1252';
+
+import mappings from './mappings.js';
+
+type Mapping = {
+  misrender: { chars: string; hex: string; regex: RegExp };
+  utf8: { chars: string; hex: string; regex: RegExp };
+};
+
+const err = new Error('utfu requires a string to process');
+
+const notStr = (str: unknown): str is string => typeof str !== 'string';
+
+function runMap(str: string, m: 'hex' | 'chars', html = false): string {
+  if (notStr(str)) throw err;
+
+  // Re-encode/decode through windows-1252 to normalize mis-encoded bytes
+  str = win.decode(win.encode(str));
+
+  for (const map of mappings as Mapping[]) {
+    const replacement = html ? he.encode((map.utf8 as any)[m]) : (map.utf8 as any)[m];
+    str = str.replace(map.misrender.regex, replacement);
+  }
+
+  return str;
+}
+
+export const hex = (str: string): string => runMap(str, 'hex');
+
+export const htx = (str: string): string => runMap(str, 'chars', true);
+
+export const txt = (str: string): string => runMap(str, 'chars');
+
+export default { hex, htx, txt };