npm 包 broccoli-bem 使用教程

面试官:小伙子,你的数组去重方式惊艳到我了

随着前端开发的发展,CSS methodologies(CSS 风格指导思想)变得越来越重要,它们可以使我们的 CSS 代码更加规范、易于维护和可扩展。BEM 是其中一种广受欢迎的风格指导方法,通常被用于大型 Web 项目开发。在这篇文章中,我们将介绍如何使用 npm 包 broccoli-bem 来实现 BEM 风格的开发和构建工具。

什么是 BEM?

BEM 是 Block、Element、Modifier 的缩写,是一种构建易于维护和扩展的 Web 界面的方法。每个 “块”(block)都是由 CSS 类名为 .block-name 的元素组成的,而每个 “元素”(element)都是属于某个块内的元素,其类名类似于 .block-name__element-name,最后,每个 “修饰符”(modifier)都是描述某个块或元素的状态或变化的类名,例如 .block-name__element-name--modifier

以下是一个简单的示例,BEM 的类命名约定是用横线命名法。

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

什么是 broccoli-bem ?

broccoli-bem 是一个 npm 包,它为 BEM 风格的代码提供了自动化构建工具。它基于 broccoli 构建工具,是一种静态文件生成器,旨在使您的前端项目能够更加可维护,更加灵活。

使用 broccoli-bem 构建你的 BEM 项目

首先,确保您已经安装了 node.js 和 npm。

  1. 创建一个新的 node.js 项目并在其根目录中运行以下命令,安装 broccoli-bem:

    --- ------- ------------ ----------
  2. 在根目录下创建一个名为 Brocfile.js 的文件,并输入以下代码:

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

    您需要创建一个 src 文件夹用于存储您的项目源代码,这个文件夹包含您的 BEM 样式和其他前端资源(如 JavaScript 和图像)。

    在上面的代码中,我们使用 bemBuilder 函数创建了一个名为 tree 的 broccoli 树,该树允许我们在 src 目录的 BEM 文件中引用块,元素和修饰符。我们还将一个 JSON 文件 blocks.json 传递给 bemBuilder 函数,它包含了我们在 BEM 文件中使用的所有的类名和结构信息。

    以下是 blocks.json 的常规格式:

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

    下一步,我们需要告诉 broccoli-bem 如何将 BEM 文件转换为 CSS 文件,可以将以下内容添加到 Brocfile.js 中:

    --- ---------- - --- ----------------
       -----
       ------  -- ------ ---------
       --------------------  -- ------ ---------
    --
  3. 运行 broccoli serve 命令来启动一个 web 服务器,通过 http://localhost:4200/ 访问您的 BEM 项目。

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

    现在,您的 broccoli-bem 项目已经成功启动,该项目将自动生成您的 CSS 文件并将其输出到您的目标目录中。

示例代码

以下是一个示例 BEM 文件的目录结构:

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

在这个例子中,我们创建了一个名为 block 的 BEM 块。这个块由 block.cssblock.html_block.css 和一个名为 element 的 BEM 元素组成。元素 element 又由一个 _element.css 和一个 _element.html 组成。我们还创建了一个 blocks.json 文件,它描述了我们在 BEM 文件中使用的所有类名和结构信息。

以下是 blocks.jsonblock 的段落:

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

现在,block.css 中定义了 block 的样式:

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

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

index.html 包含了 block 的 HTML 代码:

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

最后,brocfile.js

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

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

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

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

启动该项目:

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

现在我们在浏览器中打开 http://localhost:4200 ,应该可以看到我们的 block 块已经成功应用,block 的 HTML 代码被呈现为一块黑色边框和蓝色背景的方块。

结论

在这篇文章中,我们介绍了 BEM 风格指导思想的基础知识,并了解了如何使用 npm 包 broccoli-bem 来构建 BEM 风格的 Web 项目。我们还提供了一个示例代码,以帮助您了解如何实现和使用 broccoli-bem。请记住,BEM 可以使您的代码更容易维护和扩展,broccoli-bem 则是实现 BEM 的一个很好的工具,它可以帮助您更有效地开发代码。

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


