@spcsn/taro 0.1.0

package/types/compile/config/h5.d.ts

@@ -0,0 +1,134 @@
+import type Webpack from 'webpack'
+import type Chain from 'webpack-chain'
+import type webpackDevServer from 'webpack-dev-server'
+import type HtmlWebpackPlugin from 'html-webpack-plugin'
+import type { IOption, IPostcssOption, IUrlLoaderOption } from './util'
+import type { OutputOptions as RollupOutputOptions } from 'rollup'
+import type { Compiler, CompilerTypes, CompilerWebpackTypes } from '../compiler'
+import type { OutputExt } from './project'
+import type { ServerOptions as ViteServerOptions } from 'vite'
+
+export interface IH5RouterConfig {
+  /** 配置路由模式 */
+  mode?: 'hash' | 'browser' | 'multi'
+  /** 配置自定义路由 */
+  customRoutes?: IOption
+  /** 配置路由基准路径 */
+  basename?: string
+  lazyload?: boolean | ((pagename: string) => boolean)
+  renamePagename?: (pagename: string) => string
+  forcePath?: string
+  /** 加上这个参数，可以解决返回页面的时候白屏的问题，但是某些不支持 :has() 选择器的浏览器会有问题 */
+  enhanceAnimation?: boolean
+}
+
+export interface IH5Config <T extends CompilerTypes = CompilerWebpackTypes> {
+  /** 设置输出解析文件的目录（默认值：'/'）*/
+  publicPath?: string
+
+  /** h5 编译后的静态文件目录（默认值：'static'） */
+  staticDirectory?: string
+
+  /** 编译后非 entry 的 js 文件的存放目录，主要影响动态引入的 pages 的存放路径（默认值：'chunk'） */
+  chunkDirectory?: string
+
+  webpack?: ((webpackConfig: Webpack.Configuration, webpack) => Webpack.Configuration) | Webpack.Configuration
+
+  /**
+   * 自定义 Webpack 配置
+   * @param chain  [webpackChain](https://github.com/neutrinojs/webpack-chain) 对象
+   * @param webpack webpack 实例
+   */
+  webpackChain?: (chain: Chain, webpack: typeof Webpack) => void
+
+  /** webpack 编译模式下，可用于修改、拓展 Webpack 的 output 选项，配置项参考[官方文档](https://webpack.js.org/configuration/output/)
+  * vite 编译模式下，用于修改、扩展 rollup 的 output，目前仅适配 chunkFileNames 和 assetFileNames 两个配置，修改其他配置请使用 vite 插件进行修改。配置想参考[官方文档](https://rollupjs.org/configuration-options/)
+  */
+  output?: T extends 'vite'
+    ? Pick<RollupOutputOptions, 'chunkFileNames' | 'assetFileNames'>  & OutputExt
+    : Webpack.Configuration['output']
+
+  /** 路由相关的配置 */
+  router?: IH5RouterConfig
+
+  /** 预览服务的配置，可以更改端口等参数。具体配置参考 [webpack-dev-server](https://webpack.js.org/configuration/dev-server) */
+  // 修改后：同时支持 Webpack 和 Vite
+  devServer?: T extends 'vite' ? ViteServerOptions : webpackDevServer.Configuration
+
+  /** 用于控制是否生成 js、css 对应的 sourceMap (默认值：watch 模式下为 true，否则为 false) */
+  enableSourceMap?: boolean
+
+  /**  具体配置请参考 [Webpack devtool](https://webpack.js.org/configuration/devtool/#devtool) 配置 (默认值：'cheap-module-eval-source-map')*/
+  sourceMapType?:
+    | 'none'
+    | 'eval'
+    | 'cheap-eval-source-map'
+    | 'cheap-module-eval-source-map'
+    | 'eval-source-map'
+    | 'cheap-source-map'
+    | 'cheap-module-source-map'
+    | 'inline-cheap-source-map'
+    | 'inline-cheap-module-source-map'
+    | 'source-map'
+    | 'inline-source-map'
+    | 'hidden-source-map'
+    | 'nosources-source-map'
+
+  /** extract 功能开关，开启后将使用 mini-css-extract-plugin 分离 css 文件，可通过 h5.miniCssExtractPluginOption 对插件进行配置 (默认值：watch 模式下为 false，否则为 true) */
+  enableExtract?: boolean
+
+  /** [css-loader](https://github.com/webpack-contrib/css-loader) 的附加配置 */
+  cssLoaderOption?: IOption
+
+  /** [style-loader](https://github.com/webpack-contrib/style-loader) 的附加配置 */
+  styleLoaderOption?: IOption
+
+  /** [sass-loader](https://github.com/webpack-contrib/sass-loader) 的附加配置 */
+  sassLoaderOption?: IOption
+
+  /** [less-loader](https://github.com/webpack-contrib/less-loader) 的附加配置 */
+  lessLoaderOption?: IOption
+
+  /** [stylus-loader](https://github.com/shama/stylus-loader) 的附加配置 */
+  stylusLoaderOption?: IOption
+
+  /** 针对 mp4 | webm | ogg | mp3 | wav | flac | aac 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  mediaUrlLoaderOption?: IUrlLoaderOption
+
+  /** 针对 woff | woff2 | eot | ttf | otf 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  fontUrlLoaderOption?: IUrlLoaderOption
+
+  /** 针对 png | jpg | jpeg | gif | bpm | svg 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  imageUrlLoaderOption?: IUrlLoaderOption
+
+  /** [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) 的附加配置 */
+  miniCssExtractPluginOption?: IOption
+
+  /** 配置需要额外的经由 Taro 预设的 postcss 编译的模块 */
+  esnextModules?: string[]
+
+  /** 用于控制在 H5 端是否使用兼容性组件库，详情请看 [React 兼容性组件库](https://taro-docs.jd.com/docs/h5#react-兼容性组件库)。(默认值：false) */
+  useHtmlComponents?: boolean
+
+  /** 用于控制在 H5 端是否使用旧版本适配器，旧版本采用全局注册组件，懒加载组件相关依赖；新版本适配器会自动注册相关组件，不再需要引入 @spcsn/taro-components/loader 中的全局 defineCustomElements 方法。(默认值：false) */
+  useDeprecatedAdapterComponent?: boolean
+
+  /** 配置 postcss 相关插件 */
+  postcss?: IPostcssOption<'h5'>
+
+  /** html-webpack-plugin 的具体配置 */
+  htmlPluginOption?: HtmlWebpackPlugin.Options
+
+  /** Web 编译过程的相关配置 */
+  compile?: {
+    exclude?: any[]
+    include?: any[]
+    /** 对应 Babel transform 插件的 filter 配置。只在 vite 编译模式下有效 */
+    filter?: (filename: string) => boolean
+  }
+  /** 生成的代码是否要兼容旧版浏览器，值为 true 时，会去读取 package.json 的 browserslist 字段。只在 vite 编译模式下有效 */
+  legacy?: T extends 'vite' ? boolean : undefined
+
+  /** 使用的编译工具。可选值：webpack5、vite */
+  compiler?: Compiler<T>
+}

