@cssdoc/cssdoc 0.2.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/README.md +32 -0
- package/dist/index.d.mts +3 -0
- package/dist/index.mjs +4 -0
- package/package.json +51 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Danny Wahl
|
|
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,32 @@
|
|
|
1
|
+
# @cssdoc/cssdoc
|
|
2
|
+
|
|
3
|
+
TSDoc, for CSS. This is the umbrella package: install it for the whole programmatic API in one
|
|
4
|
+
import, or reach for the scoped packages à la carte.
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
npm add @cssdoc/cssdoc
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
import { parseCssDocs, createIndex, lintModel } from "@cssdoc/cssdoc";
|
|
12
|
+
|
|
13
|
+
const model = parseCssDocs(css);
|
|
14
|
+
const findings = lintModel(createIndex(css));
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
It re-exports the three browser-safe building blocks. Loading `cssdoc.json` is Node-only, so add
|
|
18
|
+
`@cssdoc/config` when you need it.
|
|
19
|
+
|
|
20
|
+
## Which package do I need?
|
|
21
|
+
|
|
22
|
+
| I want to… | Package |
|
|
23
|
+
| ------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
24
|
+
| Parse CSS + doc-comments into a model | `@cssdoc/core` |
|
|
25
|
+
| Query the model with source spans | `@cssdoc/index` |
|
|
26
|
+
| Lint, complete, hover, go-to-definition | `@cssdoc/providers` |
|
|
27
|
+
| **All of the above, one import** | **`@cssdoc/cssdoc`** |
|
|
28
|
+
| Load a `cssdoc.json` / `cssdoc.jsonc` (Node) | `@cssdoc/config` |
|
|
29
|
+
| The canonical tag vocabulary + grammar | `@cssdoc/spec` |
|
|
30
|
+
| Syntax highlighting (TextMate / Shiki / VS Code) | `@cssdoc/tmlanguage` |
|
|
31
|
+
| Syntax highlighting (CodeMirror 6) | `@cssdoc/codemirror` |
|
|
32
|
+
| ESLint / Stylelint / TypeDoc integration | `@cssdoc/eslint-plugin` · `@cssdoc/stylelint-plugin` · `@cssdoc/typedoc` |
|
package/dist/index.d.mts
ADDED
package/dist/index.mjs
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@cssdoc/cssdoc",
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "The cssdoc programmatic API in one install — re-exports @cssdoc/core, @cssdoc/index, and @cssdoc/providers. TSDoc, for CSS.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"css",
|
|
7
|
+
"cssdoc",
|
|
8
|
+
"documentation",
|
|
9
|
+
"linter",
|
|
10
|
+
"tsdoc"
|
|
11
|
+
],
|
|
12
|
+
"homepage": "https://cssdoc.dev",
|
|
13
|
+
"bugs": "https://github.com/thedannywahl/cssdoc/issues",
|
|
14
|
+
"license": "MIT",
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "git+https://github.com/thedannywahl/cssdoc.git",
|
|
18
|
+
"directory": "packages/cssdoc"
|
|
19
|
+
},
|
|
20
|
+
"files": [
|
|
21
|
+
"dist"
|
|
22
|
+
],
|
|
23
|
+
"type": "module",
|
|
24
|
+
"exports": {
|
|
25
|
+
".": "./dist/index.mjs",
|
|
26
|
+
"./package.json": "./package.json"
|
|
27
|
+
},
|
|
28
|
+
"publishConfig": {
|
|
29
|
+
"access": "public"
|
|
30
|
+
},
|
|
31
|
+
"dependencies": {
|
|
32
|
+
"@cssdoc/index": "0.2.0",
|
|
33
|
+
"@cssdoc/core": "0.2.0",
|
|
34
|
+
"@cssdoc/providers": "0.2.0"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"@types/node": "^24.13.3",
|
|
38
|
+
"@vitest/coverage-v8": "4.1.9",
|
|
39
|
+
"publint": "^0.3.21",
|
|
40
|
+
"typescript": "^6.0.3",
|
|
41
|
+
"vite": "npm:@voidzero-dev/vite-plus-core@0.2.4",
|
|
42
|
+
"vite-plus": "0.2.4"
|
|
43
|
+
},
|
|
44
|
+
"scripts": {
|
|
45
|
+
"build": "vp pack",
|
|
46
|
+
"dev": "vp pack --watch",
|
|
47
|
+
"test": "vp test",
|
|
48
|
+
"check": "vp check",
|
|
49
|
+
"publint": "publint"
|
|
50
|
+
}
|
|
51
|
+
}
|