close
logologo
指南
配置
插件
API
社区
版本
更新日志
Rsbuild 0.x 文档
English
简体中文
指南
配置
插件
API
社区
更新日志
Rsbuild 0.x 文档
English
简体中文
logologo
Overview
root
mode
plugins
logLevel
environments

dev

dev.assetPrefix
dev.browserLogs
dev.cliShortcuts
dev.client
dev.hmr
dev.lazyCompilation
dev.liveReload
dev.progressBar
dev.setupMiddlewares
dev.watchFiles
dev.writeToDisk

resolve

resolve.aliasStrategy
resolve.alias
resolve.conditionNames
resolve.dedupe
resolve.extensions
resolve.mainFields

source

source.assetsInclude
source.decorators
source.define
source.entry
source.exclude
source.include
source.preEntry
source.transformImport
source.tsconfigPath

output

output.assetPrefix
output.charset
output.cleanDistPath
output.copy
output.cssModules
output.dataUriLimit
output.distPath
output.emitAssets
output.emitCss
output.externals
output.filenameHash
output.filename
output.injectStyles
output.inlineScripts
output.inlineStyles
output.legalComments
output.manifest
output.minify
output.module
output.overrideBrowserslist
output.polyfill
output.sourceMap
output.target

html

html.appIcon
html.crossorigin
html.favicon
html.inject
html.meta
html.mountId
html.outputStructure
html.scriptLoading
html.tags
html.templateParameters
html.template
html.title

server

server.base
server.compress
server.cors
server.headers
server.historyApiFallback
server.host
server.htmlFallback
server.https
server.middlewareMode
server.open
server.port
server.printUrls
server.proxy
server.publicDir
server.strictPort

security

security.nonce
security.sri

tools

tools.bundlerChain
tools.cssExtract
tools.cssLoader
tools.htmlPlugin
tools.lightningcssLoader
tools.postcss
tools.rspack
tools.styleLoader
tools.swc

performance

performance.buildCache
performance.bundleAnalyze
performance.chunkSplit
performance.dnsPrefetch
performance.preconnect
performance.prefetch
performance.preload
performance.printFileSize
performance.profile
performance.removeConsole
performance.removeMomentLocale

moduleFederation

moduleFederation.options
📝 在 GitHub 上编辑此页
上一页dev.browserLogs
下一页dev.client

#dev.cliShortcuts

  • 类型:
type CliShortcuts =
  | boolean
  | {
      help?: boolean | string;
      custom?: (shortcuts: CliShortcut[]) => CliShortcut[];
    };
  • 默认值: 当使用 Rsbuild CLI 时默认为 true,否则为 false。
  • 版本: >= 1.0.11

是否启用 CLI 快捷键。

#所有快捷键

按 h + Enter 以显示所有快捷键:

  Shortcuts:
  c + enter  clear console
  o + enter  open in browser
  q + enter  quit process
  r + enter  restart server
  u + enter  show urls

#示例

  • 启用:
rsbuild.config.ts
export default {
  dev: {
    cliShortcuts: true,
  },
};
  • 禁用:
rsbuild.config.ts
export default {
  dev: {
    cliShortcuts: false,
  },
};

#自定义快捷键

custom 选项可以自定义快捷键,custom 的值是一个函数,接收默认的 shortcuts 列表,并返回一个新的 shortcuts 列表。

  • 添加自定义快捷键:
rsbuild.config.ts
export default {
  dev: {
    cliShortcuts: {
      custom: (shortcuts) => {
        return [
          ...shortcuts,
          {
            key: 's',
            description: 'say hello',
            action: () => {
              console.log('hello world!');
            },
          },
        ];
      },
    },
  },
};
  • 禁用部分快捷键:
rsbuild.config.ts
export default {
  dev: {
    cliShortcuts: {
      custom: (shortcuts) => {
        return shortcuts.filter((shortcut) => shortcut.key !== 'o');
      },
    },
  },
};

#打印帮助

help 选项可以控制是否在启动服务器时打印帮助提示,默认打印的帮助提示为:

  ➜ press h + enter to show shortcuts
  • 禁用帮助提示:
rsbuild.config.ts
export default {
  dev: {
    cliShortcuts: {
      help: false,
    },
  },
};
  • 输出自定义的帮助提示:
rsbuild.config.ts
export default {
  dev: {
    cliShortcuts: {
      help: 'type "h + enter" to view available commands',
    },
  },
};