tailwindcss/src/featureFlags.js

113 lines
2.9 KiB
JavaScript
Raw Normal View History

2020-08-06 16:02:09 -04:00
import _ from 'lodash'
import chalk from 'chalk'
const featureFlags = {
future: ['removeDeprecatedGapUtilities'],
2020-08-07 15:10:10 -04:00
experimental: [
'uniformColorPalette',
'extendedSpacingScale',
'defaultLineHeights',
'extendedFontSizeScale',
'applyComplexClasses',
2020-08-07 15:10:10 -04:00
],
2020-08-06 16:02:09 -04:00
}
export function flagEnabled(config, flag) {
if (featureFlags.future.includes(flag)) {
return config.future === 'all' || _.get(config, ['future', flag], false)
2020-08-06 16:02:09 -04:00
}
if (featureFlags.experimental.includes(flag)) {
return config.experimental === 'all' || _.get(config, ['experimental', flag], false)
2020-08-06 16:02:09 -04:00
}
return false
}
function futureFlagsEnabled(config) {
if (config.future === 'all') {
return featureFlags.future
}
return Object.keys(_.get(config, 'future', {})).filter(
flag => featureFlags.future.includes(flag) && config.future[flag]
)
}
function experimentalFlagsEnabled(config) {
if (config.experimental === 'all') {
return featureFlags.experimental
}
return Object.keys(_.get(config, 'experimental', {})).filter(
flag => featureFlags.experimental.includes(flag) && config.experimental[flag]
)
}
function futureFlagsAvailable(config) {
if (config.future === 'all') {
return []
}
return featureFlags.future.filter(flag => !_.has(config, ['future', flag]))
}
2020-08-06 16:02:09 -04:00
export function issueFlagNotices(config) {
const log = {
2020-08-18 13:23:08 -04:00
info(messages) {
console.log('')
messages.forEach(message => {
console.log(chalk.bold.cyan('info'), '-', message)
})
2020-08-06 16:02:09 -04:00
},
2020-08-18 13:23:08 -04:00
warn(messages) {
console.log('')
messages.forEach(message => {
console.log(chalk.bold.yellow('warn'), '-', message)
})
2020-08-06 16:02:09 -04:00
},
2020-08-18 13:23:08 -04:00
risk(messages) {
console.log('')
messages.forEach(message => {
console.log(chalk.bold.magenta('risk'), '-', message)
})
2020-08-06 16:02:09 -04:00
},
}
if (futureFlagsEnabled(config).length > 0) {
const changes = futureFlagsEnabled(config)
2020-08-06 16:02:09 -04:00
.map(s => chalk.cyan(s))
.join(', ')
2020-08-18 13:23:08 -04:00
log.info([
`You have opted-in to future-facing breaking changes: ${changes}`,
'These changes are stable and will be the default behavior in the next major version of Tailwind.',
])
2020-08-06 16:02:09 -04:00
}
if (experimentalFlagsEnabled(config).length > 0) {
const changes = experimentalFlagsEnabled(config)
2020-08-06 16:02:09 -04:00
.map(s => chalk.yellow(s))
.join(', ')
2020-08-18 13:23:08 -04:00
log.warn([
`You have enabled experimental features: ${changes}`,
'Experimental features are not covered by semver, may introduce breaking changes, and can change at any time.',
])
2020-08-06 16:02:09 -04:00
}
if (futureFlagsAvailable(config).length > 0) {
const changes = futureFlagsAvailable(config)
2020-08-06 16:02:09 -04:00
.map(s => chalk.magenta(s))
.join(', ')
2020-08-18 13:23:08 -04:00
log.risk([
`There are upcoming breaking changes: ${changes}`,
'We highly recommend opting-in to these changes now to simplify upgrading Tailwind in the future.',
'https://tailwindcss.com/docs/upcoming-changes',
])
2020-08-06 16:02:09 -04:00
}
}
export default featureFlags