npm 包 css-property-sort-order-smacss 使用教程

Web 前端的开发中,CSS 样式编写是必不可少的一部分。为了让 CSS 的编写规范化、易于维护和扩展,在不同的项目中,我们可以采用不同的 CSS 规范,如 SMACSS(Scalable and Modular Architecture for CSS)规范等。在此基础上,出现了许多 npm 包来帮助我们规范化 CSS 代码,css-property-sort-order-smacss 就是其中之一。

安装 npm 包

我们可以用以下命令来安装 css-property-sort-order-smacss:

npm install css-property-sort-order-smacss

安装完成后,我们可以在项目的 package.json 文件中在 devDependencies 中看到该依赖。

使用方法

使用 css-property-sort-order-smacss 可以很方便地规范化 CSS 属性的顺序。如下是 css-property-sort-order-smacss 推荐的 CSS 属性排序顺序:

  1. Positioning
  2. Box Model
  3. Typographic
  4. Visual

在 CSS 代码中,需要遵循以上顺序,按顺序排列属性。使用 css-property-sort-order-smacss 可以自动帮助你将 CSS 属性按照正确的顺序排序,让代码更具可读性和易于维护。

使用前,我们需要在项目的 .stylelintrc 或者 .stylelintrc.js 中添加配置项:

-
  ---------- -
    -----------------
  --
  -------- -
    -------------- -
     -
       -----------
       ------
       --------
       ---------
       -------
       ---------
     --
     -
       ----------
       --------
       --------
       ---------
       ---------
       ----------
       ---------
       ---------
     --
     -
       -------
       --------------
       -------------
       --------
       --------------
       -------------------
       -------------------
       --------------------
       ----------------------
       ------------------
       ----------
       ------------
     --
     -
       -------------
       -------------
       ------------
       ------------
       -------------
     -
    --
    ------------------------- --------
  -
-

其中,order/order 表示各个属性排序最终应该按哪个顺序排序。order/properties-order 则表示使用 smacss 规范来排序。

添加配置后,在项目的 package.json 中添加对应的命令,如:

"sort:css": "stylelint \"**/*.css\" --fix"

运行该命令,可以自动将 CSS 属性按照 smacss 规范排序。

示例代码

---- -
  -------- -------------
  ------- --- ----- ------
  ------- -----
  -------- -----
  ----------------- --------
  ---------- -----
  ------------ ----
  ------ -----
  ----------- -------
  ------------------- - - ---- ------- -- -- -----
  ----------- - - ---- ------- -- -- -----
  ------------------- --- -----
  ----------- --- -----
  ------------------ -------------- -- ---
  ---------- -------------- -- ---
-

在使用 css-property-sort-order-smacss 包后,我们运行 sort:css 命令后,可以得到如下排序后的代码:

---- -
  -------- -------------
  ------- -----
  -------- -----
  ------- --- ----- ------
  ----------------- --------
  ---------- -----
  ------------ ----
  ------ -----
  ----------- -------
  ------------------- - - ---- ------- -- -- -----
  ----------- - - ---- ------- -- -- -----
  ------------------- --- -----
  ----------- --- -----
  ------------------ -------------- -- ---
  ---------- -------------- -- ---
-

如此排序后,我们可以看到 CSS 属性按照 SMACSS 规范被排序,让代码更加整齐、可读性更好。

总结

css-property-sort-order-smacss 帮助我们很方便地使用 SMACSS 规范来排序 CSS 属性,让我们的代码更容易维护和扩展。在使用前需要明确 SMACSS 规范中的属性排序顺序,然后按照示例代码添加 .stylelintrc 配置,这样即可在项目中快速使用 css-property-sort-order-smacss 对 CSS 属性进行排序。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5f100326403f2923b035c218