package/types/compile/config/harmony.d.ts

@@ -0,0 +1,118 @@
+import type { OutputOptions as RollupOutputOptions } from 'rollup'
+import type Webpack from 'webpack'
+import type Chain from 'webpack-chain'
+
+import type { IOption, IPostcssOption, IUrlLoaderOption } from './util'
+import type { CompilerTypes, CompilerWebpackTypes } from '../compiler'
+import type { OutputExt } from './project'
+
+export interface IHarmonyRouterConfig {
+  /** 配置自定义路由 */
+  customRoutes?: IOption
+}
+
+export interface IHarmonyConfig<T extends CompilerTypes = 'vite'> {
+  /** Harmony 项目地址 */
+  projectPath: string
+
+  /** hap 名
+   * @default "entry"
+   */
+  hapName?: string
+
+  /** 应用名称
+   * @default "default"
+   */
+  name?: string
+
+  /** oh-package.json 配置 */
+  ohPackage?: {
+    dependencies?: { [name: string]: string }
+    devDependencies?: { [name: string]: string }
+    main?: string
+    [k: string]: any
+  }
+
+  /** ohpm-cli
+   * @default "~/Library/Huawei/ohpm/bin/ohpm"
+   */
+  ohpm?: string
+
+  /** 核心依赖前缀
+   * @description 用于告诉编译内容如何解析核心依赖，传入时将直接使用依赖前缀，同时不会为工程导入核心依赖
+   */
+  chorePackagePrefix?: string
+
+  /** 用于告诉 Taro 编译器需要抽取的公共文件 */
+  commonChunks?: string[] | ((commonChunks: string[]) => string[])
+
+  /** Harmony 编译过程的相关配置 */
+  compile?: {
+    exclude?: any[]
+    include?: any[]
+    filter?: (filename: string) => boolean
+  }
+
+  /** 用于配置半编译模式下的选项 */
+  compileModeSetting?: {
+    componentReplace?: {
+      [key: string]: {
+        current_init: string
+        dependency_define: string
+      }
+    }
+  }
+
+  /** 用于控制是否生成 js、css 对应的 sourceMap (默认值：watch 模式下为 true，否则为 false) */
+  enableSourceMap?: boolean
+
+  /** 默认值：'cheap-module-source-map'， 具体参考[Webpack devtool 配置](https://webpack.js.org/configuration/devtool/#devtool) */
+  sourceMapType?: string
+
+  /** 指定 React 框架相关的代码是否使用开发环境（未压缩）代码，默认使用生产环境（压缩后）代码 */
+  debugReact?: boolean
+
+  /**
+   * 自定义 Webpack 配置
+   * @param chain  [webpackChain](https://github.com/neutrinojs/webpack-chain) 对象
+   * @param webpack webpack 实例
+   */
+  webpackChain?: (chain: Chain, webpack: typeof Webpack) => void
+
+  /** webpack 编译模式下，可用于修改、拓展 Webpack 的 output 选项，配置项参考[官方文档](https://webpack.js.org/configuration/output/)
+   * vite 编译模式下，用于修改、扩展 rollup 的 output，目前仅适配 chunkFileNames 和 assetFileNames 两个配置，修改其他配置请使用 vite 插件进行修改。配置想参考[官方文档](https://rollupjs.org/configuration-options/)
+   */
+  output?: T extends 'vite'
+    ? Pick<RollupOutputOptions, 'chunkFileNames'> & OutputExt
+    : Webpack.Configuration['output'] & OutputExt
+
+  /** 路由相关的配置 */
+  router?: IHarmonyRouterConfig
+
+  /** 配置 postcss 相关插件 */
+  postcss?: IPostcssOption<'harmony'>
+
+  /** [css-loader](https://github.com/webpack-contrib/css-loader) 的附加配置 */
+  cssLoaderOption?: IOption
+
+  /** [sass-loader](https://github.com/webpack-contrib/sass-loader) 的附加配置 */
+  sassLoaderOption?: IOption
+
+  /** [less-loader](https://github.com/webpack-contrib/less-loader) 的附加配置 */
+  lessLoaderOption?: IOption
+
+  /** [stylus-loader](https://github.com/shama/stylus-loader) 的附加配置 */
+  stylusLoaderOption?: IOption
+
+  /** 针对 mp4 | webm | ogg | mp3 | wav | flac | aac 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  mediaUrlLoaderOption?: IUrlLoaderOption
+
+  /** 针对 woff | woff2 | eot | ttf | otf 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  fontUrlLoaderOption?: IUrlLoaderOption
+
+  /** 针对 png | jpg | jpeg | gif | bpm | svg 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  imageUrlLoaderOption?: IUrlLoaderOption
+
+  /** [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) 的附加配置 */
+  miniCssExtractPluginOption?: IOption
+}

