webpack 中实现自动识别 CSS Modules

本文介绍了如何在Webpack中自动识别CSS Modules,以避免手动配置。通过编写Babel插件和调整Webpack配置,可以使得以.module.css为后缀的文件启用CSS Modules,而普通.css文件则不启用。Babel插件通过分析AST来区分导入方式,Webpack则利用resourceQuery匹配启用CSS Modules的文件。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

编者按:本文作者奇舞团前端开发工程师彭体奎

背景

在 React 项目中使用 CSS 时,如果不使用 CSS in JS 的方案,一般会直接在 JS 文件中导入一个 CSS 文件,比如 import './index.css',但这样 CSS 会在全局作用域内都有效,所以我们会使用 CSS Modules1 来解决作用域的问题,使用方法如下:

import styles from './index.css';
const App = () => (
  <div className={styles.App}>App</div>
);

其原理就是将 CSS 文件中的每个 className 按照一定的规则映射为另一个唯一的字符串,以保证 className 在全局作用域内不会重复和冲突。配置方法也很简单,只需要在 webpack 的 css-loader 中添加一个 modules 配置项即可,具体请参考 css-loader 的文档2

有时候我们需要使某个 CSS 文件全局有效,虽然 CSS Modules 也提供了全局有效的方案,但不如直接 import './foo.css' 来的爽快。在 Create React App 中提供了一种解决方案,以 .module.css 为后缀的文件会启用 CSS Modules,以 .css 为后缀的文件不启用,很多脚手架或工具也都采用了这种方案。

缘由

用后缀名区分的方案一直没觉得有什么不妥,只是文件名有点长,不够优雅。直到前几天看到 Umi3 发布了 3.0 版本,出于好奇随便翻了翻文档,发现了一个特别有意思的功能:

Umi 会自动识别 CSS Modules 的使用,你把他当做 CSS Modules 用时才是 CSS Modules。

这个功能很巧妙啊,符合直觉又简单易用。又是出于好奇,看了一下 Umi 的源码,探究一下这是怎么实现的。

实现

通过翻看 Umi 的源码发现,实现这个功能并不复杂,很简单巧妙。

我们可以看到是否使用 CSS Modules 时,两种导入方式不一样,所以我们可以通过 Babel 来将两者做一个区分。

Babel 的运行流程主要分三个阶段:

    评论
    添加红包

    请填写红包祝福语或标题

    红包个数最小为10个

    红包金额最低5元

    当前余额3.43前往充值 >
    需支付:10.00
    成就一亿技术人!
    领取后你会自动成为博主和红包主的粉丝 规则
    hope_wisdom
    发出的红包
    实付
    使用余额支付
    点击重新获取
    扫码支付
    钱包余额 0

    抵扣说明:

    1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
    2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

    余额充值