@cspell/dict-de-ch - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

package.json

 {
   "name": "@cspell/dict-de-ch",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Swiss German dictionary for CSpell.",
@@ -14,12 +14,11 @@ "publishConfig": {
   "scripts": {
-    "build": "cross-env NODE_OPTIONS=--max_old_space_size=12288 cspell-tools-cli build && yarn run gen-checksum",
-    "sync": "yarn cpy \"../../node_modules/dictionary-de-ch/**\" src/hunspell",
-    "checksum": "shasum -c checksum.txt",
-    "conditional-build": "yarn run --silent checksum || yarn run build",
-    "gen-checksum": "cat source-files.txt source-dependencies.txt | xargs shasum > checksum.txt",
+    "build": "cspell-tools-cli build && pnpm gz",
+    "conditional-build": "pnpm run sync && cspell-tools-cli build --conditional && pnpm gz",
+    "sync": "pnpm cpy \"node_modules/dictionary-de-ch/**\" src/hunspell",
     "test-de": "hunspell-reader words -n 1000 \"src/hunspell/index.dic\" | cspell -v -c ./cspell-ext.json --local=de --languageId=* stdin",
     "test-samples": "cspell -v -c ./cspell-ext.json --local=de,en \"samples/**\"",
-    "test": "yarn run test-de && yarn run test-samples",
-    "prepare": "gzip -f -k *.trie",
-    "prepublishOnly": "yarn run conditional-build && yarn test"
+    "test": "pnpm run test-de && pnpm run test-samples",
+    "gz": "cspell-tools-cli gzip \"*.trie\"",
+    "prepare:dictionary": "pnpm gz",
+    "prepublishOnly": "pnpm run conditional-build && pnpm test"
   },
@@ -50,5 +49,5 @@ "repository": {
   "devDependencies": {
-    "dictionary-de-ch": "^2.1.0"
+    "dictionary-de-ch": "^3.0.0"
   },
-  "gitHead": "5dbea1de0c7234e47732dfe36c07017e6761cf9f"
+  "gitHead": "ec476361de58eb5206cedf039a977916ace0414a"
 }

src/hunspell/readme.md

@@ -5,6 +5,20 @@ # dictionary-de-ch
 
+## 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 German (Switzerland) dictionary,
-generated by [`wooorm/dictionaries`][dictionaries] from
+generated by [`wooorm/dictionaries`][github-dictionaries] from
 [`j3e.de`][source],
@@ -17,7 +31,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]:
 
@@ -31,9 +48,6 @@ ```sh
 ```js
-import dictionaryDeCh from 'dictionary-de-ch'
+import deCh from 'dictionary-de-ch'
 
-dictionaryDeCh(function (error, deCh) {
-  if (error) throw error
-  console.log(deCh)
-  // To do: use `deCh` somehow
-})
+console.log(deCh)
+// To do: use `deCh` somehow
 ```
@@ -44,48 +58,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 ([`j3e.de`][source]).
+> Report spelling problems upstream
+> ([`j3e.de`][source]).
 
 ## License
 
-Dictionary and affix file: [(GPL-2.0 OR GPL-3.0)](https://github.com/wooorm/dictionaries/blob/main/dictionaries/de-CH/license).
-Rest: [MIT][] © [Titus Wormer][home].
+Dictionary and affix file:
+[(GPL-2.0 OR GPL-3.0)](https://github.com/wooorm/dictionaries/blob/main/dictionaries/de-CH/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://www.j3e.de/ispell/igerman98/index_en.html
+[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://www.j3e.de/ispell/igerman98/index_en.html
 
 [typescript]: https://www.typescriptlang.org
+
+[wooorm]: https://wooorm.com

No alert changes

Improved metrics

Total package byte prevSize

849170

0.21%

No dependency changes