Storybook 按需加載指定包(從命令行中獲取包名)

起因

在使用storybook@6.1.21時(shí)厦画,可能只想關(guān)注其中一個(gè)或多個(gè)UI組件假哎,但storybook將所有組件都給打包了妓湘;

導(dǎo)致的問題

  1. 展示的組件太多玷禽;
  2. 啟動(dòng)時(shí)間變慢赫段;
  3. 如果其它包有問題,會(huì)導(dǎo)致啟動(dòng)失斅垩堋瑞佩;

需求

在啟動(dòng)時(shí),只啟動(dòng)指定UI組件坯台,其它組件即不打包炬丸,也不渲染;

配置文件

1. 文件目錄

20210705164628242.png

2. config.js

import { configure } from '@storybook/react';

const req = require.context('../packages', true, /\.(stories|story)\.(tsx|jsx|js)$/);
function loadStories() {
  req.keys().forEach(filename => req(filename));
}
configure(loadStories, module);

3. webpack.config.js

module.exports = ({ config }) => {
  /** other config **/
  return config;
};

4. 版本信息

storybook: 6.1.21

解決方案:

方案1:webpack.DefinePlugin

原理

利用webpack.DefinePlugin定義全局變量蜒蕾,并替換config.js中的require上下文路徑

config.js

import { configure } from '@storybook/react';

/** 變化點(diǎn):將真實(shí)路徑正則用 占位字符串 REPLACE_COMPONENT_DIR_REG_STR 代替 **/
const req = require.context('../packages', true, REPLACE_COMPONENT_DIR_REG_STR);
/** end **/
function loadStories() {
  req.keys().forEach(filename => req(filename));
}
configure(loadStories, module);

webpack.config.js

const webpack = require('webpack');

/** 變化點(diǎn):從命令行參數(shù)中獲取組件名 **/
let componentName;
try {
  const [cmd1, cmd2] = JSON.parse(process.env.npm_config_argv).original.slice(-2);
  if (cmd1 === 'start' && cmd2 && cmd2.trim()) {
    componentName = cmd2
      .split(',')
      .map(item => item && item.trim())
      .filter(Boolean)
      .join('|');
  }
}catch(e) {console.error(e)}
/** end **/

module.exports = ({ config }) => {
  /** other config **/
  /** 變化點(diǎn):使用 webpack.DefinePlugin 插件在打包的時(shí)候?qū)?占位字符串 替換掉 **/
  config.plugins.push(new webpack.DefinePlugin({
    REPLACE_COMPONENT_DIR_REG_STR: `/\\/(${componentName})\\/.*\\.(stories|story)\\.(tsx|jsx|js)$/`
  }))稠炬;
  /** end **/
  return config;
};

方案2:自定義loader

原理

自定義一個(gè)webpack的loader,在打包c(diǎn)onfig.js文件時(shí)替換 require.context 的正則表達(dá)式

config.js

import { configure } from '@storybook/react';

/** 變化點(diǎn):在正則表達(dá)式中使用 占位字符串 %REPLACE_COMPONENT_DIR_NAME% **/
const req = require.context('../packages', true, /%REPLACE_COMPONENT_DIR_NAME%\.(stories|story)\.(tsx|jsx|js)$/);
/** end **/
function loadStories() {
  req.keys().forEach(filename => req(filename));
}
configure(loadStories, module);

webpack.config.js

/** 變化點(diǎn) **/
const path = require('path');
/** end **/

module.exports = ({ config }) => {
  /** other config **/
  /** 變化點(diǎn):為 .storybook/config.js 文件定制一個(gè)loader **/
  config.module.rules.push({
    test: /\.storybook\/config\.js$/,
    use: path.resolve(__dirname, './cus-set-package-loader.js'),
  });
  /** end **/
  return config;
};

.storybook/cus-set-package-loader.js

module.exports = res => {
  // 從命令行參數(shù)中獲取組件名
  let componentName
  try {
    const [cmd1, cmd2] = JSON.parse(process.env.npm_config_argv).original.slice(-2)
    if (cmd1 === 'start' && cmd2 && cmd2.trim()) componentName = cmd2
  }catch(e) {console.error(e)}
  console.log('\n\x1b[33m%s\x1b[0m', `package names: ${componentName || 'all packages'}`)
  // 處理 多組件 和 組件名中的空格
  const componentDirName = componentName
    ? `\\/(${componentName.split(',')
      .map(item => item && item.trim())
      .filter(Boolean)
      .join('|')})\\/.*`
    : ''
  // 替換配置文件中的 占位符
  return res.replace('%REPLACE_COMPONENT_DIR_NAME%', componentDirName)
}

啟動(dòng)

npm start componentName1, componentName2
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末咪啡,一起剝皮案震驚了整個(gè)濱河市首启,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌撤摸,老刑警劉巖毅桃,帶你破解...
    沈念sama閱讀 217,734評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件褒纲,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡钥飞,警方通過查閱死者的電腦和手機(jī)莺掠,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,931評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來读宙,“玉大人彻秆,你說我怎么就攤上這事〗嵴ⅲ” “怎么了唇兑?”我有些...
    開封第一講書人閱讀 164,133評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長桦锄。 經(jīng)常有香客問我扎附,道長,這世上最難降的妖魔是什么结耀? 我笑而不...
    開封第一講書人閱讀 58,532評(píng)論 1 293
  • 正文 為了忘掉前任帕棉,我火速辦了婚禮,結(jié)果婚禮上饼记,老公的妹妹穿的比我還像新娘。我一直安慰自己慰枕,他們只是感情好具则,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,585評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著具帮,像睡著了一般博肋。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上蜂厅,一...
    開封第一講書人閱讀 51,462評(píng)論 1 302
  • 那天匪凡,我揣著相機(jī)與錄音,去河邊找鬼掘猿。 笑死病游,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的稠通。 我是一名探鬼主播衬衬,決...
    沈念sama閱讀 40,262評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼改橘!你這毒婦竟也來了滋尉?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,153評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤飞主,失蹤者是張志新(化名)和其女友劉穎狮惜,沒想到半個(gè)月后高诺,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,587評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡碾篡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,792評(píng)論 3 336
  • 正文 我和宋清朗相戀三年虱而,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片耽梅。...
    茶點(diǎn)故事閱讀 39,919評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡薛窥,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出眼姐,到底是詐尸還是另有隱情诅迷,我是刑警寧澤,帶...
    沈念sama閱讀 35,635評(píng)論 5 345
  • 正文 年R本政府宣布众旗,位于F島的核電站罢杉,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏贡歧。R本人自食惡果不足惜滩租,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,237評(píng)論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望利朵。 院中可真熱鬧律想,春花似錦、人聲如沸绍弟。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,855評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽樟遣。三九已至而叼,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間豹悬,已是汗流浹背葵陵。 一陣腳步聲響...
    開封第一講書人閱讀 32,983評(píng)論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留瞻佛,地道東北人脱篙。 一個(gè)月前我還...
    沈念sama閱讀 48,048評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像涤久,于是被迫代替她去往敵國和親涡尘。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,864評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容