fixnow 2.0.0 → 2.0.1

package/README.md

@@ -141,6 +141,32 @@ await suggest("bonjoor", 3); // bound suggest is (word, max?)
 The slim entries (`fixnow/ar`, `fixnow/de`, `fixnow/en`, `fixnow/es`, `fixnow/fr`,
 `fixnow/pt`, `fixnow/ru`, `fixnow/vi`) re-export a checker pre-bound to that language.
 
+## Bundling
+
+fixnow reads its dictionaries from disk at runtime — they ship as files under
+`node_modules/fixnow/dictionaries/`, not as inlined bytes in the JS. So any bundler
+must treat `fixnow` as **external**, leaving it to load from `node_modules` at runtime.
+This is required for **VS Code extensions** and any **CJS bundle**: inlining fixnow into
+a CJS output strips the path anchor it uses to find its dictionaries, and it will throw
+a clear "mark 'fixnow' as external" error instead of resolving them.
+
+```js
+// esbuild
+await esbuild.build({
+  entryPoints: ["src/extension.ts"],
+  bundle: true,
+  format: "cjs",
+  platform: "node",
+  external: ["fixnow"],
+});
+```
+
+The matching option for other bundlers:
+
+- **Vite** — `build.rollupOptions.external: ['fixnow']`
+- **Rollup** — `external: ['fixnow']`
+- **webpack** — `externals: { fixnow: 'commonjs fixnow' }`
+
 ## Migrating from 1.x
 
 `2.0.0` cleans up three rough edges from the extraction-from-F1 release. Each is a

package/dist/ar.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/ar.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/ar.ts
 var checker = createChecker("ar");

package/dist/{chunk-FX7T7BEL.js → chunk-MSMQKHBH.js}

@@ -5863,7 +5863,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = join(dirname(fileURLToPath(import.meta.url)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = import.meta.url;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return join(dirname(fileURLToPath(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5902,7 +5916,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = join(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = gunzipSync(await readFile(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await readFile(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = gunzipSync(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/de.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/de.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/de.ts
 var checker = createChecker("de");

package/dist/en.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/en.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/en.ts
 var checker = createChecker("en");

package/dist/es.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/es.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/es.ts
 var checker = createChecker("es");

package/dist/fr.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/fr.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/fr.ts
 var checker = createChecker("fr");

package/dist/index.cjs

@@ -5903,7 +5903,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5942,7 +5956,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/index.js

@@ -10,7 +10,7 @@ import {
   suggest,
   tokenize,
   warmup
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 export {
   DEFAULT_PROTECTED_PATTERN,
   LANGUAGES,

package/dist/pt.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/pt.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/pt.ts
 var checker = createChecker("pt");

package/dist/ru.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/ru.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/ru.ts
 var checker = createChecker("ru");

package/dist/vi.cjs

@@ -5900,7 +5900,21 @@ function isSupportedLanguage(code) {
 }
 
 // src/dictionary.ts
-var PACKAGE_ROOT = (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl)), "..");
+function resolvePackageRoot() {
+  let url;
+  try {
+    url = importMetaUrl;
+  } catch {
+    url = void 0;
+  }
+  if (url) {
+    return (0, import_node_path.join)((0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(url)), "..");
+  }
+  throw new Error(
+    "fixnow could not locate its dictionaries. Mark 'fixnow' as external in your bundler (esbuild: external: ['fixnow']) so it loads from node_modules."
+  );
+}
+var PACKAGE_ROOT = resolvePackageRoot();
 var TrieDictionary = class {
   constructor(trie, compound) {
     this.trie = trie;
@@ -5939,7 +5953,16 @@ function loadDictionary(language) {
 async function decode(language) {
   const info = LANGUAGES[language];
   const file = (0, import_node_path.join)(PACKAGE_ROOT, "dictionaries", language, info.trie);
-  const text = (0, import_node_zlib.gunzipSync)(await (0, import_promises.readFile)(file)).toString("utf8");
+  let buf;
+  try {
+    buf = await (0, import_promises.readFile)(file);
+  } catch (cause) {
+    throw new Error(
+      `fixnow could not read its "${language}" dictionary at ${file}. If you bundle your app, mark 'fixnow' as external (esbuild: external: ['fixnow']) so it loads from node_modules at runtime.`,
+      { cause }
+    );
+  }
+  const text = (0, import_node_zlib.gunzipSync)(buf).toString("utf8");
   return new TrieDictionary(decodeTrie(text), info.compound ?? false);
 }
 function warmup(language) {

package/dist/vi.js

@@ -3,7 +3,7 @@ import {
   LANGUAGES,
   createChecker,
   tokenize
-} from "./chunk-FX7T7BEL.js";
+} from "./chunk-MSMQKHBH.js";
 
 // src/entries/vi.ts
 var checker = createChecker("vi");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fixnow",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Tiny multilingual spell checker with suggestions. Arabic, German, English, Spanish, French, Portuguese, Russian and Vietnamese dictionaries bundled — one install, zero runtime dependencies.",
   "type": "module",
   "main": "./dist/index.cjs",