@kitschpatrol/cspell-config 1.0.0
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 +21 -0
- package/init/.cspell.json +3 -0
- package/init.js +22 -0
- package/main.json +94 -0
- package/package.json +35 -0
- package/readme.md +47 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Eric Mika
|
|
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/init.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import console from 'node:console';
|
|
2
|
+
import fs from 'node:fs';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import process from 'node:process';
|
|
5
|
+
import { fileURLToPath } from 'node:url';
|
|
6
|
+
|
|
7
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
8
|
+
|
|
9
|
+
const sourceDirectory = path.join(__dirname, 'init');
|
|
10
|
+
const destinationDirectory = process.cwd(); // (project root)
|
|
11
|
+
|
|
12
|
+
for (const file of fs.readdirSync(sourceDirectory)) {
|
|
13
|
+
const sourcePath = path.join(sourceDirectory, file);
|
|
14
|
+
const destinationPath = path.join(destinationDirectory, file);
|
|
15
|
+
|
|
16
|
+
if (fs.existsSync(destinationPath)) {
|
|
17
|
+
console.log(`${file} already exists in project root, skipping.`);
|
|
18
|
+
} else {
|
|
19
|
+
fs.copyFileSync(sourcePath, destinationPath);
|
|
20
|
+
console.log(`Copied ${file} to project root.`);
|
|
21
|
+
}
|
|
22
|
+
}
|
package/main.json
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
|
|
3
|
+
"enabled": true,
|
|
4
|
+
"enableFiletypes": ["astro", "svelte", "md", "mdx", "patch"],
|
|
5
|
+
"globRoot": "/",
|
|
6
|
+
"ignorePaths": ["pnpm-lock.yaml"],
|
|
7
|
+
"ignoreRegExpList": ["tp-.+", "tweakpane-plugin-.+"],
|
|
8
|
+
"language": "en,en-US",
|
|
9
|
+
"useGitignore": true,
|
|
10
|
+
"version": "0.2",
|
|
11
|
+
"words": [
|
|
12
|
+
"0b5vr",
|
|
13
|
+
"apos",
|
|
14
|
+
"Astro",
|
|
15
|
+
"astrojs",
|
|
16
|
+
"ayamflow",
|
|
17
|
+
"Bansal",
|
|
18
|
+
"beforeunload",
|
|
19
|
+
"bindability",
|
|
20
|
+
"buttongrid",
|
|
21
|
+
"camerakit",
|
|
22
|
+
"cameraring",
|
|
23
|
+
"camerawheel",
|
|
24
|
+
"colspan",
|
|
25
|
+
"crossorigin",
|
|
26
|
+
"cubicbezier",
|
|
27
|
+
"discoverability",
|
|
28
|
+
"Dmitriy",
|
|
29
|
+
"donmccurdy",
|
|
30
|
+
"Draggability",
|
|
31
|
+
"Fira",
|
|
32
|
+
"Florian",
|
|
33
|
+
"fontsource",
|
|
34
|
+
"FOUC",
|
|
35
|
+
"FOUSC",
|
|
36
|
+
"fpsgraph",
|
|
37
|
+
"frontmatter",
|
|
38
|
+
"Goliński",
|
|
39
|
+
"haml",
|
|
40
|
+
"hashchange",
|
|
41
|
+
"Hiroki",
|
|
42
|
+
"Jakub",
|
|
43
|
+
"jankiness",
|
|
44
|
+
"jetblack",
|
|
45
|
+
"JUCE",
|
|
46
|
+
"KitDocs",
|
|
47
|
+
"kitschpatrol",
|
|
48
|
+
"Kokubun",
|
|
49
|
+
"Koźniewski",
|
|
50
|
+
"Krzysztof",
|
|
51
|
+
"labelledby",
|
|
52
|
+
"lerp",
|
|
53
|
+
"linkedom",
|
|
54
|
+
"linkify",
|
|
55
|
+
"markdownit",
|
|
56
|
+
"Matheus",
|
|
57
|
+
"Matija",
|
|
58
|
+
"Menlo",
|
|
59
|
+
"metehus",
|
|
60
|
+
"Mika",
|
|
61
|
+
"Nikiforov",
|
|
62
|
+
"noopener",
|
|
63
|
+
"noreferrer",
|
|
64
|
+
"pagefind",
|
|
65
|
+
"Palash",
|
|
66
|
+
"Panebuilder",
|
|
67
|
+
"Panepaint",
|
|
68
|
+
"phenomnomnominal",
|
|
69
|
+
"radiogrid",
|
|
70
|
+
"rehype",
|
|
71
|
+
"repalash",
|
|
72
|
+
"resizability",
|
|
73
|
+
"rgba",
|
|
74
|
+
"Roboto",
|
|
75
|
+
"rseidelsohn",
|
|
76
|
+
"Schödler",
|
|
77
|
+
"shoedler",
|
|
78
|
+
"skeuomorphic",
|
|
79
|
+
"STUI",
|
|
80
|
+
"stylelint",
|
|
81
|
+
"stylelintrc",
|
|
82
|
+
"svelteness",
|
|
83
|
+
"Sveltepress",
|
|
84
|
+
"tailwindcss",
|
|
85
|
+
"tbody",
|
|
86
|
+
"thead",
|
|
87
|
+
"Threlte",
|
|
88
|
+
"tsconfigs",
|
|
89
|
+
"tsquery",
|
|
90
|
+
"tweakpane",
|
|
91
|
+
"unplugin",
|
|
92
|
+
"wght"
|
|
93
|
+
]
|
|
94
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@kitschpatrol/cspell-config",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "CSPell config for @kitschpatrol/shared-config",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git@github.com:kitschpatrol/shared-config.git",
|
|
9
|
+
"directory": "packages/cspell-config"
|
|
10
|
+
},
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/kitschpatrol/shared-config/issues",
|
|
13
|
+
"email": "eric@ericmika.com"
|
|
14
|
+
},
|
|
15
|
+
"author": {
|
|
16
|
+
"name": "Eric Mika",
|
|
17
|
+
"email": "eric@ericmika.com",
|
|
18
|
+
"url": "https://ericmika.com"
|
|
19
|
+
},
|
|
20
|
+
"license": "MIT",
|
|
21
|
+
"engines": {
|
|
22
|
+
"node": ">=18.0.0",
|
|
23
|
+
"pnpm": ">=8.0.0"
|
|
24
|
+
},
|
|
25
|
+
"bin": {
|
|
26
|
+
"cspell-config-init": "./init.js"
|
|
27
|
+
},
|
|
28
|
+
"main": "main.json",
|
|
29
|
+
"peerDependencies": {
|
|
30
|
+
"cspell": "^8.1.3"
|
|
31
|
+
},
|
|
32
|
+
"publishConfig": {
|
|
33
|
+
"access": "public"
|
|
34
|
+
}
|
|
35
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @kitschpatrol/cspell-config
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
It's a shared [CSpell](https://cspell.org) config.
|
|
6
|
+
|
|
7
|
+
**See [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) for the recommended single-package approach.**
|
|
8
|
+
|
|
9
|
+
## Setup
|
|
10
|
+
|
|
11
|
+
To use just this CSpell config in isolation:
|
|
12
|
+
|
|
13
|
+
1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
pnpm dlx @kitschpatrol/npm-config
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
2. Add the package:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
pnpm add @kitschpatrol/cspell-config
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
3. Add the starter `.cspell.json` file to your project root, and add any customizations you'd like:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
pnpm exec cspell-config-init
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
The CSpell binary should be picked up automatically by VSCode plugins.
|
|
34
|
+
|
|
35
|
+
Integrate with your `package.json` scripts as you see fit, for example:
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
...
|
|
39
|
+
"scripts": {
|
|
40
|
+
"spellcheck": "cspell --quiet ."
|
|
41
|
+
}
|
|
42
|
+
...
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Notes
|
|
46
|
+
|
|
47
|
+
This config includes a bunch of words I've happened to have needed to use. Your preferences will vary.
|