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

Comparing version 3.1.0 to 3.1.1

package.json

 {
   "name": "@cspell/dict-de-de",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "German dictionary for cspell.",
@@ -14,19 +14,13 @@ "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/**\" 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/**\" src/hunspell",
     "test-de": "hunspell-reader words -n 1000 \"src/hunspell/index.dic\" | cspell -v -c ./cspell-ext.json --local=de --languageId=* stdin",
     "test-de-old": "hunspell-reader words -n 1000 \"src/German_de_DE.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 && yarn run test-de-old",
-    "prepare": "gzip -f -k *.trie",
-    "prepublishOnly": "yarn run conditional-build && yarn test"
+    "test": "pnpm run test-de && pnpm run test-samples && pnpm run test-de-old",
+    "gz": "cspell-tools-cli gzip \"*.trie\"",
+    "prepare:dictionary": "pnpm gz",
+    "prepublishOnly": "pnpm run conditional-build && pnpm test"
   },
-  "scriptsX": {
-    "build": "cross-env NODE_OPTIONS=--max_old_space_size=4096 cspell-tools compile-trie \"src/German_de_DE.dic\" -M German_de_DE -o .",
-    "test": "hunspell-reader words -n 1000 \"German_de_DE.dic\" | cspell -v -c ./cspell-ext.json --local=de --languageId=* stdin",
-    "prepublishOnly": "echo pre-publish"
-  },
   "repository": {
@@ -58,3 +52,3 @@ "type": "git",
   },
-  "gitHead": "5dbea1de0c7234e47732dfe36c07017e6761cf9f"
+  "gitHead": "13f40d9d575d21316b7c65a0bd5626e627f69b3b"
 }

README.md

@@ -50,2 +50,5 @@ # CSpell German Dictionary
 
-MIT
+GPL-3.0-or-later
+
+> Some packages may have other licenses included.
+> See [src/hunspell/license](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/de_DE/src/hunspell/license) and [src/German_de_DE.txt](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/de_DE/src/German_de_DE.txt)

src/hunspell/readme.md

 # dictionary-de
 
-German spelling dictionary in UTF-8.
+German spelling dictionary.
 
-Useful with [hunspell][], [`nodehun`][nodehun], [`nspell`][nspell],
-Open Office, LibreOffice, Firefox and Thunderbird, or [macOS][].
+## What is this?
 
-Generated by [`dictionaries`][dictionaries] from
-[`j3e.de`][source].
+This is a German dictionary,
+generated by [`wooorm/dictionaries`][dictionaries] from
+[`j3e.de`][source],
+normalized and packaged so that it can be installed and used like other
+dictionaries.
 
+## When should I use this?
+
+You can use this package when integrating with tools that perform spell checking
+(such as [`nodehun`][nodehun], [`nspell`][nspell]) or when making such tools.
+
 ## Install
 
-[npm][]:
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
 
@@ -22,6 +29,8 @@ ```sh
 ```js
-var de = require('dictionary-de')
+import dictionaryDe from 'dictionary-de'
 
-de(function (err, result) {
-  console.log(err || result)
+dictionaryDe(function (error, de) {
+  if (error) throw error
+  console.log(de)
+  // To do: use `de` somehow
 })
@@ -36,16 +45,20 @@ ```
 
-Where `dic` is a [`Buffer`][buffer] for the dictionary file at `index.dic` (in
-UTF-8) and `aff` is a [`Buffer`][buffer] for the affix file at `index.aff` (in
-UTF-8).
+Where `dic` and `aff` are [`Buffer`][buffer]s for `index.dic` and `index.aff`
+respectively.
 
-Or directly load the files, using something like:
+## Examples
 
-```js
-var path = require('path')
-var base = require.resolve('dictionary-de')
+See the [monorepo readme][dictionaries] for examples.
 
-fs.readFileSync(path.join(base, 'index.dic'), 'utf-8')
-fs.readFileSync(path.join(base, 'index.aff'), 'utf-8')
-```
+## Types
 
+This package is typed with [TypeScript][].
+
+## Contribute
+
+See the [monorepo readme][dictionaries] for how to contribute.
+
+> 👉 **Note**: dictionaries are not maintained here.
+> Report spelling problems upstream ([`j3e.de`][source]).
+
 ## License
@@ -62,3 +75,3 @@
 
-[macos]: https://github.com/wooorm/dictionaries#macos
+[macos]: https://github.com/wooorm/dictionaries#example-use-with-macos
 
@@ -76,1 +89,3 @@ [source]: https://www.j3e.de/ispell/igerman98/index_en.html
 [home]: https://wooorm.com
+
+[typescript]: https://www.typescriptlang.org

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

54

increased by5.88%

Worsened metrics

Total package byte prevSize

2274903

decreased by-0.05%

No dependency changes