viewlint 0.0.2 → 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/README.md +37 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,39 @@
|
|
|
1
1
|
# viewlint
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[GitHub](https://github.com/EvanZhouDev/viewlint) | [Documentation](https://viewlint.vercel.app/docs)
|
|
4
|
+
|
|
5
|
+
`viewlint` is the core ViewLint package. It provides the `viewlint` CLI and the `ViewLint` class for programmatic linting.
|
|
6
|
+
|
|
7
|
+
## Quick Start (Recommended)
|
|
8
|
+
|
|
9
|
+
Initialize ViewLint:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm init @viewlint/config@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Run it on a URL:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx viewlint https://example.com
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## What This Package Does
|
|
22
|
+
|
|
23
|
+
- Discovers and loads `viewlint.config.ts`, `viewlint.config.mjs`, or `viewlint.config.js`
|
|
24
|
+
- Resolves views, options, and scopes into executable lint targets
|
|
25
|
+
- Runs rules on Playwright-rendered pages
|
|
26
|
+
- Supports formatters (`stylish`, `json`) and machine-friendly exit codes
|
|
27
|
+
- Exposes configuration helpers from `viewlint/config`
|
|
28
|
+
|
|
29
|
+
## Related Packages
|
|
30
|
+
|
|
31
|
+
- [`@viewlint/rules`](https://www.npmjs.com/package/@viewlint/rules): built-in rules and presets
|
|
32
|
+
- [`@viewlint/create-config`](https://www.npmjs.com/package/@viewlint/create-config): interactive config setup
|
|
33
|
+
- [`@viewlint/mcp`](https://www.npmjs.com/package/@viewlint/mcp): MCP server
|
|
34
|
+
|
|
35
|
+
## Documentation
|
|
36
|
+
|
|
37
|
+
- [Getting Started](https://viewlint.vercel.app/docs/getting-started)
|
|
38
|
+
- [CLI Reference](https://viewlint.vercel.app/docs/cli-reference)
|
|
39
|
+
- [TypeScript API Reference](https://viewlint.vercel.app/docs/typescript-api-reference)
|