nuxt-strapi-blocks-renderer 1.0.3 → 1.0.4

package/README.md

@@ -271,26 +271,85 @@ You can also use different image components here, i.e. `NuxtImg` or others.
 
 ## Development
 
+### Dependencies
+
+To install the dependencies, run the `install` command:
+
 ```bash
-# Install dependencies
 npm install
+```
+
+The project requires Node.js and NPM to run.
+You can either install these manually on your system or if you have the nix package manager installed, use the
+provided nix-shell with the following command:
+
+```bash
+nix-shell
+```
+
+This will automatically install the needed software and start up a shell.
+
+### Type stubs
 
-# Generate type stubs
+To generate the type stubs for the nuxt module, run the `dev:prepare` command:
+
+```bash
 npm run dev:prepare
+```
+
+### Development server
+
+To start the development server with the provided text components, run the `dev` command:
 
-# Develop with the basic text components playground
+```bash
 npm run dev
+```
 
-# Develop with the custom text components playground
+This will boot up the playground with the default text components.
+To start the development server using custom text components, overriding the provided components,
+use the `dev:custom` command:
+
+```bash
 npm run dev:custom
+```
+
+### Quality
+
+#### Linter
+
+To run ESLint, use the following command:
+
+```bash
+npm run lint:es
+```
+
+#### Type checks
+
+To run the TypeScript type checks, use the following command:
 
-# Run ESLint
-npm run lint
+```bash
+npm run lint:types
+```
+
+#### Unit Tests
 
-# Run Vitest
-npm run test
+To run the Vitest unit tests, run the following command:
+
+```bash
+npm run lint:types
+````
 
-# Release new version
+### Release
+
+To release a new version of the strapi blocks renderer nuxt module, take the following steps:
+
+1. Increment version number in the `package.json` file
+2. Add changelog entry for the new version number
+3. Run linters and unit tests
+4. Log in to NPM using your access token
+5. Run the `release` command
+
+```bash
 npm run release
 ```
 

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "nuxt-strapi-blocks-renderer",
   "configKey": "strapiBlocksRenderer",
-  "version": "1.0.3"
+  "version": "1.0.4"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "nuxt-strapi-blocks-renderer",
-    "version": "1.0.3",
-    "description": "Renderer for the strapi blocks text element.",
+    "version": "1.0.4",
+    "description": "Renderer for the strapi CMS blocks text content element.",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -29,26 +29,30 @@
         "release": "npm run lint && npm run test && npm run prepack && npm publish",
         "release:ci": "npm run prepack && npm publish",
         "lint:es": "eslint './**/*.{js,ts,vue}' --max-warnings=0",
-        "lint:types": "tsc",
+        "lint:types": "tsc --noEmit",
         "test": "vitest run",
         "test:watch": "vitest watch"
     },
     "dependencies": {
-        "@nuxt/kit": "^3.10.2",
+        "@nuxt/kit": "^3.11.2",
         "defu": "^6.1.4"
     },
     "devDependencies": {
-        "@types/node": "^20.11.19",
-        "@nuxt/devtools": "^1.0.8",
-        "@nuxt/eslint-config": "^0.2.0",
+        "@types/node": "^20.12.5",
+        "@nuxt/devtools": "^1.1.5",
+        "@nuxt/eslint-config": "^0.3.1",
         "@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",
+        "@nuxt/schema": "^3.11.2",
+        "@nuxt/test-utils": "^3.12.0",
+        "@stylistic/eslint-plugin": "^1.7.0",
+        "eslint": "^8.57.0",
+        "nuxt": "^3.11.2",
+        "vitest": "^1.4.0",
+        "vue": "^3.4.21",
         "vue-eslint-parser": "^9.4.2"
+    },
+    "packageManager": "npm@10.2.4",
+    "engines": {
+        "node": "^18.x || ^20.x"
     }
 }