chore: added type checks in ci + updated documentation

.github/workflows/ci.yml

@@ -22,7 +22,8 @@ jobs:
 
             - run: npm install
             - run: npm run dev:prepare
-            - run: npm run lint
+            - run: npm run lint:es
+            - run: npm run lint:types
             - run: npm run test
 
     release:

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.0.3
+- Added type checks in ci + updated documentation
+
 # 1.0.2
 - Updated package.json
 

README.md

@@ -34,7 +34,7 @@ text editor element:
 
 ```vue
 <script setup lang="ts">
-    import type { BlockNode } from 'nuxt-strapi-blocks-renderer/dist/runtime/types';
+    import type { BlockNode } from '#strapi-blocks-renderer/types';
     import type { Restaurant } from '~/types';
 
     const route = useRoute();

package.json

@@ -1,6 +1,6 @@
 {
     "name": "nuxt-strapi-blocks-renderer",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "description": "Renderer for the strapi blocks text element.",
     "license": "MIT",
     "repository": {
@@ -28,26 +28,27 @@
         "dev:custom": "nuxi dev playground/custom",
         "release": "npm run lint && npm run test && npm run prepack && npm publish",
         "release:ci": "npm run prepack && npm publish",
-        "lint": "eslint './**/*.{js,ts,vue}' --max-warnings=0",
+        "lint:es": "eslint './**/*.{js,ts,vue}' --max-warnings=0",
+        "lint:types": "tsc",
         "test": "vitest run",
         "test:watch": "vitest watch"
     },
     "dependencies": {
-        "@nuxt/kit": "^3.8.2",
-        "defu": "^6.1.3"
+        "@nuxt/kit": "^3.10.2",
+        "defu": "^6.1.4"
     },
     "devDependencies": {
-        "@types/node": "^20.10.3",
-        "@nuxt/devtools": "^1.0.6",
+        "@types/node": "^20.11.19",
+        "@nuxt/devtools": "^1.0.8",
         "@nuxt/eslint-config": "^0.2.0",
-        "@nuxt/module-builder": "^0.5.4",
-        "@nuxt/schema": "^3.8.2",
-        "@nuxt/test-utils": "^3.8.1",
-        "@stylistic/eslint-plugin": "^1.5.1",
-        "eslint": "^8.55.0",
-        "nuxt": "^3.8.2",
-        "vitest": "^1.1.0",
-        "vue": "^3.3.13",
-        "vue-eslint-parser": "^9.3.2"
+        "@nuxt/module-builder": "^0.5.5",
+        "@nuxt/schema": "^3.10.2",
+        "@nuxt/test-utils": "^3.11.0",
+        "@stylistic/eslint-plugin": "^1.6.2",
+        "eslint": "^8.56.0",
+        "nuxt": "^3.10.2",
+        "vitest": "^1.3.0",
+        "vue": "^3.4.19",
+        "vue-eslint-parser": "^9.4.2"
     }
 }

src/module.ts

@@ -27,7 +27,9 @@ export default defineNuxtModule<ModuleOptions>({
         nuxt.options.alias['#strapi-blocks-renderer'] = resolve(runtimeDirectory);
 
         const runtimeConfig: RuntimeConfig = nuxt.options.runtimeConfig;
-        runtimeConfig.public.strapiBlocksRenderer = defu(runtimeConfig.public.strapiBlocksRenderer, options);
+
+        runtimeConfig.public.strapiBlocksRenderer =
+            defu(runtimeConfig.public.strapiBlocksRenderer as ModuleOptions, options);
 
         addImports([{
             name: 'useBlocksText',

src/runtime/utils/index.ts

@@ -1,12 +1,13 @@
 import { resolveComponent, useRuntimeConfig, h } from '#imports';
 
-import type { ConcreteComponent } from 'vue';
+import type { ConcreteComponent, VNode } from 'vue';
 
 import type {
     BlockNode,
     CodeBlockNode,
     DefaultInlineNode,
-    HeadingBlockNode, ImageBlockNode,
+    HeadingBlockNode,
+    ImageBlockNode,
     LinkInlineNode,
     ListBlockNode,
     ListItemInlineNode,
@@ -15,10 +16,12 @@ import type {
     TextInlineNode
 } from '#strapi-blocks-renderer/types';
 
+import type { ModuleOptions } from '~/src/module';
+
 const prefix = (): string => {
     const { public: { strapiBlocksRenderer } } = useRuntimeConfig();
 
-    return strapiBlocksRenderer.blocksPrefix;
+    return (strapiBlocksRenderer as ModuleOptions).blocksPrefix;
 };
 
 export const textInlineNode = (node: TextInlineNode): VNode | string => {