package/types/compile/config/index.d.ts

@@ -0,0 +1,8 @@
+export * from './h5'
+export * from './harmony'
+export * from './mini'
+export * from './rn'
+
+export * from './manifest'
+export * from './project'
+export * from './util'

package/types/compile/config/manifest.d.ts

@@ -0,0 +1,155 @@
+import type { IOption } from './util'
+
+type FeatureItem = {
+  name: string
+}
+
+declare enum LogLevel {
+  OFF = 'off',
+  ERROR = 'error',
+  WARN = 'warn',
+  INFO = 'info',
+  LOG = 'log',
+  DEBUG = 'debug'
+}
+
+export type SystemConfig = {
+  /**
+   * 打印日志等级，分为 off,error,warn,info,log,debug
+   */
+  logLevel?: LogLevel
+  /**
+   * 页面设计基准宽度，根据实际设备宽度来缩放元素大小
+   */
+  designWidth?: number
+  /**
+   * 全局数据对象，属性名不能以$或_开头，在页面中可通过 this 进行访问;如果全局数据属性与页面的数据属性重名，则页面初始化时，全局数据会覆盖页面中对应的属性值
+   */
+  data?: IOption
+}
+
+type RouterConfig = {
+  /**
+   * 首页名称
+   */
+  entry: string
+  /**
+   * 页面配置列表，key 值为页面名称（对应页面目录名，例如 Hello 对应'Hello'目录），value 为页面详细配置 page
+   */
+  pages: RouterPage[]
+}
+type RouterPage = {
+  /**
+   * 页面对应的组件名，与 ux 文件名保持一致，例如'hello' 对应 'hello.ux'
+   */
+  component: string
+  /**
+   * 页面路径，例如“/user”,不填则默认为/<页面名称>。
+   * path 必须唯一,不能和其他 page 的 path 相同。
+   * 下面 page 的 path 因为缺失,会被设置为“/Index”：
+   * "Index": {"component": "index"}
+   */
+  path?: string
+  /**
+   * 声明页面可以处理某种请求
+   */
+  filter: {
+    [key: string]: {
+      uri: string
+    }
+  }
+}
+
+interface IDefaultDisplayConfig {
+  /**
+   * 窗口背景颜色
+   */
+  backgroundColor?: string
+  /**
+   * 是否是全屏模式，默认不会同时作用于 titleBar，titleBar 需要继续通过 titleBar 控制
+   */
+  fullScreen?: boolean
+  /**
+   * 是否显示 titleBar
+   */
+  titleBar?: boolean
+  /**
+   * 标题栏背景色
+   */
+  titleBarBackgroundColor?: string
+  /**
+   * 标题栏文字颜色
+   */
+  titleBarTextColor?: string
+  /**
+   * 标题栏文字(也可通过页面跳转传递参数(titleBarText)设置)
+   */
+  titleBarText?: string
+  /**
+   * 是否显示标题栏右上角菜单按钮，点击菜单按钮调用页面生命周期 onMenuPress 方法，如果该方法未实现则显示系统默认菜单
+   */
+  menu?: boolean
+  /**
+   * 软键盘弹出时为保证输入框可见，页面的调整方式。　adjustPan:上移页面; adjustResize:压缩页面显示区域，当页面全屏时，此设置不生效
+   */
+  windowSoftInputMode?: 'adjustPan' | 'adjustResize'
+}
+
+interface IDisplayConfig extends IDefaultDisplayConfig {
+  /**
+   * 各个页面的显示样式，key 为页面名（与路由中的页面名保持一致），value 为窗口显示样式，页面样式覆盖 default 样式
+   */
+  pages?: {
+    [key: string]: IDefaultDisplayConfig
+  }
+}
+
+export interface ITaroManifestConfig {
+  /**
+   * 应用包名，确认与原生应用的包名不一致，推荐采用 com.company.module 的格式，如：com.example.demo
+   */
+  package: string
+  /**
+   * 应用名称，6 个汉字以内，与应用商店保存的名称一致，用于在桌面图标、弹窗等处显示应用名称
+   */
+  name: string
+  /**
+   * 应用图标，提供 192x192 大小的即可
+   */
+  icon: string
+  /**
+   * 应用版本名称，如："1.0"
+   */
+  versionName?: string
+  /**
+   * 应用版本号，从1自增，推荐每次重新上传包时versionCode+1
+   */
+  versionCode: number
+  /**
+   * 支持的最小平台版本号，兼容性检查，避免上线后在低版本平台运行并导致不兼容；如果不填按照内测版本处理
+   */
+  minPlatformVersion?: string
+  /**
+   * 接口列表，绝大部分接口都需要在这里声明，否则不能调用，详见每个接口的文档说明
+   */
+  features?: FeatureItem[]
+  /**
+   *
+   */
+  logLevel?: LogLevel
+}
+
+export interface IManifestConfig extends ITaroManifestConfig {
+  /**
+   * 系统配置信息
+   */
+  config: SystemConfig
+  /**
+   * 路由信息
+   */
+  router: RouterConfig
+  /**
+   * UI 显示相关配置
+   */
+  display?: IDisplayConfig
+}

