chore: add config warnings

Author: ineshbose

Diff for: nuxt2-playground/pnpm-lock.yaml

@@ -45,18 +45,26 @@ const defaults = (nuxt = useNuxt()): ModuleOptions => ({
   config: defaultTailwindConfig,
   viewer: true,
   exposeConfig: false,
-  exposeLevel: 2,
-  injectPosition: 'first',
   disableHmrHotfix: false,
   quiet: nuxt.options.logLevel === 'silent',
-  addTwUtil: false,
   editorSupport: false,
 })
 
 export default defineNuxtModule<ModuleOptions>({
   meta: { name, version, configKey, compatibility }, defaults,
   async setup (moduleOptions, nuxt) {
     if (moduleOptions.quiet) logger.level = LogLevels.silent
+    const deprecatedOptions: Array<[keyof ModuleOptions, string]> = [
+      ['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.`]
+    ]
+    deprecatedOptions.forEach(([dOption, alternative]) => moduleOptions[dOption] !== undefined && logger.warn(`Deprecated \`${dOption}\`. ${alternative}`))
+
     const { resolve } = createResolver(import.meta.url)
     const [configPaths, contentPaths] = await resolveModulePaths(moduleOptions.configPath, nuxt)
 

Diff for: src/module.ts

@@ -117,14 +117,14 @@ export interface ModuleOptions {
    * @default 2
    * @deprecated use exposeConfig as object
    */
-  exposeLevel: number;
+  exposeLevel?: number;
   /**
    * The position of CSS injection affecting CSS priority
    *
    * @default 'first'
    * @deprecated use cssPath as [string | false, { injectPosition: InjectPosition }]
    */
-  injectPosition: InjectPosition;
+  injectPosition?: InjectPosition;
   /**
    * @default false
    */
@@ -141,7 +141,7 @@ export interface ModuleOptions {
    * @default false
    * @deprecated use `editorSupport.autocompleteUtil` as object
    */
-  addTwUtil: boolean;
+  addTwUtil?: boolean;
   /**
    * Enable some utilities for better editor support and DX.
    *