@w5s/cspell-config 1.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Julien Polo
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,48 @@
1
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=# W5s CSpell configuration _(${name})_) -->
2
+ # W5s CSpell configuration _(@w5s/cspell-config)_
3
+ <!-- AUTO-GENERATED-CONTENT:END -->
4
+
5
+ [![NPM Version][package-version-svg]][package-url]
6
+ [![License][license-image]][license-url]
7
+
8
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=> ${description}&unknownTxt= ) -->
9
+ > CSpell configuration presets
10
+ <!-- AUTO-GENERATED-CONTENT:END -->
11
+
12
+ ## Installation
13
+
14
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=```console\nnpm install --save-dev ${name} cspell\n```) -->
15
+ ```console
16
+ npm install --save-dev @w5s/cspell-config cspell
17
+ ```
18
+ <!-- AUTO-GENERATED-CONTENT:END -->
19
+
20
+ ## Usage
21
+
22
+ In the `.cspell.json` of your project
23
+
24
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=```json\n{\n "import": ["${name}"]\n}\n```) -->
25
+ ```json
26
+ {
27
+ "import": ["@w5s/cspell-config"]
28
+ }
29
+ ```
30
+ <!-- AUTO-GENERATED-CONTENT:END -->
31
+
32
+ ## License
33
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[${license}][license-url] © ${author}) -->
34
+ [MIT][license-url] © Julien Polo <julien.polo@gmail.com>
35
+ <!-- AUTO-GENERATED-CONTENT:END -->
36
+
37
+ <!-- VARIABLES -->
38
+
39
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
40
+ [package-version-svg]: https://img.shields.io/npm/v/@w5s/cspell-config.svg?style=flat-square
41
+ <!-- AUTO-GENERATED-CONTENT:END -->
42
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
43
+ [package-url]: https://www.npmjs.com/package/@w5s/cspell-config
44
+ <!-- AUTO-GENERATED-CONTENT:END -->
45
+ <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
46
+ [license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
47
+ <!-- AUTO-GENERATED-CONTENT:END -->
48
+ [license-url]: ../../LICENSE
@@ -0,0 +1,7 @@
1
+ cjsx
2
+ ctsx
3
+ eslintcache
4
+ mdwn
5
+ mtsx
6
+ pcss
7
+ tsbuildinfo
@@ -0,0 +1,20 @@
1
+ autodevops
2
+ automerge
3
+ camelcase
4
+ circleci
5
+ CODEOWNERS
6
+ commitlint
7
+ editorconfig
8
+ esbuild
9
+ esnext
10
+ githooks
11
+ gitlab
12
+ gitmoji
13
+ gitmojis
14
+ healthcheck
15
+ interruptible
16
+ macOS
17
+ npmjs
18
+ subpackage
19
+ templating
20
+ typedoc
package/dict/names.txt ADDED
@@ -0,0 +1,6 @@
1
+ dbaeumer
2
+ jpolo
3
+ rushstack
4
+ seatonjiang
5
+ strictsoftware
6
+ Stroustrup
@@ -0,0 +1,7 @@
1
+ # cspell-tools: keep-case no-split
2
+
3
+ fcontext
4
+ fdescribe
5
+ ts-nocheck
6
+ xcontext
7
+ xdescribe
package/lib/index.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ import type { AdvancedCSpellSettings } from '@cspell/cspell-types';
2
+ declare const settings: AdvancedCSpellSettings;
3
+ export = settings;
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAsBnE,QAAA,MAAM,QAAQ,EAAE,sBAqEf,CAAC;AAEF,SAAS,QAAQ,CAAC"}
package/lib/index.js ADDED
@@ -0,0 +1,96 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ // @ts-ignore
6
+ const cspell_default_config_js_1 = __importDefault(require("@cspell/cspell-bundled-dicts/cspell-default.config.js"));
7
+ const toArray = (value) => (Array.isArray(value) ? value : value == null ? [] : [value]);
8
+ const defaultSettings = cspell_default_config_js_1.default;
9
+ const excludeImport = new Set([
10
+ '@cspell/dict-ada/cspell-ext.json',
11
+ '@cspell/dict-cpp/cspell-ext.json',
12
+ '@cspell/dict-csharp/cspell-ext.json',
13
+ '@cspell/dict-django/cspell-ext.json',
14
+ '@cspell/dict-dotnet/cspell-ext.json',
15
+ '@cspell/dict-elixir/cspell-ext.json',
16
+ '@cspell/dict-haskell/cspell-ext.json',
17
+ '@cspell/dict-latex/cspell-ext.json',
18
+ '@cspell/dict-lua/cspell-ext.json',
19
+ '@cspell/dict-php/cspell-ext.json',
20
+ '@cspell/dict-powershell/cspell-ext.json',
21
+ '@cspell/dict-python/cspell-ext.json',
22
+ '@cspell/dict-r/cspell-ext.json',
23
+ '@cspell/dict-scala/cspell-ext.json',
24
+ ]);
25
+ const settings = {
26
+ ...defaultSettings,
27
+ name: 'W5s default settings .js',
28
+ id: 'w5s-default-js',
29
+ language: 'en',
30
+ description: 'Default cspell configuration.',
31
+ words: [],
32
+ flagWords: [],
33
+ dictionaryDefinitions: [
34
+ ...toArray(defaultSettings.dictionaryDefinitions),
35
+ {
36
+ addWords: false,
37
+ name: 'w5s-filetypes',
38
+ path: '../dict/filetypes.txt',
39
+ description: 'Additional file types',
40
+ },
41
+ {
42
+ name: 'w5s-fullstack',
43
+ path: '../dict/fullstack.txt',
44
+ description: 'Fullstack terms',
45
+ },
46
+ {
47
+ addWords: false,
48
+ name: 'w5s-typescript',
49
+ path: '../dict/typescript.txt',
50
+ description: 'Typescript keywords',
51
+ },
52
+ {
53
+ addWords: false,
54
+ name: 'w5s-names',
55
+ path: '../dict/names.txt',
56
+ description: 'Known names',
57
+ },
58
+ ],
59
+ dictionaries: [...toArray(defaultSettings.dictionaries), 'w5s-filetypes', 'w5s-fullstack', 'w5s-names'],
60
+ ignoreWords: [],
61
+ import: toArray(defaultSettings.import).filter((dict) => !excludeImport.has(dict)),
62
+ ignorePaths: [
63
+ ...toArray(defaultSettings.ignorePaths),
64
+ 'CHANGELOG.md',
65
+ '**/__snapshots__/**',
66
+ // '**/.git/**',
67
+ '**/.vscode/**',
68
+ '**/*.log',
69
+ '**/*.snap',
70
+ '**/build/**',
71
+ '**/dist/**',
72
+ '**/lib/**',
73
+ '**/node_modules/**',
74
+ '**/package-lock.json',
75
+ '**/renovate.json',
76
+ '**/vscode-extension/**',
77
+ '**/yarn.lock',
78
+ '**/apps/*/CHANGELOG.md',
79
+ '**/packages/*/CHANGELOG.md',
80
+ 'pnpm-lock.yaml',
81
+ ],
82
+ languageSettings: [
83
+ ...toArray(defaultSettings.languageSettings),
84
+ {
85
+ languageId: 'typescript,javascript,typescriptreact,javascriptreact',
86
+ locale: '*',
87
+ includeRegExpList: [],
88
+ ignoreRegExpList: ['js-hex-escape', 'js-unicode-escape', 'js-regexp-flags'],
89
+ patterns: [],
90
+ dictionaries: ['w5s-typescript'],
91
+ dictionaryDefinitions: [],
92
+ },
93
+ ],
94
+ };
95
+ module.exports = settings;
96
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AACA,aAAa;AACb,qHAAmF;AAEnF,MAAM,OAAO,GAAG,CAAI,KAA0B,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACjH,MAAM,eAAe,GAAG,kCAAwC,CAAC;AACjE,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,kCAAkC;IAClC,kCAAkC;IAClC,qCAAqC;IACrC,qCAAqC;IACrC,qCAAqC;IACrC,qCAAqC;IACrC,sCAAsC;IACtC,oCAAoC;IACpC,kCAAkC;IAClC,kCAAkC;IAClC,yCAAyC;IACzC,qCAAqC;IACrC,gCAAgC;IAChC,oCAAoC;CACrC,CAAC,CAAC;AACH,MAAM,QAAQ,GAA2B;IACvC,GAAG,eAAe;IAClB,IAAI,EAAE,0BAA0B;IAChC,EAAE,EAAE,gBAAgB;IACpB,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,+BAA+B;IAC5C,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,EAAE;IACb,qBAAqB,EAAE;QACrB,GAAG,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC;QACjD;YACE,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EAAE,uBAAuB;SACrC;QACD;YACE,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EAAE,iBAAiB;SAC/B;QACD;YACE,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,wBAAwB;YAC9B,WAAW,EAAE,qBAAqB;SACnC;QACD;YACE,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,mBAAmB;YACzB,WAAW,EAAE,aAAa;SAC3B;KACF;IACD,YAAY,EAAE,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,CAAC;IACvG,WAAW,EAAE,EAAE;IACf,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClF,WAAW,EAAE;QACX,GAAG,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC;QACvC,cAAc;QACd,qBAAqB;QACrB,gBAAgB;QAChB,eAAe;QACf,UAAU;QACV,WAAW;QACX,aAAa;QACb,YAAY;QACZ,WAAW;QACX,oBAAoB;QACpB,sBAAsB;QACtB,kBAAkB;QAClB,wBAAwB;QACxB,cAAc;QACd,wBAAwB;QACxB,4BAA4B;QAC5B,gBAAgB;KACjB;IACD,gBAAgB,EAAE;QAChB,GAAG,OAAO,CAAC,eAAe,CAAC,gBAAgB,CAAC;QAC5C;YACE,UAAU,EAAE,uDAAuD;YACnE,MAAM,EAAE,GAAG;YACX,iBAAiB,EAAE,EAAE;YACrB,gBAAgB,EAAE,CAAC,eAAe,EAAE,mBAAmB,EAAE,iBAAiB,CAAC;YAC3E,QAAQ,EAAE,EAAE;YACZ,YAAY,EAAE,CAAC,gBAAgB,CAAC;YAChC,qBAAqB,EAAE,EAAE;SAC1B;KACF;CACF,CAAC;AAEF,iBAAS,QAAQ,CAAC"}
package/package.json ADDED
@@ -0,0 +1,84 @@
1
+ {
2
+ "name": "@w5s/cspell-config",
3
+ "version": "1.0.0-alpha.1",
4
+ "description": "CSpell configuration presets",
5
+ "keywords": [
6
+ "cspell"
7
+ ],
8
+ "homepage": "https://github.com/w5s/project-config/blob/main/packages/cspell-config#readme",
9
+ "bugs": {
10
+ "url": "https://github.com/w5s/project-config/issues"
11
+ },
12
+ "repository": {
13
+ "type": "git",
14
+ "url": "git@github.com:w5s/project-config.git",
15
+ "directory": "packages/cspell-config"
16
+ },
17
+ "license": "MIT",
18
+ "author": "Julien Polo <julien.polo@gmail.com>",
19
+ "type": "commonjs",
20
+ "exports": {
21
+ ".": "./cspell-ext.json",
22
+ "./cspell-ext.json": "./cspell-ext.json",
23
+ "./lib/*": "./lib/*",
24
+ "./dict/*": "./dict/*"
25
+ },
26
+ "typings": "./index.d.ts",
27
+ "files": [
28
+ "dict/**/*",
29
+ "lib/**/!(*.spec).d.ts",
30
+ "lib/**/!(*.spec).d.ts.map",
31
+ "lib/**/!(*.spec).js.map",
32
+ "lib/**/!(*.spec).js",
33
+ "src/**/!(*.spec).ts"
34
+ ],
35
+ "scripts": {
36
+ "__build:dict": "cd dict;cspell-tools-cli compile filetypes.txt",
37
+ "build": "concurrently \"npm:build:*\" \":\"",
38
+ "build:src": "tsc",
39
+ "clean": "concurrently \"npm:clean:*\" \":\"",
40
+ "clean:src": "rm -rf lib/*",
41
+ "docs": "md-magic --path '**/*.md' --ignore='node_modules'",
42
+ "format": "concurrently \"npm:format:*\" \":\"",
43
+ "format:src": "eslint . --fix --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
44
+ "lint": "concurrently \"npm:lint:*\" \":\"",
45
+ "lint:src": "eslint . --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
46
+ "prepare": "concurrently \"npm:prepare:*\" \":\"",
47
+ "prepublishOnly": "npm run clean;npm run build",
48
+ "spellcheck": "cspell --no-progress '**'",
49
+ "test": "concurrently \"npm:test:*\" ",
50
+ "test:src": "exit 0"
51
+ },
52
+ "jest": {
53
+ "moduleNameMapper": {
54
+ "^(\\.{1,2}/.*)\\.js$": "$1"
55
+ },
56
+ "preset": "es-jest",
57
+ "testPathIgnorePatterns": [
58
+ "/node_modules/",
59
+ "/lib/",
60
+ "/build/",
61
+ "/.cache/",
62
+ "/docs/",
63
+ "/public/"
64
+ ]
65
+ },
66
+ "dependencies": {
67
+ "@cspell/cspell-bundled-dicts": "^6.0.0"
68
+ },
69
+ "devDependencies": {
70
+ "@cspell/cspell-tools": "^6.18.0",
71
+ "@cspell/cspell-types": "^6.18.0",
72
+ "@jest/globals": "29.3.1"
73
+ },
74
+ "peerDependencies": {
75
+ "cspell": "^6.0.0"
76
+ },
77
+ "engines": {
78
+ "node": ">=16.0.0"
79
+ },
80
+ "publishConfig": {
81
+ "access": "public"
82
+ },
83
+ "gitHead": "8208d001778969aa2dbe145ef9a4e9d836ff0c04"
84
+ }
package/src/index.ts ADDED
@@ -0,0 +1,94 @@
1
+ import type { AdvancedCSpellSettings } from '@cspell/cspell-types';
2
+ // @ts-ignore
3
+ import cSpellSettings from '@cspell/cspell-bundled-dicts/cspell-default.config.js';
4
+
5
+ const toArray = <T>(value: T | T[] | undefined) => (Array.isArray(value) ? value : value == null ? [] : [value]);
6
+ const defaultSettings = cSpellSettings as AdvancedCSpellSettings;
7
+ const excludeImport = new Set([
8
+ '@cspell/dict-ada/cspell-ext.json',
9
+ '@cspell/dict-cpp/cspell-ext.json',
10
+ '@cspell/dict-csharp/cspell-ext.json',
11
+ '@cspell/dict-django/cspell-ext.json',
12
+ '@cspell/dict-dotnet/cspell-ext.json',
13
+ '@cspell/dict-elixir/cspell-ext.json',
14
+ '@cspell/dict-haskell/cspell-ext.json',
15
+ '@cspell/dict-latex/cspell-ext.json',
16
+ '@cspell/dict-lua/cspell-ext.json',
17
+ '@cspell/dict-php/cspell-ext.json',
18
+ '@cspell/dict-powershell/cspell-ext.json',
19
+ '@cspell/dict-python/cspell-ext.json',
20
+ '@cspell/dict-r/cspell-ext.json',
21
+ '@cspell/dict-scala/cspell-ext.json',
22
+ ]);
23
+ const settings: AdvancedCSpellSettings = {
24
+ ...defaultSettings,
25
+ name: 'W5s default settings .js',
26
+ id: 'w5s-default-js',
27
+ language: 'en',
28
+ description: 'Default cspell configuration.',
29
+ words: [],
30
+ flagWords: [],
31
+ dictionaryDefinitions: [
32
+ ...toArray(defaultSettings.dictionaryDefinitions),
33
+ {
34
+ addWords: false,
35
+ name: 'w5s-filetypes',
36
+ path: '../dict/filetypes.txt',
37
+ description: 'Additional file types',
38
+ },
39
+ {
40
+ name: 'w5s-fullstack',
41
+ path: '../dict/fullstack.txt',
42
+ description: 'Fullstack terms',
43
+ },
44
+ {
45
+ addWords: false,
46
+ name: 'w5s-typescript',
47
+ path: '../dict/typescript.txt',
48
+ description: 'Typescript keywords',
49
+ },
50
+ {
51
+ addWords: false,
52
+ name: 'w5s-names',
53
+ path: '../dict/names.txt',
54
+ description: 'Known names',
55
+ },
56
+ ],
57
+ dictionaries: [...toArray(defaultSettings.dictionaries), 'w5s-filetypes', 'w5s-fullstack', 'w5s-names'],
58
+ ignoreWords: [],
59
+ import: toArray(defaultSettings.import).filter((dict) => !excludeImport.has(dict)),
60
+ ignorePaths: [
61
+ ...toArray(defaultSettings.ignorePaths),
62
+ 'CHANGELOG.md',
63
+ '**/__snapshots__/**',
64
+ // '**/.git/**',
65
+ '**/.vscode/**',
66
+ '**/*.log',
67
+ '**/*.snap',
68
+ '**/build/**',
69
+ '**/dist/**',
70
+ '**/lib/**',
71
+ '**/node_modules/**',
72
+ '**/package-lock.json',
73
+ '**/renovate.json',
74
+ '**/vscode-extension/**',
75
+ '**/yarn.lock',
76
+ '**/apps/*/CHANGELOG.md',
77
+ '**/packages/*/CHANGELOG.md',
78
+ 'pnpm-lock.yaml',
79
+ ],
80
+ languageSettings: [
81
+ ...toArray(defaultSettings.languageSettings),
82
+ {
83
+ languageId: 'typescript,javascript,typescriptreact,javascriptreact',
84
+ locale: '*',
85
+ includeRegExpList: [],
86
+ ignoreRegExpList: ['js-hex-escape', 'js-unicode-escape', 'js-regexp-flags'],
87
+ patterns: [],
88
+ dictionaries: ['w5s-typescript'],
89
+ dictionaryDefinitions: [],
90
+ },
91
+ ],
92
+ };
93
+
94
+ export = settings;