chore: improve module

Author: benjamincanac

.eslintrc.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+  root: true,
+  extends: [
+    '@nuxt/eslint-config'
+  ],
+  rules: {
+    // Global
+    semi: ['error', 'never'],
+    quotes: ['error', 'single'],
+    'quote-props': ['error', 'as-needed'],
+    // Vue
+    'vue/multi-word-component-names': 0,
+    'vue/max-attributes-per-line': 'off',
+    'vue/no-v-html': 0
+  }
+}

.eslintrc.js

@@ -49,6 +49,9 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - name: Prepare
+        run: pnpm run dev:prepare
+
       - name: Lint
         run: pnpm run lint
 

.github/workflows/ci-dev.yml

@@ -49,6 +49,9 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - name: Prepare
+        run: pnpm run dev:prepare
+
       - name: Lint
         run: pnpm run lint
 

.github/workflows/ci.yml

@@ -1,2 +1,2 @@
 shamefully-hoist=true
-auto-install-peers=true
+strict-peer-dependencies=false

.npmrc

@@ -1 +1,2 @@
 typescript.includeWorkspace=true
+typescript.strict=false

.nuxtrc

@@ -2,6 +2,7 @@ export default defineNuxtConfig({
   css: ['@/assets/css/main.css'],
   extends: ['@nuxt-themes/docus'],
   modules: ['nuxt-plausible'],
+  // @ts-ignore
   plausible: {
     domain: 'strapi.nuxtjs.org'
   }

docs/nuxt.config.ts

@@ -6,6 +6,7 @@
   "license": "MIT",
   "exports": {
     ".": {
+      "types": "./dist/types.d.ts",
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
     }
@@ -16,12 +17,13 @@
     "dist"
   ],
   "scripts": {
-    "build": "nuxt-module-build",
-    "dev": "nuxi dev example",
-    "lint": "eslint --ext .js,.ts,.vue .",
-    "typecheck": "nuxi typecheck",
+    "build": "nuxt-module-build build",
     "prepack": "pnpm build",
-    "prepare": "nuxi prepare example",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare",
+    "lint": "eslint .",
+    "typecheck": "vue-tsc --noEmit",
     "release": "pnpm lint && standard-version && git push --follow-tags"
   },
   "dependencies": {
@@ -32,6 +34,7 @@
     "ufo": "^1.3.2"
   },
   "devDependencies": {
+    "@types/node": "^20.9.3",
     "@nuxt/devtools": "^1.0.3",
     "@nuxt/eslint-config": "^0.2.0",
     "@nuxt/module-builder": "^0.5.4",

package.json

@@ -1,8 +1,6 @@
-
 export default defineNuxtConfig({
   modules: [
-    '../src/module',
-    '@nuxt/devtools'
+    '../src/module'
   ],
   // example of separate client/server URLs
   // runtimeConfig: {
@@ -17,7 +15,5 @@ export default defineNuxtConfig({
     // To enable the devtools, read https://strapi.nuxtjs.org/devtools
     // devtools: true
   },
-  typescript: {
-    includeWorkspace: true
-  }
+  devtools: { enabled: true }
 })

example/app.vue playground/app.vue

@@ -0,0 +1,12 @@
+{
+  "private": true,
+  "scripts": {
+    "build": "nuxt build",
+    "dev": "nuxt dev",
+    "generate": "nuxt generate",
+    "preview": "nuxt preview"
+  },
+  "devDependencies": {
+    "nuxt": "latest"
+  }
+}

example/nuxt.config.ts playground/nuxt.config.ts

@@ -12,7 +12,9 @@ const router = useRouter()
 onMounted(async () => {
   try {
     await authenticateProvider(route.params.provider as StrapiAuthProvider, route.query.access_token as string)
-  } catch (e) {}
+  } catch (e) {
+    console.error(e)
+  }
 
   router.push('/')
 })

playground/package.json

@@ -44,7 +44,9 @@ const onSubmit = async () => {
 
   try {
     await login(form)
-  } catch (e) {}
+  } catch (e) {
+    console.error(e)
+  }
 
   loading.value = false
 }

example/pages/auth/[provider]/callback.vue playground/pages/auth/[provider]/callback.vue

@@ -1,5 +1,5 @@
 import type { Strapi3RequestParams } from '../types/v3'
-// eslint-disable-next-line import/named
+// @ts-ignore
 import { useStrapi3 } from '#imports'
 
 interface StrapiV3Client<T> {

example/pages/index.vue playground/pages/index.vue

@@ -1,5 +1,5 @@
 import type { Strapi4ResponseSingle, Strapi4RequestParams, Strapi4ResponseMany } from '../types/v4'
-// eslint-disable-next-line import/named
+// @ts-ignore
 import { useStrapi4 } from '#imports'
 
 interface StrapiV4Client<T> {
@@ -11,5 +11,6 @@ interface StrapiV4Client<T> {
 }
 
 export const useStrapi = <T>(): StrapiV4Client<T> => {
+  // @ts-ignore
   return useStrapi4()
 }

example/tsconfig.json playground/tsconfig.json

@@ -52,6 +52,7 @@ export const useStrapiClient = () => {
     }
 
     try {
+      // @ts-ignore
       return await $fetch<T>(url, {
         retry: 0,
         baseURL,
@@ -62,6 +63,7 @@ export const useStrapiClient = () => {
         }
       })
     } catch (err: any) {
+      // @ts-ignore
       const e: Strapi4Error | Strapi3Error = err.data || defaultErrors(err)[version]
 
       nuxt.hooks.callHook('strapi:error' as any, e)

pnpm-lock.yaml

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import { useCookie, useNuxtApp, useRuntimeConfig } from '#imports'
 
 export const useStrapiToken = () => {

src/runtime/composables-v3/useStrapi.ts

@@ -1,3 +1,8 @@
 {
-  "extends": "./example/.nuxt/tsconfig.json"
+  "extends": "./.nuxt/tsconfig.json",
+  "exclude": [
+    "dist",
+    "playground",
+    "docs"
+  ]
 }