feat: add nuxt helpers (#160)

docs/.vuepress/config.js

@@ -27,6 +27,7 @@ module.exports = {
             '/helpers/useFetch',
             '/helpers/useMeta',
             '/helpers/useStatic',
+            '/helpers/defineNuxtHelpers',
           ],
         },
         {

docs/helpers/defineNuxtHelpers.md

@@ -0,0 +1,56 @@
+---
+---
+
+# defineNuxt... helpers
+
+We added some helpers to optimize developer experience.
+
+## defineNuxtPlugin
+
+Create a Nuxt plugin with types with
+
+```ts
+import { defineNuxtPlugin } from 'nuxt-composition-api'
+
+export default defineNuxtPlugin((ctx) => {
+  // do stuff
+})
+```
+
+## defineNuxtMiddleware
+
+Create a Nuxt plugin with types with
+
+```ts
+import { defineNuxtMiddleware } from 'nuxt-composition-api'
+
+export default defineNuxtMiddleware((ctx) => {
+  // do stuff
+})
+```
+
+## defineNuxtModule
+
+Create a Nuxt plugin with types with
+
+```ts
+import { defineNuxtModule } from 'nuxt-composition-api'
+
+export default defineNuxtModule<{myOption: boolean}>((moduleOptions) => {
+  // do stuff
+})
+```
+
+
+## defineNuxtServerMiddleware
+
+Create a Nuxt plugin with types with
+
+```ts
+import { defineNuxtServerMiddleware } from 'nuxt-composition-api'
+
+export default defineNuxtServerMiddleware((req, res, next) => {
+  // do stuff
+})
+```
+

src/defineHelpers.ts

@@ -0,0 +1,10 @@
+import { Middleware, Plugin, Module, ServerMiddleware } from '@nuxt/types'
+
+export const defineNuxtPlugin = (plugin: Plugin) => plugin
+export const defineNuxtMiddleware = (middleware: Middleware) => middleware
+export const defineNuxtModule = <T extends Record<string, unknown>>(
+  module: Module<T>
+) => module
+export const defineNuxtServerMiddleware = (
+  serverMiddleware: ServerMiddleware
+) => serverMiddleware

src/entrypoint.ts

@@ -11,6 +11,7 @@ export { globalPlugin, onGlobalSetup } from './hooks'
 export { useMeta } from './meta'
 export { ssrRef, shallowSsrRef, setSSRContext, ssrPromise } from './ssr-ref'
 export { useStatic } from './static'
+export * from './defineHelpers'
 
 export type {
   ComponentRenderProxy,

test/tsd/createHelpers.test-d.ts

@@ -0,0 +1,37 @@
+import {
+  defineNuxtPlugin,
+  defineNuxtMiddleware,
+  defineNuxtModule,
+  defineNuxtServerMiddleware,
+} from '../..'
+import { expectType } from 'tsd'
+
+defineNuxtPlugin((context, inject) => {
+  const hello = (msg: string) => console.log(`Hello ${msg}!`)
+
+  expectType<boolean>(context.isClient)
+
+  inject('hello', hello)
+})
+
+defineNuxtModule<{
+  option: string
+}>(function (options) {
+  // expectType<string>(this.options.rootDir)
+
+  this.addPlugin('filename')
+
+  expectType<string>(options.option)
+})
+
+defineNuxtMiddleware(({ store, redirect }) => {
+  if (!store.state.authenticated) {
+    return redirect('/login')
+  }
+})
+
+defineNuxtServerMiddleware((req, res, next) => {
+  expectType<string | undefined>(req.url)
+
+  next()
+})