<!-- lint disable no-html -->

dictionaries

Collection of normalized and installable [hunspell][] dictionaries.

Contents

• What is this?
• When should I use this?
• Install
• Use
• List of dictionaries
• Examples
  • Example: use with nspell
  • Example: load files
  • Example: use with macOS
• Types
• Security
• Contribute
  • Build
  • Updating a dictionary
  • Adding a new dictionary
• License

What is this?

This monorepo is a bunch of scripts that crawls dictionaries from several sources, normalizes them, and packs them so that they can each be installed and used in one single way. Dictionaries are not maintained here but they are usable from here.

When should I use this?

You can particularly use the packages here as a programmer when integrating with other tools (such as [nodehun][github-nodehun] or [nspell][github-nspell]) or when making such tools.

Install

These packages are [ESM only][github-gist-esm]. In Node.js (version 16+), install with [npm][npm-install]:

npm install dictionary-en

👉 Note: replace en with the language code you want.

⚠️ Important: this project itself is MIT, but each index.dic and index.aff file still has its original license!

Use

import en from 'dictionary-en'

console.log(en)
// To do: use `en` somehow

Yields:

{aff: <Buffer>, dic: <Buffer>}

List of dictionaries

👉 Note: preferred BCP-47 codes are used (according to Unicode CLDR). To illustrate, as American English and Brazilian Portuguese are the most common types of English and Portuguese respectively, they get the codes en and pt.

<!--support start-->

In total 92 dictionaries are provided.

| Name | Description | License | | - | - | - | | dictionary-bg | Bulgarian | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-br | Breton | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-ca | Catalan | (GPL-2.0 OR LGPL-2.1) | | dictionary-ca-valencia | Catalan (Valencia) | (GPL-2.0 OR LGPL-2.1) | | dictionary-cs | Czech | GPL-2.0 | | dictionary-cy | Welsh | LGPL-3.0 | | dictionary-da | Danish | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-de | German | (GPL-2.0 OR GPL-3.0) | | dictionary-de-at | German (Austria) | (GPL-2.0 OR GPL-3.0) | | dictionary-de-ch | German (Switzerland) | (GPL-2.0 OR GPL-3.0) | | dictionary-el | Greek | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-el-polyton | Greek (Polyton) | GPL-3.0 | | dictionary-en | English | (MIT AND BSD) | | dictionary-en-au | English (Australia) | (MIT AND BSD) | | dictionary-en-ca | English (Canada) | (MIT AND BSD) | | dictionary-en-gb | English (United Kingdom) | (MIT AND BSD) | | dictionary-en-za | English (South Africa) | LGPL-2.1 | | dictionary-eo | Esperanto | GPL-2.0 | | dictionary-es | Spanish | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-ar | Spanish (Argentina) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-bo | Spanish (Bolivia) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-cl | Spanish (Chile) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-co | Spanish (Colombia) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-cr | Spanish (Costa Rica) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-cu | Spanish (Cuba) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-do | Spanish (Dominican Republic) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-ec | Spanish (Ecuador) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-gt | Spanish (Guatemala) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-hn | Spanish (Honduras) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-mx | Spanish (Mexico) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-ni | Spanish (Nicaragua) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-pa | Spanish (Panama) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-pe | Spanish (Peru) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-ph | Spanish (Philippines) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-pr | Spanish (Puerto Rico) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-py | Spanish (Paraguay) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-sv | Spanish (El Salvador) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-us | Spanish (United States of America) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-uy | Spanish (Uruguay) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-es-ve | Spanish (Venezuela) | (GPL-3.0 OR LGPL-3.0 OR MPL-1.1) | | dictionary-et | Estonian | LGPL-2.1 | | dictionary-eu | Basque | GPL-2.0 | | dictionary-fa | Persian | Apache-2.0 | | dictionary-fo | Faroese | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-fr | French | MPL-2.0 | | dictionary-fur | Friulian | GPL-2.0 | | dictionary-fy | Western Frisian | GPL-3.0 | | dictionary-ga | Irish | GPL-2.0 | | dictionary-gd | Scottish Gaelic | GPL-3.0 | | dictionary-gl | Galician | GPL-3.0 | | dictionary-he | Hebrew | AGPL-3.0 | | dictionary-hr | Croatian | (LGPL-2.1 OR SISSL) | | dictionary-hu | Hungarian | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-hy | Armenian | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-hyw | Western Armenian | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-ia | Interlingua | GPL-3.0 | | dictionary-ie | Interlingue | Apache-2.0 | | dictionary-is | Icelandic | CC-BY-SA-3.0 | | dictionary-it | Italian | GPL-3.0 | | dictionary-ka | Georgian | MIT | | dictionary-ko | Korean | (GPL-2.0 OR LGPL-2.1 OR MPL-1.1) | | dictionary-la | Latin | GPL-2.0 | | dictionary-lb | Luxembourgish | EUPL-1.1 | | dictionary-lt | Lithuanian | BSD-3-Clause | | dictionary-ltg | Latgalian | LGPL-2.1 | | dictionary-lv | Latvian | LGPL-2.1 | | dictionary-mk | Macedonian | GPL-3.0 | | dictionary-mn | Mongolian | LPPL-1.3c | | dictionary-nb | Norwegian Bokmål | GPL-2.0 | | dictionary-nds | Low German | GPL-3.0 | | dictionary-ne | Nepali | LGPL-2.1 | | dictionary-nl | Dutch | (BSD-3-Clause OR CC-BY-3.0) | | dictionary-nn | Norwegian Nynorsk | GPL-2.0 | | dictionary-oc |