样式林特配置: 尾风 CSS

A 类 样式林 配置 尾风 CSS 项目。 专门为 尾风 CSS v4+ 财务报告和审定财务报表 斯泰林特 v16.17+ (英语) 使用新语法 languageOptions,此配置之所以创建,是因为Tailwind CSS的其他受欢迎的Stylelint配置大多只是忽略指令和函数. 相反,此配置将全部执行 尾风CSS指令和功能 作为语法 斯泰林特的语言选项;所以不仅不用斯德林特抱怨就可以使用它们,而且斯德林特实际上会帮助确保你正确使用它们.

开始

安装软件包

npm install --save-dev @dreamsicle.io/stylelint-config-tailwindcss

在样式林特配置中包含

/**
 * @type {import("stylelint").Config}
 */
const stylelintConfig = {
    extends: [
        "stylelint-config-standard",
        "@dreamsicle.io/stylelint-config-tailwindcss",
    ],
};

export default stylelintConfig;

出口

该套件输出一个无害环境管理模块和一个共同的联署材料模块。 默认导出是无害环境管理模块.

• dist/stylelint.config.mjs - 无害环境管理
• dist/stylelint.config.cjs - 共同联合来文

访问特定密钥

您也可以决定将导入的配置扩展到您的样式林特对象 languageOptions, (中文(简体) ), languageOptions.syntax, (中文(简体) ), languageOptions.syntax.types, (中文(简体) ), languageOptions.syntax.properties,或 languageOptions.syntax.atRules. 以下是如何充分传播这个配置所提供的一切的例子.

import configTailwindcss from "@dreamsicle.io/stylelint-config-tailwindcss/dist/stylelint.config.mjs";

/**
 * @type {import("stylelint").Config}
 */
const stylelintConfig = {
    extends: [
        "stylelint-config-standard",
    ],
    languageOptions: {
        ...configTailwindcss.languageOptions,
        syntax: {
            ...configTailwindcss.languageOptions.syntax,
            types: {
                ...configTailwindcss.languageOptions.syntax.types,
            },
            properties: {
                ...configTailwindcss.languageOptions.syntax.properties,
            },
            atRules: {
                ...configTailwindcss.languageOptions.syntax.atRules,
            },
        }
    },
    rules: {
        ...configTailwindcss.rules,
    }
};

export default stylelintConfig;

说明: 需要所有类型、属性、规则和Stylelint规则才能使这种配置正常运行。 它没有提供风格规则,因为它包含了使Stylelint与Tailwind CSS发挥良好的需要.

兼容性

此配置用于 尾风 CSS v4+然而,Tailwind的文件指出,一些旧指令可能仍然用于 兼容性。虽然这不属于此配置的范围,但您可以继续使用遗留指令,如 @config 财务报告和审定财务报表 @plugin 把它们纳入 languageOptions.syntax 手动.

/**
 * @type {import("stylelint").Config}
 */
const stylelintConfig = {
    extends: [
        "stylelint-config-standard",
        "@dreamsicle.io/stylelint-config-tailwindcss",
    ],
    languageOptions: {
        syntax: {
            atRules: {
                /**
                 * @see https://tailwindcss.com/docs/functions-and-directives#config-directive
                 */
                config: {
                    prelude: "<string>",
                },
                /**
                 * @see https://tailwindcss.com/docs/functions-and-directives#plugin-directive
                 */
                plugin: {
                    prelude: "<string>",
                },
            },
        },
    },
};

说明: 这个 theme() 函数已贬值,不应使用。 使用 CSS 主题变量 换句话说.

发展

此软件包有一个构建脚本,将仅生成Stylelint语言选项所需要覆盖的语法来 sumport Tailwind CSS 函数和指令. 通过升级语法从 CSS 树 包括由 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你觉得呢,这些是Stylelint在引擎盖下使用的同一套软件包.

这是利用我们 SyntaxGenerator 类,通过 a 滚动 插件 。 这些文件的内容被构建到 syntax 目录,然后导入,并通过滚动构建为 无害环境管理模块 (单位:千美元) 共同联合来文 模块位于 dist 目录.

这些文件的内容传递给斯泰林特 languageOptions.syntax 通过配置模板在 src/stylelint.config.mjs。 类型、属性和规则的生成允许自动升级CSS语法,以接受 Tailwind CSS 属性,只要这些属性以尽可能最小的破坏性和最可维持的方式被接受.

开始

npm start

说明: 此脚本将按监视模式滚动运行, 这样配置模板的更改会自动重建 .

构建

npm run build

说明: 此脚本将运行滚动以创建一个构建, 完成后退出 .

测试

npm test

说明: 这将运行样式lint 以对抗在 tests 目录.

修补

npm run fix

说明: 这将运行样式林特在 修补 模式与在 tests 目录.

干净

npm run clean

说明: 这将清理所有已建的文件和依赖性 .