hunspell-reader 9.0.1 → 9.1.0

package/README.md

@@ -1,7 +1,5 @@
 # hunspell-reader
 
-[![Build Status](https://travis-ci.org/streetsidesoftware/hunspell-reader.svg?branch=master)](https://travis-ci.org/streetsidesoftware/hunspell-reader)
-
 A library for reading Hunspell Dictionary files
 
 ## Application
@@ -61,16 +59,17 @@ hunspell-reader words ./en_US.dic -o en_US.txt
 ### Installation
 
 ```
-install -S hunspell-reader rxjs
+npm install hunspell-reader
 ```
 
-Note: the reader uses rxjs 5.0.
-
 ### Usage
 
 Typescript / Javascript:
 
-```typescript
+<!--- @@inject: ./example-code/example.js --->
+
+```js
+// ts-check
 import { HunspellReader } from 'hunspell-reader';
 
 const baseFile = 'en_US';
@@ -78,12 +77,15 @@ const dicFile = baseFile + '.dic';
 const affFile = baseFile + '.aff';
 
 // Initialize the reader with the Hunspell files
-const reader = new HunspellReader(affFile, dicFile);
+const reader = await HunspellReader.createFromFiles(affFile, dicFile);
 
 // Get the words as an array
-const promiseArrayOfWords = reader.readWords().toArray().toPromise();
+const words = [...reader];
+console.log('%o', words);
 ```
 
+<!--- @@inject-end: ./example-code/example.js --->
+
 ## Reference
 
 - [Hunspell Docs](https://github.com/hunspell/hunspell/blob/master/docs/hunspell.5.md)

package/dist/aff.d.ts

@@ -188,7 +188,7 @@ interface AffSubstitution {
     type: AffType;
     remove: string;
     attach: string;
-    attachRules?: RuleIdx[];
+    attachRules?: RuleIdx[] | undefined;
     replace: RegExp;
 }
 interface AffSubstitutionsForRegExp {

package/dist/affDef.d.ts

@@ -4,17 +4,17 @@ export interface Fx {
     combinable: boolean;
     substitutionSets: Substitutions;
     substitutionsForRegExps: SubstitutionsForRegExp[];
-    count?: string;
-    extra?: string[];
+    count?: string | undefined;
+    extra?: string[] | undefined;
 }
 export type Substitutions = Map<string, SubstitutionsForRegExp>;
 export interface Substitution {
     type: 'P' | 'S';
     remove: string;
     attach: string;
-    attachRules?: string;
+    attachRules?: string | undefined;
     replace: RegExp;
-    extra?: string;
+    extra?: string | undefined;
 }
 export interface SubstitutionsForRegExp {
     match: RegExp;
@@ -30,44 +30,44 @@ export interface Conv {
     to: string;
 }
 export interface AffTransformFlags {
-    KEEPCASE?: string;
-    WARN?: string;
-    NEEDAFFIX?: string;
-    FORCEUCASE?: string;
-    FORBIDDENWORD?: string;
-    NOSUGGEST?: string;
-    COMPOUNDBEGIN?: string;
-    COMPOUNDEND?: string;
-    COMPOUNDFLAG?: string;
-    COMPOUNDFORBIDFLAG?: string;
-    COMPOUNDMIDDLE?: string;
-    COMPOUNDPERMITFLAG?: string;
-    ONLYINCOMPOUND?: string;
+    KEEPCASE?: string | undefined;
+    WARN?: string | undefined;
+    NEEDAFFIX?: string | undefined;
+    FORCEUCASE?: string | undefined;
+    FORBIDDENWORD?: string | undefined;
+    NOSUGGEST?: string | undefined;
+    COMPOUNDBEGIN?: string | undefined;
+    COMPOUNDEND?: string | undefined;
+    COMPOUNDFLAG?: string | undefined;
+    COMPOUNDFORBIDFLAG?: string | undefined;
+    COMPOUNDMIDDLE?: string | undefined;
+    COMPOUNDPERMITFLAG?: string | undefined;
+    ONLYINCOMPOUND?: string | undefined;
 }
 export interface AffInfo extends AffTransformFlags {
     SET: string;
-    TRY?: string;
-    KEY?: string;
-    WORDCHARS?: string;
-    NOSPLITSUGS?: boolean;
-    MAXCPDSUGS?: number;
-    ONLYMAXDIFF?: boolean;
-    MAXDIFF?: number;
-    BREAK?: string[];
-    FLAG?: string;
-    MAP?: string[];
-    ICONV?: Conv[];
-    OCONV?: Conv[];
-    REP?: Rep[];
-    AF?: string[];
-    COMPOUNDMIN?: number;
-    COMPOUNDRULE?: string[];
-    CHECKCOMPOUNDCASE?: boolean;
-    CHECKCOMPOUNDDUP?: boolean;
-    CHECKCOMPOUNDREP?: boolean;
-    CHECKCOMPOUNDPATTERN?: string[][];
-    PFX?: Map<string, Fx>;
-    SFX?: Map<string, Fx>;
+    TRY?: string | undefined;
+    KEY?: string | undefined;
+    WORDCHARS?: string | undefined;
+    NOSPLITSUGS?: boolean | undefined;
+    MAXCPDSUGS?: number | undefined;
+    ONLYMAXDIFF?: boolean | undefined;
+    MAXDIFF?: number | undefined;
+    BREAK?: string[] | undefined;
+    FLAG?: string | undefined;
+    MAP?: string[] | undefined;
+    ICONV?: Conv[] | undefined;
+    OCONV?: Conv[] | undefined;
+    REP?: Rep[] | undefined;
+    AF?: string[] | undefined;
+    COMPOUNDMIN?: number | undefined;
+    COMPOUNDRULE?: string[] | undefined;
+    CHECKCOMPOUNDCASE?: boolean | undefined;
+    CHECKCOMPOUNDDUP?: boolean | undefined;
+    CHECKCOMPOUNDREP?: boolean | undefined;
+    CHECKCOMPOUNDPATTERN?: string[][] | undefined;
+    PFX?: Map<string, Fx> | undefined;
+    SFX?: Map<string, Fx> | undefined;
 }
 export type Rule = FlagRule | PfxRule | SfxRule;
 interface RuleBase {

package/dist/util.js

@@ -40,7 +40,7 @@ export function* batch(i, size) {
  */
 export function filterOrderedList(compare) {
     let last;
-    return function (t) {
+    return (t) => {
         const r = last === undefined ? last !== t : !!compare(last, t);
         last = r ? t : last;
         return r;

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.0.1",
+  "version": "9.1.0",
   "description": "A library for reading Hunspell Dictionary Files",
   "bin": "bin.js",
   "type": "module",
@@ -48,9 +48,9 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/hunspell-reader#readme",
   "dependencies": {
-    "@cspell/cspell-pipe": "^9.0.1",
-    "@cspell/cspell-types": "^9.0.1",
-    "commander": "^13.1.0",
+    "@cspell/cspell-pipe": "^9.1.0",
+    "@cspell/cspell-types": "^9.1.0",
+    "commander": "^14.0.0",
     "gensequence": "^7.0.0",
     "html-entities": "^2.6.0",
     "iconv-lite": "^0.6.3"
@@ -58,5 +58,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "bdfabd3686aac9827f3af0ceb4aa74947b5f9d60"
+  "gitHead": "a7ed42a31debbc86faa4a4ac2c686bdffe5b26b6"
 }