css - 使用 CSScomb 插入注释(使用 Sublime Text)

Question

我的客户要求在代码中添加很多注释 - 包括 css 文件。

于是想到用CSScomb重新组织css代码，自动添加注释。这没有意义，但为什么不呢。

所以我们的想法是更改配置文件，其中声明:

[
    "font",
    "font-family"
],
[
    "padding",
    "margin"
]
...

但得到的输出是:

/* FONT STYLE */
font: ....;
font-family: ....;

有什么想法吗？

Answer 1

DIY 组评论

您可以通过编辑 CSScomb 包中的 sort-order.js 文件自行添加此功能。

1. 打开 Sublime Text，从菜单中选择 Preferences > Browse Packages...；这将打开包文件夹。
2. 从 Packages 文件夹中，导航到 CSScomb/node_modules/csscomb/lib/options/sort-order.js。
3. 创建此文件的副本以供检索，以备您要恢复更改时使用。我将我的副本命名为 sort-order-original.js。
   在不同的目录中创建此文件的副本以供检索，以防您想恢复更改.我将我的副本上移了一层到新目录 ../originals/options/sort-order.js。
   注意:如果您只是在现有目录中重命名副本它可能被模块包含并运行；因此，最安全的做法是将其移至新位置。
4. 在 Sublime Text 中打开 sort-order.js 进行编辑。
5. Consult this diff for the necessary changes to be made .
   Consult this diff for the necessary changes to be made . (最新版本增加了新的逻辑，防止多次运行CSScomb时群评论重复。)
6. 如果您对这些更改感到满意，请完整复制并粘贴它们以替换 sort-order.js 的内容。您可以选择进一步编辑以满足您的需要。保存。
   注意:本质上，这些更改是使用附加属性扩展每个已排序的对象，该属性包含您在用户设置中可选提供的 CSS 注释。我将在下一步中向您展示在何处添加评论。
7. 现在，您可以按组添加评论了。从 Sublime Text 菜单中，选择 Preferences > Package Settings > CSScomb > Settings – User。如果您尚未配置自己的设置，则可以通过将 Settings – Default 的内容复制到 Settings – User 来开始。
8. 在用户设置文件中，找到"sort-order" 属性。它要么是一个属性名称数组，要么是一个属性名称数组的数组。默认情况下，CSScomb 会在嵌套数组组之间添加一个空行，但我们修改了执行此操作的文件。
9. 您现在可以选择将注释添加为任何嵌套数组的第一个属性。 sort-order.js 文件将检测到这一点并将其输出到组的顶部。如果没有定义注释，则输出默认的空白行。

示例用户设置:

"sort-order": [
    [
        "/* LAYOUT */",
        "position",
        "z-index",
        "top",
        "right",
        "bottom",
        "left"
    ],
    [
        "/* DISPLAY */",
        "display",
        …
        "flex-align"
    ],
    [
        "/* TYPOGRAPHY */",
        "font",
        …
        "line-height"
    ],
    [
        …
    ]
]

在运行 CSScomb 之前:

.selector {
    font-family: Arial;
    line-height: 1;
    position: relative;
    display: block;
    background-color: red;
}

运行 CSScomb 后:

.selector {

    /* LAYOUT */
    position: relative;

    /* DISPLAY */
    display: block;

    /* TYPOGRAPHY */
    font-family: Arial;
    line-height: 1;

    background-color: red;
}