dev: Start implementing cspell-config reader/writer (#2859)

* dev: Start implementing cspell config reader/writer
* Add support for `.json` files.
* Add support for `.yaml` files
* Use Yaml 1.10.2
   Yaml 2 does not work with Node 12

cspell.code-workspace

@@ -13,6 +13,9 @@
         {
             "path": "packages/cspell-bundled-dicts"
         },
+        {
+            "path": "packages/cspell-config"
+        },
         {
             "path": "packages/cspell-dynamic-loader"
         },

packages/cspell-config/.vscode/launch.json

@@ -0,0 +1,39 @@
+{
+    // Use IntelliSense to learn about possible Node.js debug attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "cspell-config: Jest current-file",
+            "program": "${workspaceFolder}/../../node_modules/.bin/jest",
+            "args": [
+                "--runInBand",
+                "${fileBasename}"
+            ],
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "disableOptimisticBPs": true,
+            "windows": {
+                "program": "${workspaceFolder}/../../node_modules/jest/bin/jest",
+            }
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "cspell-config: Jest All",
+            "program": "${workspaceFolder}/../../node_modules/.bin/jest",
+            "args": [
+                "--runInBand"
+            ],
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "disableOptimisticBPs": true,
+            "windows": {
+                "program": "${workspaceFolder}/../../node_modules/jest/bin/jest",
+            }
+        }
+    ]
+}

packages/cspell-config/.vscode/tasks.json

@@ -0,0 +1,22 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "npm",
+            "script": "build",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "problemMatcher": "$tsc"
+        },
+        {
+            "label": "Clean Build",
+            "type": "npm",
+            "script": "clean-build",
+            "problemMatcher": []
+        }
+    ]
+}

packages/cspell-config/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

packages/cspell-config/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jason Dent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/cspell-config/README.md

@@ -0,0 +1,9 @@
+# `cspell-config`
+
+A library to assist reading and writing CSpell configuration files.
+
+## Install
+
+```sh
+npm install -S cspell-config
+```

packages/cspell-config/fixtures/cspell.jsonc

@@ -0,0 +1,11 @@
+{
+    // file version
+    "version": "0.2",
+    "words": [
+        "angle", // with comment
+        // Before "before"
+        "before",
+        "cache",
+        "zebra" // zebra comment
+    ]
+}

packages/cspell-config/fixtures/cspell.yaml

@@ -0,0 +1,9 @@
+---
+# file version
+version: "0.2"
+words:
+  - angle # with comment
+  # Before "before"
+  - before
+  - cache
+  - zebra # zebra comment

packages/cspell-config/fixtures/package/with-value/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "test-package",
+  "cspell": {
+    "words": [
+      "banana"
+    ]
+  }
+}

packages/cspell-config/fixtures/package/without-value/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "test-package"
+}

packages/cspell-config/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('../../jest.config');