Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@cspell/dict-de-de
Advanced tools
@cspell/dict-de-de - npm Package Compare versions
Comparing version 3.1.1 to 3.2.0
| { | ||
| "name": "@cspell/dict-de-de", | ||
| "version": "3.1.1", | ||
| "version": "3.2.0", | ||
| "description": "German dictionary for cspell.", | ||
@@ -49,5 +49,5 @@ "publishConfig": { | ||
| "devDependencies": { | ||
| "dictionary-de": "^2.1.0" | ||
| "dictionary-de": "^3.0.0" | ||
| }, | ||
| "gitHead": "13f40d9d575d21316b7c65a0bd5626e627f69b3b" | ||
| "gitHead": "ec476361de58eb5206cedf039a977916ace0414a" | ||
| } |
@@ -5,6 +5,20 @@ # dictionary-de | ||
| ## 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 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 dictionaryDe from 'dictionary-de' | ||
| import de from 'dictionary-de' | ||
| dictionaryDe(function (error, de) { | ||
| if (error) throw error | ||
| console.log(de) | ||
| // To do: use `de` somehow | ||
| }) | ||
| console.log(de) | ||
| // To do: use `de` 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/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/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 |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.15%
2278218
No dependency changes