npm 包 @bem/sdk.config 使用教程

什么是 BEM

BEM 是一种基于模块化的前端开发方法论,其名称来源于块(Block)、元素(Element)和修饰符(Modifier)三个词汇的首字母缩写。

BEM 的特点是将 UI 组件抽象为块,并使用块、元素和修饰符标记结构,从而使得代码清晰、可读性高、易于扩展和维护。BEM 还提供了一些命名规范,能够有效地避免样式冲突问题。

@bem/sdk.config 的作用

@bem/sdk.config 是一个 npm 包,其作用是为 BEM 提供配置文件支持。使用该配置文件可以方便地定义块、元素和修饰符的命名方式,并且可以设置一些编译选项,如编译产物的命名方式、输出目录等。

@bem/sdk.config 的安装

使用 npm 包管理器进行安装:

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

@bem/sdk.config 的配置

@bem/sdk.config 的配置分为两部分:命名规范和编译选项。

命名规范

BEM 的命名规范是其重要特征之一。使用 @bem/sdk.config 让我们可以方便地定义命名规范。

首先,在项目的根目录下创建一个 .bemrc.js 文件,用于存放配置信息。该文件的内容如下:

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

其中,name 和 scheme 字段用于定义命名规则的名称和结构方式,levels 用于定义块所在的目录。

  • name: 字符串类型,为命名规范的名称。
  • scheme: 字符串类型,有两种选项:flat 和 nested,分别对应扁平结构和嵌套结构。
  • levels: 数组类型,用于定义块所在的目录。每个元素包含了 path 和 scheme 两个字段。

编译选项

@bem/sdk.config 的编译选项有如下几个:

  • outputDir: 编译产物的目标目录,默认为 dist。
  • outputNaming: 编译产物的命名方式,默认为 '[block].css'。
  • techMap: 编译产物的后缀名和对应的技术名,默认为 { css: ['css', 'scss', 'sass'] }。

可以在 .bemrc.js 文件中添加如下配置:

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

@bem/sdk.config 的使用

@bem/sdk.config 的使用依赖于@bem/cli,因此需要先进行安装:

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

设置好配置文件之后,就可以使用 @bem/cli 进行编译了。使用方式如下:

--- ----

以上命令将会编译所有 src/components 目录下的块。

示例代码

下面的示例代码演示了使用 @bem/sdk.config 编译一个简单的 BEM 组件的过程。

  1. 首先,安装 @bem/sdk.config 和@bem/cli。
--- ------- --------------- --------
  1. 在项目的根目录下创建 .bemrc.js 配置文件,并添加如下配置:
-------------- - -
  -
    ----- ----------
    ------- ---------
    ------- -
      -
        ----- -----------------
        ------- --------
      -
    --
    ---------- --------
    ------------- ------------------
    -------- - ---- ------- ------- -
  -
-
  1. 在 src/components 目录下创建一个 test 块,其目录结构如下:
----------------------
--- --------
--- -------
--- ---------

其中,test.css、test.js 和 test.html 分别为块的样式、脚本和 HTML 模板。在 test.css 文件中定义如下样式:

----- -
  ------ ------
  ------- ------
  ----------------- ----
-
  1. 使用 @bem/cli 进行编译:
--- ----

以上命令将会在 build 目录下生成 test.min.css 文件。

  1. 在 HTML 中引入编译产物:
--------- -----
------
------
  ----- ----------------
  ---------- ------------
  ----- ---------------- ----------------------------
-------
------
  ---- -------------------
-------
-------
  1. 打开浏览器,查看效果。可以看到 test div 的宽高为 100px,并且背景色为红色。

结论

通过使用 @bem/sdk.config 及其配合的工具,我们可以方便地实现 BEM 的命名规范和编译产物的生成。其提供了丰富的配置选项,能够满足大部分场景的需求,并且可以很好地和其他编译工具结合使用。

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


