@wondermarin/eslint-config 1.0.3 → 2.0.0

package/README.md

@@ -1,21 +1,60 @@
 # @wondermarin/eslint-config
-<span>Personal <a href="https://eslint.org">ESLint</a> config.</span>
+Personal <a href="https://eslint.org">ESLint</a> config.
 
-## Install
+> [!IMPORTANT]
+> This package is strictly for personal use. If anyone wants to use it in their projects, please pay attention to the specific <a href="#versioning-policy">versioning policy</a>.
 
+## Installation
 ```sh
-yarn add -D @wondermarin/eslint-config
+pnpm add -D @wondermarin/eslint-config
 ```
 
 ## Usage
+`eslint.config.js`
+```js
+import wondermarin from "@wondermarin/eslint-config";
 
-`.eslintrc`:
-```jsonc
-{
-  "extends": [
-    "@wondermarin/eslint-config", // Base config.
-    "@wondermarin/eslint-config/typescript", // TypeScript config.
-    "@wondermarin/eslint-config/react" // React & React Hooks config.
-  ]
-}
+export default wondermarin({
+  /**
+   * ESLint config.
+   * @default true
+   */
+  javascript: true,
+
+  /**
+   * `@typescript-eslint/eslint-plugin` config.
+   * @default false
+   */
+  typescript: false,
+
+  /**
+   * `eslint-plugin-prettier`, `@stylistic/eslint-plugin`, and `eslint-plugin-perfectionist` config.
+   * @default true
+   */
+  stylistic: true,
+
+  /**
+   * `eslint-plugin-package-json` config.
+   * @default true
+   */
+  json: true,
+
+  /**
+   * `eslint-plugin-react` and `eslint-plugin-react-hooks` config.
+   * @default false
+   */
+  react: false,
+});
 ```
+
+## Versioning Policy
+The package follows <a href="https://semver.org">semantic versioning</a> with some specific nuances:
+* **Patch release**: A rule is disabled.
+* **Minor release**:
+  * A new configuration is added.
+  * A new rule is added (or a previously disabled rule is enabled).
+  * A rule is updated (updating its options or changing its severity).
+* **Major release**: Major release in ESLint.
+
+## License
+Code released under the <a href="https://github.com/Wondermarin/eslint-config/tree/main/LICENSE">MIT</a> license.

package/dist/main.d.ts

@@ -0,0 +1,36 @@
+import { Linter } from 'eslint';
+
+interface IConfig extends Omit<Linter.Config, "plugins"> {
+    readonly plugins?: Record<string, unknown>;
+}
+
+interface IWondermarinOptions {
+    /**
+     * [ESLint](https://github.com/eslint/eslint) config.
+     * @default true
+     */
+    readonly javascript?: boolean;
+    /**
+     * [`@typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint) config.
+     * @default false
+     */
+    readonly typescript?: boolean;
+    /**
+     * [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier), [`@stylistic/eslint-plugin`](https://github.com/eslint-stylistic/eslint-stylistic), and [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) config.
+     * @default true
+     */
+    readonly stylistic?: boolean;
+    /**
+     * [`eslint-plugin-package-json`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json) config.
+     * @default true
+     */
+    readonly json?: boolean;
+    /**
+     * [`eslint-plugin-react`](https://github.com/jsx-eslint/eslint-plugin-react) and [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks) config.
+     * @default false
+     */
+    readonly react?: boolean;
+}
+declare function wondermarin(options?: IWondermarinOptions): Promise<IConfig[]>;
+
+export { wondermarin as default };