docs: defaultOptions + TODO add configs

Author: francoismassart

src/index.ts

@@ -16,6 +16,10 @@ const { name, version } =
   require("../package.json") as typeof import("../package.json");
 
 const plugin: Plugin = {
+  /**
+   * TODO: Add configs (recommended, etc.)
+   * @see https://github.com/typescript-eslint/examples/blob/main/packages/eslint-plugin-example-typed-linting/src/index.ts
+   */
   meta: {
     name,
     version,

src/rules/my-rule.ts

@@ -53,6 +53,13 @@ export const myRule = createRule<Options, MessageIds>({
     ],
     type: "suggestion",
   },
+  /**
+   * About `defaultOptions`:
+   * - `defaultOptions` is not used in the generated documentation
+   * - `defaultOptions` is used when options are not provided in the rules configuration
+   * - If some configuration is provided as the second argument, it is ignored, not merged
+   * - In other words, the `defaultOptions` is only used when the rule is used without configuration
+   */
   defaultOptions: [{ someBool: false, someEnum: "always" }],
   create: (context, options) => {
     return {