chore: add nuxt module starter

posva · posva · commit 9213fb155a96 · 2022-10-27T10:59:36.000+02:00
diff --git a/packages/nuxt/.editorconfig b/packages/nuxt/.editorconfig
@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/packages/nuxt/.eslintignore b/packages/nuxt/.eslintignore
@@ -0,0 +1,2 @@
+dist
+node_modules
diff --git a/packages/nuxt/.eslintrc b/packages/nuxt/.eslintrc
@@ -0,0 +1,10 @@
+{
+  "extends": [
+    "@nuxtjs/eslint-config-typescript"
+  ],
+  "rules": {
+    "@typescript-eslint/no-unused-vars": [
+      "off"
+    ]
+  }
+}
diff --git a/packages/nuxt/.gitignore b/packages/nuxt/.gitignore
@@ -0,0 +1,51 @@
+# Dependencies
+node_modules
+
+# Logs
+*.log*
+
+# Temp directories
+.temp
+.tmp
+.cache
+
+# Yarn
+**/.yarn/cache
+**/.yarn/*state*
+
+# Generated dirs
+dist
+
+# Nuxt
+.nuxt
+.output
+.vercel_build_output
+.build-*
+.env
+.netlify
+
+# Env
+.env
+
+# Testing
+reports
+coverage
+*.lcov
+.nyc_output
+
+# VSCode
+.vscode
+
+# Intellij idea
+*.iml
+.idea
+
+# OSX
+.DS_Store
+.AppleDouble
+.LSOverride
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
diff --git a/packages/nuxt/.nuxtrc b/packages/nuxt/.nuxtrc
@@ -0,0 +1 @@
+imports.autoImport=false
diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md
@@ -0,0 +1,6 @@
+# Nuxt Module
+
+## Development
+
+- Run `npm run dev:prepare` to generate type stubs.
+- Use `npm run dev` to start [playground](./playground) in development mode.
diff --git a/packages/nuxt/package.json b/packages/nuxt/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "nuxt-vuefire",
+  "description": "Nuxt.js module for VueFire",
+  "version": "0.0.0",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "Eduardo San Martin Morote",
+    "email": "posva13@gmail.com"
+  },
+  "funding": "https://github.com/sponsors/posva",
+  "scripts": {
+    "prepack": "nuxt-module-build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.0.0-rc.12"
+  },
+  "devDependencies": {
+    "@nuxt/module-builder": "^0.2.0",
+    "@nuxt/schema": "^3.0.0-rc.12",
+    "@nuxtjs/eslint-config-typescript": "^11.0.0",
+    "eslint": "^8.26.0",
+    "nuxt": "^3.0.0-rc.12"
+  }
+}
diff --git a/packages/nuxt/playground/app.vue b/packages/nuxt/playground/app.vue
@@ -0,0 +1,8 @@
+<template>
+  <div>
+    Nuxt module playground!
+  </div>
+</template>
+
+<script setup>
+</script>
diff --git a/packages/nuxt/playground/nuxt.config.ts b/packages/nuxt/playground/nuxt.config.ts
@@ -0,0 +1,9 @@
+import { defineNuxtConfig } from 'nuxt/config'
+import MyModule from '..'
+
+export default defineNuxtConfig({
+  modules: [MyModule],
+  myModule: {
+    addPlugin: true,
+  },
+})
diff --git a/packages/nuxt/playground/package.json b/packages/nuxt/playground/package.json
@@ -0,0 +1,4 @@
+{
+  "private": true,
+  "name": "my-module-playground"
+}
diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts
@@ -0,0 +1,24 @@
+import { resolve } from 'path'
+import { fileURLToPath } from 'url'
+import { defineNuxtModule, addPlugin } from '@nuxt/kit'
+
+export interface ModuleOptions {
+  addPlugin: boolean
+}
+
+export default defineNuxtModule<ModuleOptions>({
+  meta: {
+    name: 'my-module',
+    configKey: 'myModule',
+  },
+  defaults: {
+    addPlugin: true,
+  },
+  setup(options, nuxt) {
+    if (options.addPlugin) {
+      const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
+      nuxt.options.build.transpile.push(runtimeDir)
+      addPlugin(resolve(runtimeDir, 'plugin'))
+    }
+  },
+})
diff --git a/packages/nuxt/src/runtime/plugin.ts b/packages/nuxt/src/runtime/plugin.ts
@@ -0,0 +1,5 @@
+import { defineNuxtPlugin } from '#app'
+
+export default defineNuxtPlugin((nuxtApp) => {
+  console.log('Plugin by my-module!')
+})
diff --git a/packages/nuxt/tsconfig.json b/packages/nuxt/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./playground/.nuxt/tsconfig.json"
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "private": true,
 +  "name": "my-module-playground"
 +}