feat: add js-docs

Author: ASafaeirad

README.md

@@ -57,10 +57,7 @@ You can fine-tune module detection by overriding it, the `defineConfig` function
 ```typescript
 interface Options {
   react?: boolean; // controls react, react-hooks, jsx/a11y plugins
-  typescript?: { // controls typescript plugin
-    projectService?: boolean | ProjectService; tsconfigRootDir: string; cacheLifetime?: number; // https://typescript-eslint.io/packages/parser#projectservice
-    tsconfigRootDir?: string // https://typescript-eslint.io/packages/parser#tsconfigrootdir
-  };
+  typescript?: ParserOptions // https://typescript-eslint.io/packages/parser#configuration
   node?: boolean; // controls node plugin
   sort?: boolean; // controls perfectionist plugin
   strict?: boolean; // controls strict rules

src/modules/tests.mjs

@@ -25,6 +25,7 @@ function tests(options = {}) {
 
       'max-lines-per-function': 'off',
       'no-sparse-arrays': 'off',
+      'no-empty-function': 'off',
 
       ...predicate(options.react, {
         'react/jsx-no-constructed-context-values': 'off',
@@ -36,6 +37,7 @@ function tests(options = {}) {
         '@typescript-eslint/unbound-method': 'off',
         '@typescript-eslint/no-empty-function': 'off',
         '@typescript-eslint/no-floating-promises': 'off',
+        '@typescript-eslint/prefer-promise-reject-errors': 'off',
       }),
     },
   };

src/modules/typescript.mjs

@@ -218,6 +218,7 @@ function typescript(options = {}) {
       'react/jsx-no-useless-fragment': 'off', // Need useless-fragment for JSX return type
 
       // Conflicts with @typescript-eslint
+      'no-empty-function': 'off',
       'default-case': 'off',
       'import/named': 'off',
       'import/namespace': 'off',

src/option.d.ts

@@ -8,23 +8,93 @@ interface ProjectService {
 }
 
 export interface Options extends Linter.Config {
+  /**
+   * @default true if you have `react` or `react-dom` in your dependencies
+   * Controls react plugin.
+   */
   react?: boolean;
+  /**
+   * @default true
+   */
   sort?: boolean;
+  /**
+   * @default true if you have `next` in your dependencies
+   * Controls next plugin.
+   */
   next?: boolean;
+  /**
+   * @default true if you have `tailwind` in your dependencies
+   * Controls tailwind plugin.
+   */
   tailwind?: boolean | { callees: string[] };
+  /**
+   * @default false
+   * Controls [node plugin](https://www.npmjs.com/package/eslint-plugin-n).
+   */
   node?: boolean;
+  /**
+   * @default false
+   * Enables all strict rules.
+   */
   strict?: boolean;
+  /**
+   * @default true
+   * Controls [import plugin](https://www.npmjs.com/package/eslint-plugin-import-x).
+   */
   import?: boolean | { internalRegExp?: string; lifetime?: number; projects?: string | string[] };
+  /**
+   * @default true if you have `type: module` in your `package.json`.
+   */
   esm?: boolean;
+  /**
+   * @default true if you have one of `jest`, `vitest`, `cypress`, `playwright`, `storybook`, `prettier` in your dependencies.
+   * Controls [test plugin](https://www.npmjs.com/package/eslint-plugin-jest-formatting).
+   */
   test?: boolean;
+  /**
+   * @default true if you have `jest` in your dependencies.
+   * Controls [jest plugin](https://www.npmjs.com/package/eslint-plugin-jest).
+   */
   jest?: boolean;
+  /**
+   * @default true if you have `vitest` in your dependencies.
+   * Controls [vitest plugin](https://www.npmjs.com/package/eslint-plugin-vitest).
+   */
   vitest?: boolean;
+  /**
+   * @default true if you have `cypress` in your dependencies.
+   * Controls [cypress plugin](https://www.npmjs.com/package/eslint-plugin-cypress).
+   */
   cypress?: boolean;
+  /**
+   * @default true if you have `storybook` in your dependencies.
+   * Controls [storybook plugin](https://www.npmjs.com/package/eslint-plugin-storybook).
+   */
   storybook?: boolean;
+  /**
+   * @default true if you have `prettier` in your dependencies.
+   * Controls [prettier plugin](https://www.npmjs.com/package/eslint-plugin-prettier).
+   */
   prettier?: boolean;
+  /**
+   * @default true if you have `playwright` in your dependencies.
+   * Controls [playwright plugin](https://www.npmjs.com/package/eslint-plugin-playwright).
+   */
   playwright?: boolean;
+  /**
+   * @default true if you have `typescript` in your dependencies.
+   * Controls [typescript plugin](https://www.npmjs.com/package/typescript-eslint).
+   */
   typescript?: { projectService?: boolean | ProjectService; tsconfigRootDir: string; cacheLifetime?: number };
+  /**
+   * @default false
+   * Disables expensive rules.
+   */
   disableExpensiveRules?: boolean;
+  /**
+   * @default []
+   * List of globs to ignore.
+   */
   ignores?: string[];
 }