canicode 0.5.0 → 0.5.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/README.md +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,10 @@
|
|
|
15
15
|
|
|
16
16
|
<p align="center"><strong><a href="https://let-sunny.github.io/canicode/">Try it in your browser</a></strong> — no install needed.</p>
|
|
17
17
|
|
|
18
|
+
<p align="center">
|
|
19
|
+
<img src="docs/screenshot.png" alt="CanICode Report" width="720">
|
|
20
|
+
</p>
|
|
21
|
+
|
|
18
22
|
```bash
|
|
19
23
|
npm install -g canicode
|
|
20
24
|
canicode init --token YOUR_FIGMA_TOKEN
|
|
@@ -212,6 +216,13 @@ canicode analyze <url> --custom-rules ./my-rules.json
|
|
|
212
216
|
|
|
213
217
|
Conditions use AND logic — all must match for the rule to fire. Available conditions: `type`, `notType`, `nameContains`, `nameNotContains`, `namePattern`, `minWidth`, `maxWidth`, `minHeight`, `maxHeight`, `hasAutoLayout`, `hasChildren`, `minChildren`, `maxChildren`, `isComponent`, `isInstance`, `hasComponentId`, `isVisible`, `hasFills`, `hasStrokes`, `hasEffects`, `minDepth`, `maxDepth`.
|
|
214
218
|
|
|
219
|
+
Combine with config overrides:
|
|
220
|
+
```bash
|
|
221
|
+
canicode analyze <url> --config ./config.json --custom-rules ./rules.json
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
> **Tip:** Ask any LLM *"Write a canicode custom rule that checks X"* with the conditions above — it can generate the JSON for you.
|
|
225
|
+
|
|
215
226
|
See [`examples/custom-rules.json`](examples/custom-rules.json) | [`docs/CUSTOMIZATION.md`](docs/CUSTOMIZATION.md)
|
|
216
227
|
|
|
217
228
|
</details>
|
package/package.json
CHANGED