@cspell/dict-el - npm Package Compare versions

Comparing version 3.0.0 to 3.1.0

package.json

 {
   "name": "@cspell/dict-el",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Greek dictionary for cspell.",
@@ -14,12 +14,11 @@ "publishConfig": {
   "scripts": {
+    "build": "pnpm build:pre && pnpm run build:dictionary && pnpm build:post",
+    "build:pre": "pnpm sync && pnpm run compile-all-caps",
+    "build:post": "pnpm gz",
+    "build:dictionary": "cspell-tools-cli build",
+    "conditional-build": "pnpm build:pre && pnpm run build:dictionary --conditional && pnpm build:post",
     "compile-all-caps": "node ./tools/toCaps.mjs ./src/Greek.txt ./src/Greek.ALLCAPS.txt",
-    "build:dictionary:old": "cross-env NODE_OPTIONS=--max_old_space_size=4096 cspell-tools-cli compile --trie3 -x compound --merge el_GR src/hunspell/el-GR.dic src/Greek.txt src/Greek.ALLCAPS.txt -o .",
-    "build:dictionary": "cspell-tools-cli build",
-    "build:gz": "cspell-tools-cli gzip *.trie",
-    "build": "pnpm run compile-all-caps && pnpm run build:dictionary && pnpm build:gz && pnpm gen-checksum",
     "sync": "pnpm cpy \"node_modules/dictionary-el/{*.dic,*.aff,*.md,**/license}\" src/hunspell",
-    "checksum": "cspell-tools-cli shasum -c checksum.txt",
-    "conditional-build": "pnpm run --silent checksum || pnpm run build",
-    "gen-checksum": "cspell-tools-cli shasum -u checksum.txt --list-file source-files.txt source-dependencies.txt",
-    "prepare": "pnpm run build:gz",
+    "gz": "cspell-tools-cli gzip \"*.trie\"",
+    "prepare:dictionary": "pnpm gz",
     "test": "shx head -n 1000 ./src/Greek.txt | cspell -v -c cspell-ext.json --local=el stdin"
@@ -52,5 +51,5 @@ },
   "devDependencies": {
-    "dictionary-el": "^3.1.0"
+    "dictionary-el": "^4.0.0"
   },
-  "gitHead": "a93ee20360d9a76828b8c40653a0eb253dd34f2b"
+  "gitHead": "ec476361de58eb5206cedf039a977916ace0414a"
 }

src/hunspell/readme.md

 # dictionary-el
 
-Modern Greek spelling dictionary.
+Greek spelling dictionary.
 
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`Dictionary`](#dictionary)
+*   [Examples](#examples)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Contribute](#contribute)
+*   [License](#license)
+
 ## What is this?
 
-This is a Modern Greek dictionary,
-generated by [`wooorm/dictionaries`][dictionaries] from
+This is a Greek dictionary,
+generated by [`wooorm/dictionaries`][github-dictionaries] from
 [`stevestavropoulos/elspell`][source],
@@ -16,7 +30,10 @@ normalized and packaged so that it can be installed and used like other
 You can use this package when integrating with tools that perform spell checking
-(such as [`nodehun`][nodehun], [`nspell`][nspell]) or when making such tools.
+(such as [`nodehun`][github-nodehun] or [`nspell`][github-nspell]) or when
+making such tools.
 
 ## Install
 
-In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
+This package is [ESM only][github-gist-esm].
+In Node.js (version 16+),
+install with [npm][npm-install]:
 
@@ -30,9 +47,6 @@ ```sh
 ```js
-import dictionaryEl from 'dictionary-el'
+import el from 'dictionary-el'
 
-dictionaryEl(function (error, el) {
-  if (error) throw error
-  console.log(el)
-  // To do: use `el` somehow
-})
+console.log(el)
+// To do: use `el` somehow
 ```
@@ -43,48 +57,78 @@
 ```js
-{dic: <Buffer>, aff: <Buffer>}
+{aff: <Buffer>, dic: <Buffer>}
 ```
 
-Where `dic` and `aff` are [`Buffer`][buffer]s for `index.dic` and `index.aff`
-respectively.
+## API
 
+This package exports no identifiers.
+The default export is a [`Dictionary`][api-dictionary].
+
+It exports the [TypeScript][] type
+[`Dictionary`][api-dictionary].
+
+### `Dictionary`
+
+[Hunspell][] dictionary.
+
+###### Fields
+
+*   `aff` ([`Buffer`][node-buffer])
+    — data for the affix file (defines the language, keyboard, flags, and more)
+*   `dic` ([`Buffer`][node-buffer])
+    — data for the dictionary file (contains words and flags applying to those
+    words)
+
 ## Examples
 
-See the [monorepo readme][dictionaries] for examples.
+See the [monorepo readme][github-dictionaries] for examples.
 
-## Types
+## Compatibility
 
-This package is typed with [TypeScript][].
+This projects is compatible with maintained versions of Node.js.
 
+When we cut a new major release,
+we drop support for unmaintained versions of Node.
+This means we try to keep the current release line,
+compatible with Node.js 12.
+
+## Security
+
+This package is safe.
+
 ## Contribute
 
-See the [monorepo readme][dictionaries] for how to contribute.
+See the [monorepo readme][github-dictionaries] for how to contribute.
 
 > 👉 **Note**: dictionaries are not maintained here.
-> Report spelling problems upstream ([`stevestavropoulos/elspell`][source]).
+> Report spelling problems upstream
+> ([`stevestavropoulos/elspell`][source]).
 
 ## License
 
-Dictionary and affix file: [(GPL-2.0 OR LGPL-2.1 OR MPL-1.1)](https://github.com/wooorm/dictionaries/blob/main/dictionaries/el/license).
-Rest: [MIT][] © [Titus Wormer][home].
+Dictionary and affix file:
+[(GPL-2.0 OR LGPL-2.1 OR MPL-1.1)](https://github.com/wooorm/dictionaries/blob/main/dictionaries/el/license).
+Rest: [MIT][file-license] © [Titus Wormer][wooorm].
 
-[hunspell]: https://hunspell.github.io
+[api-dictionary]: #dictionary
 
-[nodehun]: https://github.com/nathanjsweet/nodehun
+[file-license]: https://github.com/wooorm/dictionaries/blob/main/license
 
-[nspell]: https://github.com/wooorm/nspell
+[github-dictionaries]: https://github.com/wooorm/dictionaries
 
-[macos]: https://github.com/wooorm/dictionaries#example-use-with-macos
+[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
-[source]: https://github.com/stevestavropoulos/elspell
+[github-nodehun]: https://github.com/nathanjsweet/nodehun
 
-[npm]: https://docs.npmjs.com/cli/install
+[github-nspell]: https://github.com/wooorm/nspell
 
-[dictionaries]: https://github.com/wooorm/dictionaries
+[hunspell]: https://hunspell.github.io
 
-[mit]: https://github.com/wooorm/dictionaries/blob/main/license
+[node-buffer]: https://nodejs.org/api/buffer.html#buffer_buffer
 
-[buffer]: https://nodejs.org/api/buffer.html#buffer_buffer
+[npm-install]: https://docs.npmjs.com/cli/install
 
-[home]: https://wooorm.com
+[source]: https://github.com/stevestavropoulos/elspell
 
 [typescript]: https://www.typescriptlang.org
+
+[wooorm]: https://wooorm.com

No alert changes

Improved metrics

Total package byte prevSize

1224052

increased by0.06%

No dependency changes