taro-define-config
v0.10.2
Published
Provide a defineConfig function for tarojs config
Downloads
200
Maintainers
Readme
taro-define-config
Provide a defineConfig function for tarojs config
[!IMPORTANT] For TaroJS v3 support, please use
taro-define-config
< v0.7.0.
Install
npm i taro-define-config -D
yarn add taro-define-config -D
pnpm add taro-define-config -D
Usage
// config/index.js
// @ts-check
const { defineConfig } = require('taro-define-config')
module.exports = defineConfig({
projectName: 'hello-world',
designWidth: 750,
})
// config/index.ts
import { defineConfig } from 'taro-define-config'
export default defineConfig({
projectName: 'hello-world',
designWidth: 750,
})
Why this package
[!NOTE]
Taro introduced a builtin defineConfig function since v3.6.9. Maybe you don't need this package.
Improve your TaroJS project configuration experience with:
- 🍭 more fine-grained type support than built-in
defineConfig
- 🤖 auto-suggestions
- ✅ type checking (Use // @ts-check at the first line in your config file)
- 📖 documentation
- ⚠️ deprecation warnings
Extend plugin types
declare module 'taro-define-config' {
export interface CustomPluginOptionsMap {
'taro-plugin-custom': {
enable?: boolean
}
}
}