docs: list extensions and update needed keyword

Author: d-koppenhagen

Diff for: .husky/pre-commit

@@ -1,2 +1,2 @@
 npm run docs:update-requirements
-
+npm run docs:update-extension

Diff for: docs/.vitepress/config.ts

@@ -445,6 +445,10 @@ export const config: UserConfig = {
             text: "Publish an extension",
             link: "/pluginsguide/publish",
           },
+          {
+            text: "Extensions List",
+            link: "/pluginsguide/list",
+          },
         ],
       },
     ],

Diff for: docs/pluginsguide/list.md

@@ -0,0 +1,8 @@
+# Extensions List
+
+This list is generated from all NPM packages with the `vue3-openlayers-extension` keyword.
+
+<!-- auto-generated-peer-dependency-requirements START -->
+
+
+<!-- auto-generated-peer-dependency-requirements END -->

Diff for: docs/pluginsguide/publish.md

@@ -4,7 +4,7 @@ When creating and publishing an extension for vue3-openlayers, you should follow
 This assures, the lib can be found easily and that it follows a common plugin naming pattern.
 
 - The package name should be `vue3-openlayers-<plugin>-<feature>`, e. g. `vue3-openlayers-source-foo`
-- Please add the keywords `vue3-openlayers` and `openlayers` to your published package
+- Please add the keywords `vue3-openlayers-extension` and `openlayers` to your published package
 
 ```jsonc [package.json]
 {

Diff for: package-lock.json

@@ -59,6 +59,7 @@
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs",
     "docs:update-requirements": "node scripts/insert-required-versions.mjs README.md docs/get-started.md",
+    "docs:update-extension": "node scripts/get-extensions.mjs docs/pluginsguide/list.md",
     "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --ignore-path .gitignore",
     "lint-fix": "npm run lint -- --fix",
     "prettier": "prettier --write .",
@@ -118,6 +119,7 @@
     "get-pkg": "^2.0.0",
     "husky": "^9.0.11",
     "jsdom": "^24.0.0",
+    "npm-keyword": "^8.0.0",
     "prettier": "^3.2.5",
     "release-it": "^17.2.0",
     "typescript": "~5.4.5",

Diff for: package.json

@@ -0,0 +1,25 @@
+"use strict";
+
+import { readFileSync, writeFileSync } from "fs";
+import { npmKeyword } from "npm-keyword";
+
+// eslint-disable-next-line no-undef
+const file = process.argv[2];
+
+npmKeyword("vue3-openlayers-extension").then((results) => {
+  console.log(results);
+  const list = results.map((result) => {
+    return `- **[${result.name}](https://www.npmjs.com/package/${result.name})**: \`${result.description}\``;
+  });
+
+  const contents = readFileSync(file, "utf-8");
+  const replaced = contents.replace(
+    /<!--.* START -->.*.*<!--.* END -->/gs,
+    [
+      "<!-- auto-generated-peer-dependency-requirements START -->\n",
+      ...list,
+      "\n<!-- auto-generated-peer-dependency-requirements END -->",
+    ].join("\n"),
+  );
+  writeFileSync(file, replaced, "utf-8");
+});