chore: Add yarn eslint example (#6460)

cspell.json

@@ -73,7 +73,8 @@
         "test-fixtures/**",
         "test-packages/*/test-cspell-eslint-plugin*/**",
         "test-packages/examples/example-cspell-lib-single-doc/samples/**",
-        "test-packages/*/test-cspell-tools/src/*.txt"
+        "test-packages/*/test-cspell-tools/src/*.txt",
+        "test-packages/yarn/yarn2/test-eslint-plugin/**"
     ],
     "useGitignore": true,
     "flagWords": [],

test-packages/yarn/yarn2/test-eslint-plugin/.gitignore

@@ -0,0 +1,5 @@
+# Ingore .yarn zero install because this is just a test package.
+.yarn/cache
+install-state.gz
+.pnp.js
+.pnp.*

test-packages/yarn/yarn2/test-eslint-plugin/.yarnrc.yml

@@ -0,0 +1,4 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+pnpEnableEsmLoader: true

test-packages/yarn/yarn2/test-eslint-plugin/README.md

@@ -0,0 +1,18 @@
+# Sample Repository using Yarn and `@cspell/eslint-plugin`
+
+**Usage**
+
+```
+yarn
+yarn lint
+```
+
+## Medical Terms Test
+
+This file contains some medical terms to be spell checked.
+
+Sampled full list
+
+abiana
+abiate
+abiatrophy

test-packages/yarn/yarn2/test-eslint-plugin/cspell.config.yaml

@@ -0,0 +1,6 @@
+usePnP: true
+import:
+  - ../cspell.json
+  - '@cspell/dict-medicalterms/cspell-ext.json'
+words:
+  - medicalterms

test-packages/yarn/yarn2/test-eslint-plugin/custom-terms.txt

@@ -0,0 +1 @@
+# Contains custom terms for this project.

test-packages/yarn/yarn2/test-eslint-plugin/eslint.config.mjs

@@ -0,0 +1,13 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import cspellESLintPluginRecommended from '@cspell/eslint-plugin/recommended';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+    { languageOptions: { globals: globals.browser } },
+    pluginJs.configs.recommended,
+    {
+        ignores: ['.pnp.cjs'],
+    },
+    cspellESLintPluginRecommended,
+];

test-packages/yarn/yarn2/test-eslint-plugin/index.mjs

@@ -0,0 +1,84 @@
+export const sampleWords = `
+# Sample Repository using Yarn
+
+# Medical Terms Test
+
+This file contaains some medical terms to be spell checked.
+
+Sampled full list
+
+abiana
+abiate
+abiatrophy
+abiatus
+abid
+abidi
+abidochromis
+abience
+abient
+abietene
+abietic
+abietine
+abietite
+abigeat
+abigei
+Abilify
+abinoxylan
+abio
+AbioCor
+abiogeneses
+abiogenesis
+abiogenetic
+abiogenic
+abiogenist
+abiogenous
+abiogeny
+Abiological
+Abiomed
+AbioMed
+abionergy
+abioseston
+abiosis
+abiotic
+abiotically
+
+ZUMI
+Zung
+Zunrisa
+Zuntz's
+Zuplenz
+Zweifel
+zwitterion
+Zyban
+Zybit
+Zyderm
+Zydis
+Zydone
+Zyflo
+zygal
+zygapophyseal
+zygapophyseales
+zygapophysial
+zygapophysiales
+zygapophysis
+zygia
+zygion
+Zygocotyle
+zygodactyly
+zygoma
+zygomas
+zygomatic
+zygomatica
+zygomatici
+zygomatico
+zygomaticoauricular
+zygomaticofacial
+zygomaticofacialis
+zygomaticofrontal
+zygomaticofrontalis
+zygomaticomaxillaris
+zygomaticomaxillary
+zygomaticosphenoid
+zygomaticotemporal
+zygomaticotemporalis
+`;

test-packages/yarn/yarn2/test-eslint-plugin/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "test-eslint-plugin",
+  "version": "1.0.0",
+  "license": "MIT",
+  "private": true,
+  "packageManager": "yarn@4.5.1",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "yarn update && yarn lint",
+    "update": "yarn add --dev @cspell/dict-medicalterms@latest @cspell/cspell-types@latest @cspell/eslint-plugin@latest"
+  },
+  "devDependencies": {
+    "@cspell/cspell-types": "^8.15.6",
+    "@cspell/dict-medicalterms": "^4.1.5",
+    "@cspell/eslint-plugin": "^8.15.6",
+    "@eslint/js": "^9.14.0",
+    "eslint": "^9.14.0",
+    "globals": "^15.11.0"
+  }
+}