猜你喜欢

  • npm 包 lighthouse-logger 使用教程

    在前端开发中,性能优化一直是一个非常重要且具有挑战性的问题。为了解决这个问题,我们需要一系列的工具来帮助我们进行性能测试和监控。在这篇文章中,我将向大家介绍一个非常实用的 npm 包:lighthou...

    4 年前
  • NPM 包 @types/sencha_touch 使用教程

    Sencha Touch 是一款用于开发移动 Web 应用程序的 Javascript 框架之一。它可以帮助开发者更加简单地创建出具有原生移动应用程序般的体验和效果的网页。

    4 年前
  • npm 包 @types/sequelize-fixtures 使用教程

    前言 在前端开发的过程中,我们经常需要对关系型数据库进行 CRUD 操作,而 Sequelize 是 Node.js 中最强大的 ORM 框架之一。但是,在实际开发中,经常需要对数据库进行初始化和填充...

    4 年前
  • npm 包 @types/sequencify 使用教程

    在前端开发中,我们常常需要对多个任务进行排序和执行。而 sequencify 正是一款方便的工具,可以用于对处理任务的顺序进行排序。但是,使用起来却并不十分方便,这时候我们就需要使用 @types/s...

    4 年前
  • npm 包 @build-tracker/api-client 使用教程

    简介 @build-tracker/api-client 是一个针对 @build-tracker/server 提供的基于 RESTful API 的前端监控工具。

    4 年前
  • npm 包 @build-tracker/cli 使用教程

    前言 在现代 web 开发中,前端管理工具已经成为了不可或缺的一部分。而其中的 npm 可谓是最为重要的之一,它不仅提供了海量的能够解决各种问题的工具包,同时也是许多开发者的第一选择。

    4 年前
  • npm 包 @types/sequester 使用教程

    什么是 @types/sequester @types/sequester 是 sequester 库的类型定义文件,使用 TypeScript 开发前端项目时,可以方便地使用 sequester 库...

    4 年前
  • npm 包 @types/cpy 使用教程

    在前端开发中,我们经常需要使用文件复制等操作,而 @types/cpy 这个 npm 包就是为了方便我们进行文件复制操作而存在的。它是 @types 的一部分,其实现是基于 cpy 包的 TypeSc...

    4 年前
  • npm 包 @types/server-destroy 使用教程

    在前端开发中,我们常常需要使用 Node.js 来搭建服务器,而 @types/server-destroy 是一个 npm 包,用于处理 Node.js 服务器的关闭操作。

    4 年前
  • npm 包 @types/css-font-loading-module 使用教程

    简介 在前端开发中,使用字体往往是很常见的操作。而 @types/css-font-loading-module 这个 npm 包可以为我们在使用字体的时候提供便利,它提供了一些类型定义和接口,方便我...

    4 年前
  • npm 包 @types/servicenow 使用教程

    近年来,随着云计算和软件即服务(SaaS)的普及,ServiceNow 成为了许多企业管理 IT 服务和 IT 财务的首选工具。ServiceNow 基于 JavaScript 平台开发,提供了丰富的...

    4 年前
  • npm 包 @types/gh-pages 使用教程

    在前端开发中,我们常常需要部署静态网站。而 Github Pages 是一个云托管服务,可以让我们免费地托管静态网站。它支持从 Github 仓库部署网站,用户只需要在 Github 上面创建一个特定...

    4 年前
  • npm包@types/set-cookie-parser使用教程

    前言 在网络应用程序中,服务器通常使用Cookie来管理用户会话信息。在开发过程中,我们经常需要对Cookie进行解析和控制,以便更好地管理用户会话。目前,前端常用的解析Cookie的npm包是set...

    4 年前
  • npm 包 @types/jpeg-js 使用教程

    前言 在前端开发中,处理图片的需求非常常见。常常需要将图像转换成特定的格式进行处理,例如将图片转换成 JPEG 格式,从而减小图片占用的空间并提升网页的加载速度。 在实际开发中,我们可能会用到一些库或...

    4 年前
  • npm 包 electron-notarize 使用教程

    在开发 Electron 应用程序时,我们可能需要签名并提交应用程序以进行 notarization。但是,这是一项相对繁琐的任务,需要考虑许多因素。npm 包 electron-notarize 可...

    4 年前
  • npm 包 @types/settings 使用教程

    1. 前言 当我们在使用 JavaScript 或 TypeScript 开发项目时,有时候需要使用一些第三方库来帮助我们完成开发工作。其中,使用 npm 包已经成为了前端项目开发的标配。

    4 年前
  • npm 包 @wardpeet/brfs 使用教程

    在前端开发的过程中,我们经常需要操作文件和处理文件相关的任务。Node.js 提供了 fs 模块操作文件,但在浏览器端,我们可以使用 @wardpeet/brfs 这个 npm 包简化文件操作。

    4 年前
  • npm 包 flora-colossus 使用教程

    简介 flora-colossus 是一个基于 React 的开源组件库,主要用于前端界面的开发和设计。该库旨在提高前端开发效率和设计质量,同时提供了多个优秀的组件以供选择使用。

    4 年前
  • npm 包 galactus 使用教程

    背景 Node.js 作为一种非常流行的后端开发语言,它也广泛应用于前端开发中。通过使用 npm 包管理器,我们可以轻松地将自己编写的代码发布到全世界的开发者使用,并且也能借助别人的技术实现自己的项目...

    4 年前
  • npm 包 @types/sha1 使用教程

    在前端开发过程中,我们经常需要对数据进行加密,以保护数据的安全性。其中一种常见的加密方式就是使用 SHA1 算法。但是,在 TypeScript 开发中使用 SHA1 算法可能会遇到一些类型定义问题,...

    4 年前

相关推荐

    暂无文章