@cspell/dict-ar 1.1.3 → 1.1.5

package/LICENSE

@@ -2,8 +2,7 @@ GNU LESSER GENERAL PUBLIC LICENSE
 
 Version 3, 29 June 2007
 
-Copyright (C) 2007
-Jason Dent
+Copyright (C) 2022-2025 Street Side Software <support@streetsidesoftware.nl>
 
 Everyone is permitted to copy and distribute verbatim copies of this
 license document, but changing it is not allowed.
@@ -15,33 +14,33 @@ below.
 
    0. Additional Definitions.
 
-      
+
 
       As used herein, "this
 License" refers to version 3 of the GNU Lesser General Public License, and the
 "GNU GPL" refers to version 3 of the GNU General Public License.
 
-      
 
-     
+
+
 "The Library" refers to a covered work governed by this License, other than an
 Application or a Combined Work as defined below.
 
-      
+
 
       An "Application"
 is any work that makes use of an interface provided by the Library, but which is
 not otherwise based on the Library. Defining a subclass of a class defined by the
 Library is deemed a mode of using an interface provided by the Library.
 
-      
+
 
 
 A "Combined Work" is a work produced by combining or linking an Application with
 the Library. The particular version of the Library with which the Combined Work
 was made is also called the "Linked Version".
 
-      
+
 
       The "Minimal
 Corresponding Source" for a Combined Work means the Corresponding Source for the
@@ -49,7 +48,7 @@ Combined Work, excluding any source code for portions of the Combined Work that,
 considered in isolation, are based on the Application, and not on the Linked
 Version.
 
-      
+
 
       The "Corresponding Application Code" for a Combined Work
 means the object code and/or source code for the Application, including any data
@@ -126,7 +125,7 @@ permit, the user to recombine or relink the Application with a modified version
 of the Linked Version to produce a modified Combined Work, in the manner
 specified by section 6 of the GNU GPL for conveying Corresponding Source.
 
-      
+
 1) Use a suitable shared library mechanism for linking with the Library. A
 suitable mechanism is one that (a) uses at run time a copy of the Library already
 present on the user's computer system, and (b) will operate properly with a
@@ -177,8 +176,8 @@ Foundation. If the Library as you received it does not specify a version number
 of the GNU Lesser General Public License, you may choose any version of the GNU
 Lesser General Public License ever published by the Free Software Foundation.
 
-  
+
 If the Library as you received it specifies that a proxy can decide whether
 future versions of the GNU Lesser General Public License shall apply, that
 proxy's public statement of acceptance of any version is permanent authorization
-for you to choose that version for the Library.
+for you to choose that version for the Library.

package/README.md

@@ -4,43 +4,133 @@ Arabic dictionary for cspell.
 
 This is a pre-built dictionary for use with CSpell.
 
-## Installation
+<!--- @@inject: ../../static/requirements.md --->
 
-Global Install and add to CSpell global settings.
+## Requirements
+
+| Tool                                                                                                                                 | Version |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
+| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 8`  |
+| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4`  |
+
+<!--- @@inject-end: ../../static/requirements.md --->
+
+<!--- @@inject: ./static/install.md --->
+
+## Local Installation
 
 ```sh
-npm install -g @cspell/dict-ar
-cspell link add @cspell/dict-ar
+npm install -D @cspell/dict-ar
 ```
 
-## Uninstall from CSpell
+## Configuration
 
-```sh
-cspell link remove @cspell/dict-ar
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["@cspell/dict-ar/cspell-ext.json"],
+  "cSpell.language": "ar",
+}
 ```
 
-## Manual Installation
+</details>
+
+<details>
+<summary>CSpell Settings `cspell.json`</summary>
 
-Manual installation is useful if you want to include this dictionary as part of your CI/CD lint process.
+**`cspell.json`**
 
+```jsonc
+{
+  "import": ["@cspell/dict-ar/cspell-ext.json"],
+  "language": "ar",
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings `cspell.config.yaml`</summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - '@cspell/dict-ar/cspell-ext.json'
+language: ar
 ```
-npm i @cspell/dict-ar
+
+</details>
+
+## CDN Configuration
+
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-ar@latest/cspell-ext.json/cspell-ext.json"],
+  "cSpell.language": "ar",
+}
 ```
 
-The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
+</details>
 
-```javascript
+<details>
+<summary>CSpell Settings `cspell.json`</summary>
+
+**`cspell.json`**
+
+```jsonc
 {
-    // …
-    "import": ["@cspell/dict-ar/cspell-ext.json"],
-    // …
+  "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-ar@latest/cspell-ext.json/cspell-ext.json"],
+  "language": "ar",
 }
 ```
 
-# Dictionary Development
+</details>
+
+<details>
+<summary>CSpell Settings `cspell.config.yaml`</summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - https://cdn.jsdelivr.net/npm/@cspell/dict-ar@latest/cspell-ext.json/cspell-ext.json
+language: ar
+```
+
+</details>
+
+<!--- @@inject-end: ./static/install.md --->
+
+<!--- @@inject: ../../static/contributing.md --->
+
+## Contributing
+
+Please help correct any mistakes in the dictionaries.
+
+See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
+
+Special thanks to all of our amazing contributors!
+
+### Dictionary Development
 
 See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
 
+<!--- @@inject-end: ../../static/contributing.md --->
+
 ## Source
 
 [AyaSpell Arabic Dictionary for Hunspell Spellchecker](https://github.com/linuxscout/ayaspell)
@@ -50,3 +140,17 @@ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspe
 LGPL
 
 > Some packages may have other licenses included.
+
+<!--- @@inject: ../../static/footer.md --->
+
+<br/>
+
+---
+
+<p align="center">
+Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
+<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
+</a>
+</p>
+
+<!--- @@inject-end: ../../static/footer.md --->

package/cspell-ext.json

@@ -3,13 +3,13 @@
     "id": "ar",
     "version": "0.2",
     "name": "Arabic",
-    "description": "Arabic dictionary for CSpell.",
+    "description": "Arabic dictionary.",
     "readonly": true,
     "dictionaryDefinitions": [
         {
             "name": "ar",
             "path": "./ar.trie.gz",
-            "description": "Arabic dictionary for CSpell.",
+            "description": "Arabic dictionary.",
             "dictionaryInformation": {
                 "alphabet": "\u0600-\u06ff",
                 "locale": "ar",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/dict-ar",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Arabic dictionary for CSpell.",
   "publishConfig": {
     "access": "public",
@@ -54,5 +54,5 @@
     "*.js",
     "*.d.ts"
   ],
-  "gitHead": "4d80f37a50593b93afd0876b09ec3c879fedf021"
+  "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
 }