猜你喜欢

  • 如何在 Hapi 中使用 Socket.io 实现实时通信

    Socket.io 是一个基于 Node.js 的实时通信框架,可方便地实现服务端和客户端之间的实时通信。而 Hapi 是一个基于 Node.js 的 Web 开发框架,它提供了一些有用的工具和插件,...

    1 小时前
  • 在 ES9 中使用 obj.constructor() 函数创建对象

    在 JavaScript 中,我们通常使用对象字面量或构造函数来创建对象。但在 ES9 中,我们可以使用 obj.constructor() 函数来创建对象。这种方式可以让我们更加灵活地创建对象,并且...

    1 小时前
  • 如何使用 Mocha 测试 AngularJS 应用?

    Mocha 是一个流行的 JavaScript 测试框架,可针对多种应用程序和库进行测试。在前端开发领域中,测试是至关重要的一环,特别是对于 AngularJS 应用程序。

    1 小时前
  • Next.js 处理外部请求数据的方法和技巧

    Next.js 是一种流行的 React 框架,可以帮助我们构建可靠、可扩展的 Web 应用程序。与许多其他的 React 框架不同,Next.js 还提供了一些处理外部请求数据的方法和技巧,让应用程...

    2 小时前
  • 用 Fastify 实现自定义错误处理器

    Fastify 是一个基于 Node.js 的快速和低开销 Web 框架。它专为构建高效和可伸缩的服务而设计,提供了很多强大的功能,如内置的插件系统、路由、中间件等等。

    2 小时前
  • Kubernetes 中的 Job 和 CronJob 使用详解

    Kubernetes 是一个用于管理容器化应用程序的开源平台,它有助于在大规模分布式系统中轻松部署、管理和扩展应用。在 Kubernetes 中,Job 和 CronJob 是用于执行批处理任务和定期...

    2 小时前
  • 在 Hapi.js 中实现推送通知

    推送通知是现代 Web 应用程序的重要组成部分,使得您可以向用户传递实时信息,而无需用户每次主动获取。在这篇文章中,我们将探讨如何在 Hapi.js 中实现推送通知,以便更好地服务我们的用户。

    2 小时前
  • 用 Redis 响应快速的 GraphQL 查询

    GraphQL 是一种用于 API 的查询语言,可以让前端开发人员灵活地请求数据并减少不必要的网络请求。然而,在大型应用程序中,GraphQL 查询可以变得相当复杂和缓慢,尤其是在处理大量数据时。

    3 小时前
  • JavaScript 面向对象编程:ECMAScript 2021 中的类

    在 JavaScript 中,面向对象编程(OOP)是一种常见的编程范型。在 ECMAScript 2021 中,类被引入作为一种更加强大且方便的面向对象编程方式。

    3 小时前
  • Chai 报错:expected [] to have length 1 解决方法

    前言 在前端开发中,测试是非常重要的一部分。而 Chai 是一款常用的 JavaScript 测试库,它提供了许多有用的断言和 API,可以帮助我们进行测试驱动开发(TDD)和行为驱动开发(BDD)。

    3 小时前
  • Serverless 如何实现热启动?

    随着云计算技术的发展,Serverless 架构已经成为了一种越来越受欢迎的应用架构模式,它可以为开发者提供更快的部署、更低的成本和更好的可伸缩性。但是,Serverless 架构中的函数冷启动问题一...

    3 小时前
  • Redis 的应用场景与优缺点分析

    在前端开发中,缓存是一个非常有用的工具,它可以提高网站的响应速度以及数据传输的效率。而 Redis 作为一款常用的缓存服务器,可以应用在很多场景下。本文将介绍 Redis 的应用场景及其优缺点分析,旨...

    4 小时前
  • 如何在 React 中使用 WebSocket 进行实时通信

    WebSocket 是一种提供实时双向通信的协议,与传统的 HTTP 协议不同,它可以在客户端和服务器之间建立持久连接,使得服务器可以主动向客户端推送消息。React 作为一种流行的开发框架,为了实现...

    4 小时前
  • ECMAScript 2017 中的字符串填充方法:String.padStart() 和 String.padEnd()

    在 JavaScript 中,字符串操作一直是前端开发中最基础也最常用的功能之一,ECMAScript 2017 标准中新增的字符串填充方法 String.padStart() 和 String.pa...

    4 小时前
  • 以 Flex 布局构建响应式设计分割视图

    在当今网络应用程序生态系统中,设计响应式界面非常重要。这种技术允许用户适应不同设备和浏览器屏幕,并使应用程序对于各种设备尺寸都具有良好的适应性。因此,在开发前端应用程序时,设计响应式视图是必不可少的。

    4 小时前
  • 如何在 Angular 应用中实现单元测试

    如何在 Angular 应用中实现单元测试 单元测试在软件工程中是非常重要的一部分,它可以提高代码质量和可维护性。对于 Angular 应用来说,单元测试同样也是不可或缺的。

    4 小时前
  • 多方共建,让北京市无障碍发展健康前行

    多方共建,让北京市无障碍发展健康前行 随着互联网技术的迅猛发展,人们的交流和信息获取方式愈加多样化,但同时,我们也看到了无障碍互联网的重要性。 无障碍网站是指在设计、开发和使用时,考虑了所有人的需求,...

    4 小时前
  • Sequelize(ORM)基础

    在开发现代 Web 应用时,数据存储是不可或缺的一部分。一般而言,应用需要连接数据库来存储和检索信息。但是,直接连接数据库并进行数据操作通常是困难的,因为大部分关系数据库(如 SQLite,Postg...

    5 小时前
  • Deno 应用中如何处理 XML 格式数据

    引言 Deno 是一个新兴的 JavaScript 运行时环境,它与 Node.js 类似,但具有许多 Node.js 中缺失的特性,例如 TypeScript 的原生支持、安全的模块加载等等。

    5 小时前
  • React 中的内联样式和外部样式表的区别

    React 是一种广泛使用的 JavaScript 库,用于开发用户界面。React 支持一种特殊的语法,称为 JSX,它使得将 HTML 和 JavaScript 混合使用变得更加简单和直观。

    5 小时前