package/types/compile/config/mini.d.ts

@@ -0,0 +1,118 @@
+import type Webpack from 'webpack'
+import type Chain from 'webpack-chain'
+import type { IOption, IPostcssOption, IUrlLoaderOption } from './util'
+import type { OutputOptions as RollupOutputOptions } from 'rollup'
+import type { Compiler, CompilerTypes, CompilerWebpackTypes } from '../compiler'
+import type { OutputExt } from './project'
+
+interface Runtime {
+  enableSizeAPIs?: boolean
+  enableTemplateContent?: boolean
+  enableCloneNode?: boolean
+  enableContains?: boolean
+  enableMutationObserver?: boolean
+}
+
+export interface IMiniAppConfig<T extends CompilerTypes = CompilerWebpackTypes> {
+  /** 用于控制是否生成 js、css 对应的 sourceMap (默认值：watch 模式下为 true，否则为 false) */
+  enableSourceMap?: boolean
+
+  /** 默认值：'cheap-module-source-map'， 具体参考[Webpack devtool 配置](https://webpack.js.org/configuration/devtool/#devtool) */
+  sourceMapType?: string
+
+  /** 指定 React 框架相关的代码是否使用开发环境（未压缩）代码，默认使用生产环境（压缩后）代码 */
+  debugReact?: boolean
+
+  /** 是否跳过第三方依赖 usingComponent 的处理，默认为自动处理第三方依赖的自定义组件 */
+  skipProcessUsingComponents?: boolean
+
+  /** 压缩小程序 xml 文件的相关配置 */
+  minifyXML?: {
+    /** 是否合并 xml 文件中的空格 (默认false) */
+    collapseWhitespace?: boolean
+  }
+
+  /**
+   * 自定义 Webpack 配置
+   * @param chain  [webpackChain](https://github.com/neutrinojs/webpack-chain) 对象
+   * @param webpack webpack 实例
+   * @param PARSE_AST_TYPE 小程序编译时的文件类型集合
+   * @returns
+   */
+  webpackChain?: (chain: Chain, webpack: typeof Webpack, PARSE_AST_TYPE: any) => void
+
+  /** webpack 编译模式下，可用于修改、拓展 Webpack 的 output 选项，配置项参考[官方文档](https://webpack.js.org/configuration/output/)
+  * vite 编译模式下，用于修改、扩展 rollup 的 output，目前仅适配 chunkFileNames 和 assetFileNames 两个配置，修改其他配置请使用 vite 插件进行修改。配置想参考[官方文档](https://rollupjs.org/configuration-options/)
+  */
+  output?: T extends 'vite'
+    ? Pick<RollupOutputOptions, 'chunkFileNames'>  & OutputExt
+    : Webpack.Configuration['output'] & OutputExt
+
+  /** 配置 postcss 相关插件 */
+  postcss?: IPostcssOption<'mini'>
+
+  /** [css-loader](https://github.com/webpack-contrib/css-loader) 的附加配置 */
+  cssLoaderOption?: IOption
+
+  /** [sass-loader](https://github.com/webpack-contrib/sass-loader) 的附加配置 */
+  sassLoaderOption?: IOption
+
+  /** [less-loader](https://github.com/webpack-contrib/less-loader) 的附加配置 */
+  lessLoaderOption?: IOption
+
+  /** [stylus-loader](https://github.com/shama/stylus-loader) 的附加配置 */
+  stylusLoaderOption?: IOption
+
+  /** 针对 mp4 | webm | ogg | mp3 | wav | flac | aac 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  mediaUrlLoaderOption?: IUrlLoaderOption
+
+  /** 针对 woff | woff2 | eot | ttf | otf 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  fontUrlLoaderOption?: IUrlLoaderOption
+
+  /** 针对 png | jpg | jpeg | gif | bpm | svg 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
+  imageUrlLoaderOption?: IUrlLoaderOption
+
+  /** [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) 的附加配置 */
+  miniCssExtractPluginOption?: IOption
+
+  /** 用于告诉 Taro 编译器需要抽取的公共文件 */
+  commonChunks?: string[] | ((commonChunks: string[]) => string[])
+
+  /** 为某些页面单独指定需要引用的公共文件 */
+  addChunkPages?: (pages: Map<string, string[]>, pagesNames?: string[]) => void
+
+  /** 优化主包的体积大小 */
+  optimizeMainPackage?: {
+    enable?: boolean
+    exclude?: any[]
+  }
+
+  /** 小程序编译过程的相关配置 */
+  compile?: {
+    exclude?: any[]
+    include?: any[]
+    /** 对应 Babel transform 插件的 filter 配置。只在 vite 编译模式下有效 */
+    filter?: (filename: string) => boolean
+  }
+
+  /** 插件内部使用 */
+  runtime?: Runtime
+
+  /** 使用的编译工具。可选值：webpack5、vite */
+  compiler?: Compiler<T>
+
+  /** 体验式功能 */
+  experimental?: {
+    /** 是否开启编译模式 */
+    compileMode?: boolean | string
+    /** 模版渲染时是否使用wxs等小程序脚本语言 */
+    useXsForTemplate?: boolean
+  }
+}
+
+export interface IMiniFilesConfig {
+  [configName: string]: {
+    content: any
+    path: string
+  }
+}

package/types/compile/config/plugin.d.ts

@@ -0,0 +1,34 @@
+import type { CustomPluginOptions, ResolvedId, ResolveIdResult } from 'rollup'
+
+interface IRollupPluginResolveIdOptions {
+  assertions?: Record<string, string>
+  custom?: CustomPluginOptions
+  isEntry?: boolean
+  skipSelf?: boolean
+}
+
+export type TRollupResolveMethod = (
+  source: string,
+  importer?: string,
+  options?: IRollupPluginResolveIdOptions
+) => Promise<ResolvedId | null>
+
+export interface ILoaderMeta {
+  importFrameworkStatement: string
+  importFrameworkName: string
+  creator: string
+  creatorLocation: string
+  extraImportForWeb: string
+  execBeforeCreateWebApp: string
+  frameworkArgs: string
+  isNeedRawLoader?: boolean
+  mockAppStatement: string
+  modifyConfig?: (config: Record<string, any>, source: string) => void
+  modifyResolveId?: (res: {
+    source?: string
+    importer?: string
+    options?: IRollupPluginResolveIdOptions
+    name?: string
+    resolve: TRollupResolveMethod
+  }) => Promise<ResolveIdResult> | ResolveIdResult
+}