Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: move shared English words into their own package. #1729

Merged
merged 1 commit into from
Dec 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions dictionaries/en_GB-MIT/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,8 @@
],
"directories": {
"test": "tests"
},
"devDependencies": {
"@cspell/dict-en-shared": "1.0.0"
}
}
2 changes: 1 addition & 1 deletion dictionaries/en_GB-MIT/src/shared-additional-words.txt
3 changes: 2 additions & 1 deletion dictionaries/en_GB/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"test": "tests"
},
"devDependencies": {
"aoo-mozilla-en-dict": "https://github.com/marcoagpinto/aoo-mozilla-en-dict"
"aoo-mozilla-en-dict": "https://github.com/marcoagpinto/aoo-mozilla-en-dict",
"@cspell/dict-en-shared": "1.0.0"
}
}
2 changes: 1 addition & 1 deletion dictionaries/en_GB/src/shared-additional-words.txt
3 changes: 2 additions & 1 deletion dictionaries/en_US/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
"test": "tests"
},
"devDependencies": {
"aoo-mozilla-en-dict": "https://github.com/marcoagpinto/aoo-mozilla-en-dict"
"aoo-mozilla-en-dict": "https://github.com/marcoagpinto/aoo-mozilla-en-dict",
"@cspell/dict-en-shared": "1.0.0"
}
}
2 changes: 1 addition & 1 deletion dictionaries/en_US/src/shared-additional-words.txt
5 changes: 5 additions & 0 deletions dictionaries/en_shared/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Change Log

## 1.0.0

- Initial Release
21 changes: 21 additions & 0 deletions dictionaries/en_shared/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2017-2022 Street Side Software <support@streetsidesoftware.nl>

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.
5 changes: 5 additions & 0 deletions dictionaries/en_shared/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CSpell Shared English Words Dictionary

Note this is a private package used to store and track changes to the shared English words.

It not designed to be published.
44 changes: 44 additions & 0 deletions dictionaries/en_shared/cspell-ext.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// cSpell Settings
{
"id": "en-shared",
"version": "0.2",
"name": "en_shared",
"description": "English words shared between the various English dictionaries.",
"readonly": true,
// List of dictionary files to add to the global list of dictionaries
"dictionaryDefinitions": [
{
"name": "en-shared",
"path": "./dict/en-shared.txt",
"description": "English words shared between the various English dictionaries."
}
],
// Dictionaries to always be used.
// Generally left empty
"dictionaries": [],
// Language Rules to apply to matching files.
// Files are matched on `languageId` and `local`
"languageSettings": [
{
// VSCode languageId. i.e. typescript, java, go, cpp, javascript, markdown, latex
// * will match against any file type.
"languageId": "*",
// Language locale. i.e. en-US, de-AT, or ru. * will match all locales.
// Multiple locales can be specified like: "en, en-US" to match both English and English US.
"locale": "en",
// By default the whole text of a file is included for spell checking
// Adding patterns to the "includeRegExpList" to only include matching patterns
"includeRegExpList": [],
// To exclude patterns, add them to "ignoreRegExpList"
"ignoreRegExpList": [],
// regex patterns than can be used with ignoreRegExpList or includeRegExpList
// Example: "pattern": [{ "name": "mdash", "pattern": "&mdash;" }]
// This could be included in "ignoreRegExpList": ["mdash"]
"patterns": [],
// List of dictionaries to enable by name in `dictionaryDefinitions`
"dictionaries": ["en-shared"],
// Dictionary definitions can also be supplied here. They are only used iff "languageId" and "locale" match.
"dictionaryDefinitions": []
}
]
}
10 changes: 10 additions & 0 deletions dictionaries/en_shared/cspell-tools.config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json

targets:
- name: "en-shared"
sources:
- "src/shared-additional-words.txt"
format: "plaintext"
targetDirectory: "./dict"
generateNonStrict: false
compress: false
12 changes: 12 additions & 0 deletions dictionaries/en_shared/cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": "0.2",
"files": [
"**/*.{md,txt}"
],
"dictionaries": [
"en-shared"
],
"import": [
"./cspell-ext.json"
]
}
3 changes: 3 additions & 0 deletions dictionaries/en_shared/dict/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Dict Directory

NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
38 changes: 38 additions & 0 deletions dictionaries/en_shared/dict/en-shared.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@

# cspell-tools: keep-case no-split

Alpha
Aruban
Arubans
Bonanno
COVID
Centauri
Christoph
Premonstratensians
aesthetical
amphitheatre
anthropomorphization
bicep
cellpadding
conformant
dropshipper
dropshippers
dropshipping
drumless
dryas
eligibilities
endoliths
futhorc
guillemet
heatmap
hmmm
hydrophile
hydrophobe
hyponym
hyponyms
iPads
prepend
reauthenticate
tricep
unintuitive
unplated
47 changes: 47 additions & 0 deletions dictionaries/en_shared/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"name": "@cspell/dict-en-shared",
"version": "1.0.0",
"description": "English words shared between the various English dictionaries. -- Private until verified",
"private": true,
"publishConfig": {
"access": "public"
},
"exports": {
".": "./cspell-ext.json",
"./cspell": "./cspell-ext.json",
"./cspell-ext.json": "./cspell-ext.json"
},
"scripts": {
"build": "cross-env NODE_OPTIONS=--max_old_space_size=8192 cspell-tools-cli build",
"test": "head -n 1000 \"src/shared-additional-words.txt\" | cspell -v -c ./cspell-ext.json \"--local=en\" \"--languageId=*\" stdin",
"prepublishOnly": "echo OK",
"zip": "gzip -k -f dict/en-shared.txt",
"prepare": "yarn run build"
},
"repository": {
"type": "git",
"url": "git+https://github.com/streetsidesoftware/cspell-dicts.git"
},
"keywords": [
"cspell",
"cspell-ext",
"en_shared",
"en_shared",
"dictionary",
"spelling"
],
"author": "Jason Dent",
"license": "MIT",
"bugs": {
"url": "https://github.com/streetsidesoftware/cspell-dicts/issues"
},
"homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/en_shared#readme",
"devDependencies": {},
"dependencies": {},
"files": [
"dict/en-shared.txt",
"cspell-ext.json",
"*.js",
"*.d.ts"
]
}
3 changes: 3 additions & 0 deletions dictionaries/en_shared/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Source Directory

All source files used to generate the dictionary should be stored in this directory.