@linkdesk/plugin-docs 0.1.8 → 0.1.9
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.
|
@@ -668,6 +668,43 @@ component. **Nothing to do before you upgrade; when you upgrade, it's one prefix
|
|
|
668
668
|
- **What happens if you don't**: exactly the silent failure described in 12.1—the selector just stops matching and those few rules quietly stop applying. **No error.**
|
|
669
669
|
- **When you must change it**: when you move to **`@linkdesk/ui` 0.3.0**. `^0.2.0` does not resolve `0.3.0` (that's how 0.x ranges work), so nothing breaks until you upgrade deliberately. **Grep your own CSS for the old names** after upgrading: an official plugin (`settings`) had exactly one such spot and it was fixed in the same release batch.
|
|
670
670
|
|
|
671
|
+
### 12.5 The **scope** of custom properties—`--x:` written under `:root` is written for the whole application
|
|
672
|
+
|
|
673
|
+
The three rules above govern **names**; this one governs **territory**. For custom properties (`--xxx`) there is exactly one rule:
|
|
674
|
+
|
|
675
|
+
> **Scope is the namespace.** The name is yours to choose; **which subtree it lives in** is what decides who it belongs to.
|
|
676
|
+
|
|
677
|
+
**① Document-level scope is the host's alone.** Declarations on `:root` / `html` / `body` / `[data-theme="…"]` / `*` are **visible to the entire document**—that is not your territory:
|
|
678
|
+
|
|
679
|
+
```css
|
|
680
|
+
/* ❌ this declaration is visible to the whole document */
|
|
681
|
+
:root { --my-panel-gap: 8px; }
|
|
682
|
+
|
|
683
|
+
/* ✅ hang it under your own root class: scope = your subtree */
|
|
684
|
+
.my-plugin-root { --my-panel-gap: 8px; }
|
|
685
|
+
```
|
|
686
|
+
|
|
687
|
+
**② Every other declaration hangs under one of your own classes.** Write `.your-class { --xxx: … }`—and note that **the name needs no prefix there**: a `--gap` under `:root` collides with someone else's, a `--gap` under `.my-plugin-root` cannot (the scope has already divided the territory).
|
|
688
|
+
|
|
689
|
+
**③ Nobody may define a `--ldk-*` custom property** (same rule as class names and keyframes—the whole `ldk-` namespace belongs to the host).
|
|
690
|
+
|
|
691
|
+
**Why this is nastier than a class-name collision**: most of the host's colors / radii / z-index layers are **provided by its stylesheets rather than written by code**. Write one of the host's contract names (say `--bg-card`) under `:root` and **you win**—the whole application's card background follows your value. And **switching themes may switch it back** (a theme overrides some of those names) ⇒ the symptom is "**works sometimes, breaks sometimes**", the hardest kind to diagnose.
|
|
692
|
+
|
|
693
|
+
**One self-check** (glance at it when your CSS is done): **"is my `--x:` written under `:root`?"** If yes ⇒ move it under your own root class.
|
|
694
|
+
|
|
695
|
+
**Migrating**—plugins that already define custom properties under `:root`:
|
|
696
|
+
|
|
697
|
+
| Case | Level | What to do |
|
|
698
|
+
|---|---|---|
|
|
699
|
+
| Name **carries** your own prefix (`--my-plugin-gap`) | 🟡 suggested | Move it under your own root class. The name is yours and nobody competes for it, but there is no reason for it to sit under `:root`—after the move its scope shrinks from the whole document to your own subtree |
|
|
700
|
+
| Name **carries no** prefix (`--gap`, `--bg-card`, …) | 🔴 required | It is live document-wide right now and may already be overriding the host's or another plugin's value ⇒ move it under your own root class (the name may stay as it is; **what changes is the scope**) |
|
|
701
|
+
| Name starts with `ldk-` | 🔴 required | Give it one of your own names—`ldk-` is the host's namespace |
|
|
702
|
+
| Written **under your own root class** | ✅ compliant | Nothing to do. Fine-tuning like `.your-root .ldk-x { --y: … }` is compliant too (one of your own classes appears in the selector) |
|
|
703
|
+
|
|
704
|
+
**How it is enforced mechanically**: run `npm run lint` in the plugin project root (or `npm run verify` in CI) and each occurrence is reported—🔴 turns CI red, 🟡 only prints. When "it works locally but CI is red", read this section first.
|
|
705
|
+
|
|
706
|
+
> 🔧 **Maintainer note (authors may skip)**: the rule text (including how the host registers its contract blocks and the floating-layer host exception) lives under `docs/02-Electron架构/E6_插件生态与发布/01-插件独立构建/样式命名空间归一化/`; the shell side is guarded by `scripts/check-css-namespace.mjs`, the plugin side by the SDK's `check-css-namespace` leg (the third criterion of that same leg, sharing one disable-comment id with the class-name and keyframe criteria).
|
|
707
|
+
|
|
671
708
|
---
|
|
672
709
|
|
|
673
710
|
## Quick Reference
|
package/docs/zh/05-/346/217/222/344/273/266UI/345/206/231/346/263/225/350/247/204/347/272/246.md
CHANGED
|
@@ -652,6 +652,51 @@ monaco 当前背景不透明、只二态跟随(亮/暗)是**过渡态绕开
|
|
|
652
652
|
- **不改会怎样**:与 12.1 完全相同——选择器匹配不上,那几条规则悄悄不再生效。**不报错。**
|
|
653
653
|
- **什么时候必须改**:升到 **`@linkdesk/ui` 0.3.0** 时。`^0.2.0` 不会解析到 `0.3.0`(0.x 的范围就是这么算的),所以你不主动升级就不会坏。升级后**拿上表里的旧族名 grep 一遍自己的 CSS**:官方插件里只有 `settings` 有 1 处,已在同一批发版改好。
|
|
654
654
|
|
|
655
|
+
### 12.5 自定义属性的**作用域**——`--x:` 写在 `:root` 里就等于写给整个软件
|
|
656
|
+
|
|
657
|
+
类名那三条纪律管的是**名字**,这一节管**地盘**。自定义属性(`--xxx`)的规矩只有一句:
|
|
658
|
+
|
|
659
|
+
> **作用域才是命名空间。** 名字随你起,**它住在哪棵子树里**才是它属于谁。
|
|
660
|
+
|
|
661
|
+
**① 文档级的作用域只有宿主能用。** `:root` / `html` / `body` / `[data-theme="…"]` / `*` 上的定义
|
|
662
|
+
**对整个文档可见**——那不是你的地盘:
|
|
663
|
+
|
|
664
|
+
```css
|
|
665
|
+
/* ❌ 这条定义全文档可见 */
|
|
666
|
+
:root { --my-panel-gap: 8px; }
|
|
667
|
+
|
|
668
|
+
/* ✅ 挂在你自己的根类之下,作用域 = 你的子树 */
|
|
669
|
+
.my-plugin-root { --my-panel-gap: 8px; }
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
**② 其余定义一律挂在自己的类之下。** 写 `.你的类 { --xxx: … }` 就好——**这里的名字不需要任何前缀**:
|
|
673
|
+
`:root` 上的 `--gap` 会跟别人撞,`.my-plugin-root` 下的 `--gap` 不会(作用域已经把地盘划开了)。
|
|
674
|
+
|
|
675
|
+
**③ `--ldk-*` 自定义属性谁都不许定义**(和类名、关键帧同一条规矩——整个 `ldk-` 命名空间是宿主的)。
|
|
676
|
+
|
|
677
|
+
**为什么这条比类名还凶**:宿主大部分颜色 / 圆角 / 层级**不是由程序写上去的、而是靠样式表提供的**。
|
|
678
|
+
你在 `:root` 里写一个宿主的契约名(比如 `--bg-card`),**你会赢**——整个软件的卡片底色跟着变;
|
|
679
|
+
而且**换个主题可能又变回来**(主题会覆盖其中一部分名字)⇒ 症状是「**时好时坏**」,最难查的一类。
|
|
680
|
+
|
|
681
|
+
**一条自检**(写完 CSS 顺手看一眼):**「我的 `--x:` 是不是写在 `:root` 里?」** 是 ⇒ 搬进你自己的根类。
|
|
682
|
+
|
|
683
|
+
**迁移**——已经在 `:root` 里写过自定义属性的插件:
|
|
684
|
+
|
|
685
|
+
| 情形 | 判级 | 怎么办 |
|
|
686
|
+
|---|---|---|
|
|
687
|
+
| 名字**带**你自己的前缀(`--my-plugin-gap`) | 🟡 建议改 | 搬进自己的根类。名字是你的、没人跟你抢,但「写在 `:root`」本身没有理由——改完作用域从整个文档缩回你自己的子树 |
|
|
688
|
+
| 名字**不带**前缀(`--gap`、`--bg-card`…) | 🔴 必须改 | 它此刻在全文档生效、可能正覆盖着宿主或别的插件的值 ⇒ 把它搬进自己的根类(名字可以照旧保留,**换的是作用域**) |
|
|
689
|
+
| 名字以 `ldk-` 开头 | 🔴 必须改 | 换成你自己的名字——`ldk-` 是宿主命名空间 |
|
|
690
|
+
| 写在**自己的根类**之下 | ✅ 合规 | 不用动。`.你的根类 .ldk-x { --y: … }` 这类**微调**同样合规(选择器里有你自己的类就行) |
|
|
691
|
+
|
|
692
|
+
**它怎么被机械守住**:在插件工程根跑 `npm run lint`(或 CI 里的 `npm run verify`)会逐条报出来
|
|
693
|
+
——🔴 会让 CI 红,🟡 只提示不拦。「我的插件本地好好的、CI 却红」时先看这一段。
|
|
694
|
+
|
|
695
|
+
> 🔧 **维护者注(作者可跳过)**:规则正文(含宿主契约块的登记方式、浮层宿主根那个例外)在
|
|
696
|
+
> `docs/02-Electron架构/E6_插件生态与发布/01-插件独立构建/样式命名空间归一化/` 下;宿主侧由
|
|
697
|
+
> `scripts/check-css-namespace.mjs` 守着,插件侧由 SDK 的 `check-css-namespace` 腿守着
|
|
698
|
+
> (同一条腿的第三条判据,与类名 / 关键帧共用同一个 disable 注释 id)。
|
|
699
|
+
|
|
655
700
|
---
|
|
656
701
|
|
|
657
702
|
## 速查
|