docs: Add description of meta.namespace to plugin docs (#19798)

nzakas · web-flow · commit 2ba8a0d75c7a · 2025-05-30T15:42:47.000+02:00
fixes #19655
diff --git a/docs/src/extend/plugins.md b/docs/src/extend/plugins.md
@@ -39,14 +39,15 @@ If you plan to distribute your plugin as an npm package, make sure that the modu
 
 ### Meta Data in Plugins
 
-For easier debugging and more effective caching of plugins, it's recommended to provide a `name` and `version` in a `meta` object at the root of your plugin, like this:
+For easier debugging and more effective caching of plugins, it's recommended to provide a `name`, `version`, and `namespace` in a `meta` object at the root of your plugin, like this:
 
 ```js
 const plugin = {
 	// preferred location of name and version
 	meta: {
 		name: "eslint-plugin-example",
 		version: "1.2.3",
+		namespace: "example",
 	},
 	rules: {
 		// add rules here
@@ -60,7 +61,9 @@ 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`, as in this example:
+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 `meta.namespace` property should match the prefix you'd like users to use for accessing the plugin's rules, processors, languages, and configs. The namespace is typically what comes after `eslint-plugin-` in your package name, which is why this example uses `"example"`. Providing a namespace allows the `defineConfig()` function to find your plugin even when a user assigns a different namespace in their config file.
+
+The easiest way to add the name and version is by reading this information from your `package.json`, as in this example:
 
 ```js
 import fs from "fs";
@@ -74,6 +77,7 @@ const plugin = {
 	meta: {
 		name: pkg.name,
 		version: pkg.version,
+		namespace: "example",
 	},
 	rules: {
 		// add rules here
