-
Notifications
You must be signed in to change notification settings - Fork 180
/
module.ts
173 lines (149 loc) · 6.62 KB
/
module.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
import { join } from 'pathe'
import { withTrailingSlash } from 'ufo'
import {
defineNuxtModule,
installModule,
isNuxt2,
getNuxtVersion,
resolvePath,
useNuxt,
createResolver,
addImports,
updateTemplates,
addTemplate,
} from '@nuxt/kit'
// @ts-expect-error no declaration file
import defaultTailwindConfig from 'tailwindcss/stubs/config.simple.js'
import { name, version, configKey, compatibility } from '../package.json'
import * as resolvers from './resolvers'
import logger, { LogLevels } from './logger'
import { createExposeTemplates } from './expose'
import { setupViewer, exportViewer } from './viewer'
import { createInternalContext } from './context'
import type { ModuleOptions, ModuleHooks } from './types'
export type { ModuleOptions, ModuleHooks } from './types'
const deprecationWarnings = (moduleOptions: ModuleOptions, nuxt = useNuxt()) =>
([
['addTwUtil', 'Use `editorSupport.autocompleteUtil` instead.'],
['exposeLevel', 'Use `exposeConfig.level` instead.'],
['injectPosition', `Use \`cssPath: [${
moduleOptions.cssPath === join(nuxt.options.dir.assets, 'css/tailwind.css')
? '"~/assets/css/tailwind.css"'
: typeof moduleOptions.cssPath === 'string' ? `"${moduleOptions.cssPath}"` : moduleOptions.cssPath
}, { injectPosition: ${JSON.stringify(moduleOptions.injectPosition)} }]\` instead.`],
] satisfies Array<[keyof ModuleOptions, string]>).forEach(
([dOption, alternative]) => moduleOptions[dOption] !== undefined && logger.warn(`Deprecated \`${dOption}\`. ${alternative}`),
)
const defaults = (nuxt = useNuxt()): ModuleOptions => ({
configPath: 'tailwind.config',
cssPath: join(nuxt.options.dir.assets, 'css/tailwind.css'),
config: defaultTailwindConfig,
viewer: true,
exposeConfig: false,
quiet: nuxt.options.logLevel === 'silent',
editorSupport: false,
})
export default defineNuxtModule<ModuleOptions>({
meta: { name, version, configKey, compatibility }, defaults,
async setup(moduleOptions, nuxt) {
if (moduleOptions.quiet) logger.level = LogLevels.silent
deprecationWarnings(moduleOptions, nuxt)
// install postcss8 module on nuxt < 2.16
if (Number.parseFloat(getNuxtVersion()) < 2.16) {
await installModule('@nuxt/postcss8').catch((e) => {
logger.error(`Error occurred while loading \`@nuxt/postcss8\` required for Nuxt ${getNuxtVersion()}, is it installed?`)
throw e
})
}
const ctx = await createInternalContext(moduleOptions, nuxt)
if (moduleOptions.editorSupport || moduleOptions.addTwUtil) {
const editorSupportConfig = resolvers.resolveEditorSupportConfig(moduleOptions.editorSupport)
if ((editorSupportConfig.autocompleteUtil || moduleOptions.addTwUtil) && !isNuxt2()) {
addImports({
name: 'autocompleteUtil',
from: createResolver(import.meta.url).resolve('./runtime/utils'),
as: 'tw',
...(typeof editorSupportConfig.autocompleteUtil === 'object' ? editorSupportConfig.autocompleteUtil : {}),
})
}
}
// css file handling
const [cssPath, cssPathConfig] = Array.isArray(moduleOptions.cssPath) ? moduleOptions.cssPath : [moduleOptions.cssPath]
const [resolvedCss, loggerInfo] = await resolvers.resolveCSSPath(cssPath, nuxt)
logger.info(loggerInfo)
nuxt.options.css = nuxt.options.css ?? []
const resolvedNuxtCss = (resolvedCss && await Promise.all(nuxt.options.css.map((p: any) => resolvePath(p.src ?? p)))) || []
// inject only if this file isn't listed already by user
if (resolvedCss && !resolvedNuxtCss.includes(resolvedCss)) {
let injectPosition: number
try {
injectPosition = resolvers.resolveInjectPosition(nuxt.options.css, cssPathConfig?.injectPosition || moduleOptions.injectPosition)
}
catch (e: any) {
throw new Error('failed to resolve Tailwind CSS injection position: ' + e.message)
}
nuxt.options.css.splice(injectPosition, 0, resolvedCss)
}
nuxt.hook('modules:done', async () => {
const _config = await ctx.loadConfig()
const twConfig = ctx.generateConfig()
ctx.registerHooks()
// expose resolved tailwind config as an alias
if (moduleOptions.exposeConfig) {
const exposeConfig = resolvers.resolveExposeConfig({ level: moduleOptions.exposeLevel, ...(typeof moduleOptions.exposeConfig === 'object' ? moduleOptions.exposeConfig : {}) })
const exposeTemplates = createExposeTemplates(exposeConfig)
nuxt.hook('tailwindcss:internal:regenerateTemplates', () => updateTemplates({ filter: template => exposeTemplates.includes(template.dst) }))
}
// setup postcss plugins (for Nuxt 2/bridge/3)
const postcssOptions
/* nuxt 3 */
= nuxt.options.postcss
// @ts-expect-error older nuxt3
|| nuxt.options.build.postcss.postcssOptions
// @ts-expect-error nuxt 2 type
|| nuxt.options.build.postcss as any
postcssOptions.plugins = {
...(postcssOptions.plugins || {}),
'tailwindcss/nesting': postcssOptions.plugins?.['tailwindcss/nesting'] ?? {},
'tailwindcss': twConfig.dst satisfies string || _config,
}
// enabled only in development
if (nuxt.options.dev) {
// add tailwind-config-viewer endpoint
if (moduleOptions.viewer) {
const viewerConfig = resolvers.resolveViewerConfig(moduleOptions.viewer)
setupViewer(twConfig.dst || _config, viewerConfig, nuxt)
nuxt.hook('devtools:customTabs', (tabs: import('@nuxt/devtools').ModuleOptions['customTabs']) => {
tabs?.push({
title: 'TailwindCSS',
name: 'tailwindcss',
icon: 'logos-tailwindcss-icon',
category: 'modules',
view: {
type: 'iframe',
src: withTrailingSlash(viewerConfig.endpoint),
},
})
})
}
}
else {
// production only
if (moduleOptions.viewer) {
const viewerConfig = resolvers.resolveViewerConfig(moduleOptions.viewer)
exportViewer(twConfig.dst || addTemplate({ filename: 'tailwind.config/viewer-config.cjs', getContents: () => `module.exports = ${JSON.stringify(_config)}`, write: true }).dst, viewerConfig)
}
}
})
},
})
declare module 'nuxt/schema' {
interface NuxtHooks extends ModuleHooks {
'tailwindcss:internal:regenerateTemplates': (data?: { configTemplateUpdated?: boolean }) => void | Promise<void>
}
}
declare module '@nuxt/schema' {
interface NuxtHooks extends ModuleHooks {
'tailwindcss:internal:regenerateTemplates': (data?: { configTemplateUpdated?: boolean }) => void | Promise<void>
}
}