猜你喜欢

  • npm 包 @conga/framework-profiler 使用教程

    简介 在前端开发中,我们经常需要对页面的性能和加载速度进行优化。而开发过程中调试这些问题通常需要通过浏览器的开发者工具(DevTools)来看到这些信息。但是当我们需要在生产环境中进行性能优化时,De...

    5 年前
  • npm 包 @conga/framework-view-twig 使用教程

    前言 在前端领域中,npm 库的使用已经成为了日常工作中不可或缺的一部分。而 @conga/framework-view-twig 则是一个在 npm 上比较受欢迎的前端库,它的作用是将 Twig 模...

    5 年前
  • npm 包 @conga/framework 使用教程

    概述 在前端开发过程中,经常需要使用各种第三方工具包来辅助完成工作。其中很重要的一部分就是框架。本文主要介绍一个完善的 Node.js 后端框架,npm 包 @conga/framework 的使用方...

    5 年前
  • npm 包 jean 使用教程

    前言 随着前端技术的快速发展,前端工程师们经常会遇到各种各样的代码重复问题,为了减少这些重复代码而诞生了 npm 包的概念。npm 包 jean 是一个非常适合前端的包,能够帮助我们实现样式的可复用性...

    5 年前
  • npm 包 djantajs-compiler-core 使用教程

    npm 包 djantajs-compiler-core 是一个基于 Node.js 的前端编译工具,它可以将源代码编译成可执行的 JavaScript。本文将介绍如何使用该工具进行前端开发,并给出相...

    5 年前
  • npm 包 conga-validation 使用教程

    简介 在前端开发中,数据验证是非常重要的一步。为了方便和简化前端开发者的数据验证工作,conga-validation 是一种非常实用的 npm 包。该包支持各种基本数据类型的验证,如字符串、数字、对...

    5 年前
  • npm包conga-rest使用教程

    前言 在前端领域中,npm包的使用早已是司空见惯的事情。npm(Node Package Manager)是随着Node.js一起发布的包管理工具,是世界上最大的软件注册表,每周处理数亿次的下载请求。

    5 年前
  • 介绍 Conga Framework npm 包以及使用方法

    什么是 Conga Framework? Conga Framweork 是一个基于 Node.js 和 Express.js 开发的现代化 web 应用框架。其具有以下优点: 高度可定制性 丰富的...

    5 年前
  • npm 包 @djanta/djantajs-compiler-core 使用教程

    前言 在前端开发中,我们经常会使用一些依赖于 npm 的包来加速开发进度。在这些 npm 包中,@djanta/djantajs-compiler-core 是一个非常强大的工具,它可以帮助我们实现源...

    5 年前
  • npm 包 state-machine 使用教程

    在前端开发中,状态机是一种非常重要的概念,它可以帮助我们更好地管理应用程序的状态。在 JavaScript 中,我们可以利用 npm 包 state-machine 来实现状态机。

    5 年前
  • npm 包 express-enforces-ssl 使用教程

    在现代的 Web 开发中,我们越来越重视网站的安全性。其中 https 协议是一项非常重要的安全机制,它能够保护数据的传输过程,抵御网络攻击。对于 node.js 开发者而言,使用 express 框...

    5 年前
  • npm 包 express-content-length-validator 使用教程

    在前端开发中,使用 Node.js 和 Express 框架可以方便地搭建 Web 应用程序。而 express-content-length-validator 是一个 npm 包,它可以检查 PO...

    5 年前
  • NPM 包 Pdfkit 使用教程

    在前端开发中,常常需要使用 PDF 文件作为数据展示的形式来进行数据可视化。而 pdfkit 是一个高质量的 PDF 生成工具,可以让开发者在浏览器端和服务器端使用。

    5 年前
  • npm 包 nervatura-report 使用教程

    简介 nervatura-report 是一个用于 web 应用程序的模板报告器。通过使用 PostgreSQL 数据库作为后端,nervatura-report 可以采用 REST API 向 we...

    5 年前
  • npm 包 http-micro 使用教程

    简介 http-micro 是一个基于 Node.js 的轻量级 HTTP 请求库,它支持 Promise 和 Async/Await,并且可以使用中间件扩展。 安装 在项目目录下,使用 npm 安装...

    5 年前
  • npm 包 funkster-http-headers-content 使用教程

    funkster-http-headers-content 是一个 Node.js 的 npm 包,用于设置 HTTP 头信息和响应体内容。本文将详细介绍 funkster-http-headers-...

    5 年前
  • npm 包 c4restfulclient 使用教程

    介绍 c4restfulclient 是一个基于 Node.js 的 npm 包,用于进行 RESTful API 的请求。它支持多种请求方式,包括 GET、POST、PUT、DELETE 等,并且可...

    5 年前
  • npm 包 @nelts/context 使用教程

    如果你在做 Node.js 中间件开发,那么一个好的上下文管理器会是非常必要的。@nelts/context 是一个专门为 Node.js 中间件开发设计的上下文管理器,他允许你在中间件间自由传递数据...

    5 年前
  • NPM包 @longjs/core使用教程

    前言 在前端开发中,npm包是非常重要的工具。它提供了各种各样的功能和组件,让我们的开发变得更加高效和便捷。在这篇文章中,我将介绍一个非常有用的npm包,它叫做@longjs/core,它可以帮助开发...

    5 年前
  • npm 包 @funya._./gulp-import-alias 使用教程

    随着前端项目规模的不断增大,模块化开发已经成为前端开发中必不可少的一部分。为了方便模块化开发,前端开发者们会经常使用到 npm 包来管理所需的各种工具和库。而对于使用 gulp 打包工具的用户来说,使...

    5 年前

相关推荐

    暂无文章