docs: Provide example of reading package.json for plugins meta (#18530)

nzakas · fasttime · web-flow · commit 38c159e7dda8 · 2024-06-03T18:27:50.000+02:00
* docs: Provide example of reading package.json for plugins meta fixes #18462 * Update docs/src/extend/plugins.md Co-authored-by: Francesco Trotta <github@fasttime.org> --------- Co-authored-by: Francesco Trotta <github@fasttime.org>
diff --git a/docs/src/extend/plugins.md b/docs/src/extend/plugins.md
@@ -62,7 +62,27 @@ export default plugin;
 module.exports = plugin;
 ```
 
-The `meta.name` property should match the npm package name for your plugin and the `meta.version` property should match the npm package version for your plugin. The easiest way to accomplish this is by reading this information from your `package.json`.
+The `meta.name` property should match the npm package name for your plugin and the `meta.version` property should match the npm package version for your plugin. The easiest way to accomplish this is by reading this information from your `package.json`, as in this example:
+
+```js
+import fs from "fs";
+
+const pkg = JSON.parse(fs.readFileSync(new URL("./package.json", import.meta.url), "utf8"));
+
+const plugin = {
+
+    // preferred location of name and version
+    meta: {
+        name: pkg.name,
+        version: pkg.version
+    },
+    rules: {
+        // add rules here
+    }
+};
+
+export default plugin;
+```
 
 ::: tip
 While there are no restrictions on plugin names, it helps others to find your plugin on [npm](https://npmjs.com) when you follow these naming conventions:
