Generate global types to .nuxt folder (#41)

Author: d0rich

modules/docs-toolkit-config.ts

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2023 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { defineNuxtModule, createResolver, addTemplate } from '@nuxt/kit'
+
+export default defineNuxtModule({
+  setup(_, nuxt) {
+    const { resolve } = createResolver(import.meta.url)
+    const prefix = 'ExactproDocs'
+    const typenamesWithoutPrefix = [
+      'RobotsTxtOptions',
+      'SocialLinkConfigOptions',
+      'ContactConfigOptions'
+    ]
+
+    const typesPath = addTemplate({
+      filename: 'types/docs-web-toolkit.d.ts',
+      getContents: () =>
+        [
+          `import type { ${typenamesWithoutPrefix
+            .map((type) => `${prefix}${type} as ${type}`)
+            .join(', ')} } from '${resolve('../nuxt.schema.ts')}'`,
+          'declare global {',
+          ...typenamesWithoutPrefix.map(
+            (type) => `  interface ${prefix}${type} extends ${type} {}`
+          ),
+          '}'
+        ].join('\n')
+    }).dst
+
+    nuxt.hook('prepare:types', (options) => {
+      options.references.push({
+        path: typesPath
+      })
+    })
+  }
+})

nuxt.schema.ts

@@ -14,33 +14,31 @@
  * limitations under the License.
  */
 
-import type { RobotsTxtOptions } from './server/routes/robots.txt'
+// If new global type for config is required, add it to ./modules/docs-toolkit-config.ts
+export type { RobotsTxtOptions as ExactproDocsRobotsTxtOptions } from './server/routes/robots.txt'
 
-declare global {
-  interface ExactproDocsRobotsTxtOptions extends RobotsTxtOptions {}
-  interface ExactproDocsSocialLinkConfigOptions {
-    /**
-     * Link to the social network
-     */
-    url?: string
-    /**
-     * Name of the icon to override the default icon
-     *
-     * @see {@link https://icones.js.org/ | Icônes}
-     */
-    customIcon?: string
-    /**
-     * Hide the link
-     *
-     * @default false
-     */
-    disabled?: boolean
-  }
+export interface ExactproDocsSocialLinkConfigOptions {
+  /**
+   * Link to the social network
+   */
+  url?: string
+  /**
+   * Name of the icon to override the default icon
+   *
+   * @see {@link https://icones.js.org/ | Icônes}
+   */
+  customIcon?: string
+  /**
+   * Hide the link
+   *
+   * @default false
+   */
+  disabled?: boolean
+}
 
-  interface ExactproDocsContactConfigOptions {
-    type: 'email' | 'phone'
-    contact: string
-  }
+export interface ExactproDocsContactConfigOptions {
+  type: 'email' | 'phone'
+  contact: string
 }
 
 export default defineNuxtSchema({