@haltcase/style 7.0.0-canary.6 → 7.0.0-canary.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,7 +4,7 @@ import { config } from "typescript-eslint";
4
4
  import { getEslintBaseConfig } from "./internal/base.js";
5
5
 
6
6
  /**
7
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [options]
7
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
8
8
  */
9
9
  export const getEslintBrowserConfig = (options = {}) =>
10
10
  config(
@@ -13,7 +13,7 @@ export const getEslintBrowserConfig = (options = {}) =>
13
13
  );
14
14
 
15
15
  /**
16
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [_options]
16
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
17
17
  */
18
18
  export const getEslintBrowserConfigInternal = (_options = {}) =>
19
19
  config({
@@ -4,7 +4,7 @@ import { getEslintBaseConfig } from "./internal/base.js";
4
4
  import { getEslintCommonJsConfigInternal } from "./internal/commonjs.js";
5
5
 
6
6
  /**
7
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [options]
7
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
8
8
  */
9
9
  export const getEslintCommonJsConfig = (options) =>
10
10
  config(
@@ -1,5 +1,3 @@
1
- // @ts-check
2
-
3
1
  /**
4
2
  * @import { ParserOptions } from "@typescript-eslint/types"
5
3
  */
@@ -7,10 +5,8 @@
7
5
  import babelParser from "@babel/eslint-parser";
8
6
  import eslint from "@eslint/js";
9
7
  import eslintPluginEslintComments from "@eslint-community/eslint-plugin-eslint-comments";
10
- // eslint-disable-next-line import-x/default
11
8
  import eslintConfigPrettier from "eslint-config-prettier";
12
9
  import eslintPluginImportX from "eslint-plugin-import-x";
13
- // eslint-disable-next-line import-x/default
14
10
  import eslintRegexp from "eslint-plugin-regexp";
15
11
  import { config } from "typescript-eslint";
16
12
 
@@ -45,10 +41,14 @@ import { eslintUnicornConfig } from "./unicorn.js";
45
41
  * property {ProjectServiceOptions} [typescriptProjectServiceOptions = true] Custom TypeScript project service options for the `typescript-eslint` parser.
46
42
  */
47
43
 
44
+ /**
45
+ * @typedef {(options?: HaltcaseStyleOptions) => Awaited<import("typescript-eslint").Config>} HaltcaseStyleCreator
46
+ */
47
+
48
48
  /**
49
49
  * Get the common ESLint config for Node and browsers.
50
50
  *
51
- * @param {HaltcaseStyleOptions} options
51
+ * @type {HaltcaseStyleCreator}
52
52
  */
53
53
  export const getEslintBaseConfig = (options = {}) =>
54
54
  config(
@@ -3,7 +3,7 @@ import { config } from "typescript-eslint";
3
3
  import { commonJsFiles, commonJsOnlyFiles } from "../../constants.js";
4
4
 
5
5
  /**
6
- * @param {import("./base.js").HaltcaseStyleOptions} [options]
6
+ * @type {import("./base.js").HaltcaseStyleCreator}
7
7
  */
8
8
  export const getEslintCommonJsConfigInternal = (options = {}) =>
9
9
  config({
@@ -1,5 +1,8 @@
1
1
  import { config } from "typescript-eslint";
2
2
 
3
+ /**
4
+ * @type {ReturnType<import("./base.js").HaltcaseStyleCreator>}
5
+ */
3
6
  export const eslintEs2015Config = config({
4
7
  name: "@haltcase/internal/ES2015",
5
8
 
@@ -1,6 +1,9 @@
1
1
  import eslintPluginSimpleImportSort from "eslint-plugin-simple-import-sort";
2
2
  import { config } from "typescript-eslint";
3
3
 
4
+ /**
5
+ * @type {ReturnType<import("./base.js").HaltcaseStyleCreator>}
6
+ */
4
7
  export const eslintSimpleImportSortConfig = config({
5
8
  name: "@haltcase/internal/Import & export sorting",
6
9
 
@@ -1,6 +1,9 @@
1
1
  import eslintPluginTsdoc from "eslint-plugin-tsdoc";
2
2
  import { config } from "typescript-eslint";
3
3
 
4
+ /**
5
+ * @type {ReturnType<import("./base.js").HaltcaseStyleCreator>}
6
+ */
4
7
  export const eslintTsdocConfig = config({
5
8
  name: "@haltcase/internal/TSDoc comments",
6
9
  plugins: {
@@ -1,6 +1,9 @@
1
1
  import eslintPluginUnicorn from "eslint-plugin-unicorn";
2
2
  import { config } from "typescript-eslint";
3
3
 
4
+ /**
5
+ * @type {ReturnType<import("./base.js").HaltcaseStyleCreator>}
6
+ */
4
7
  export const eslintUnicornConfig = config({
5
8
  name: "@haltcase/internal/Unicorn",
6
9
 
@@ -11,7 +11,7 @@ import { getEslintNodeConfigInternal } from "./node.js";
11
11
  import { getEslintReactConfigInternal } from "./react.js";
12
12
 
13
13
  /**
14
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [options]
14
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
15
15
  */
16
16
  export const getEslintNextConfig = (options = {}) =>
17
17
  config(
@@ -21,7 +21,7 @@ export const getEslintNextConfig = (options = {}) =>
21
21
  );
22
22
 
23
23
  /**
24
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [options]
24
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
25
25
  */
26
26
  export const getEslintNextConfigInternal = (options = {}) =>
27
27
  config(
@@ -33,7 +33,6 @@ export const getEslintNextConfigInternal = (options = {}) =>
33
33
  plugins: {
34
34
  "@next/next": pluginNextjs
35
35
  },
36
- // @ts-expect-error inference issue
37
36
  rules: {
38
37
  ...pluginNextjs.configs.recommended.rules,
39
38
  ...pluginNextjs.configs["core-web-vitals"].rules
@@ -4,7 +4,7 @@ import { config } from "typescript-eslint";
4
4
  import { getEslintBaseConfig } from "./internal/base.js";
5
5
 
6
6
  /**
7
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [options]
7
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
8
8
  */
9
9
  export const getEslintNodeConfig = (options = {}) =>
10
10
  config(
@@ -13,7 +13,7 @@ export const getEslintNodeConfig = (options = {}) =>
13
13
  );
14
14
 
15
15
  /**
16
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [_options]
16
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
17
17
  */
18
18
  export const getEslintNodeConfigInternal = (_options = {}) =>
19
19
  config({
@@ -7,7 +7,7 @@ const playwrightRecommendedConfig =
7
7
  eslintPluginPlaywright.configs["flat/recommended"];
8
8
 
9
9
  /**
10
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [_options]
10
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
11
11
  */
12
12
  export const getEslintPlaywrightTestConfig = (_options = {}) =>
13
13
  config({
@@ -13,7 +13,7 @@ import { stylisticJsxRules } from "../rules/stylistic-jsx.js";
13
13
  import { getEslintBaseConfig } from "./internal/base.js";
14
14
 
15
15
  /**
16
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [options]
16
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
17
17
  */
18
18
  export const getEslintReactConfig = (options) =>
19
19
  config(
@@ -22,7 +22,7 @@ export const getEslintReactConfig = (options) =>
22
22
  );
23
23
 
24
24
  /**
25
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [_options]
25
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
26
26
  */
27
27
  export const getEslintReactConfigInternal = (_options = {}) =>
28
28
  config({
@@ -37,6 +37,7 @@ export const getEslintReactConfigInternal = (_options = {}) =>
37
37
  {
38
38
  name: "@haltcase/react/jsx-eslint/react",
39
39
  plugins: {
40
+ // @ts-expect-error see https://github.com/jsx-eslint/eslint-plugin-react/pull/3840
40
41
  react: eslintPluginReactOriginal
41
42
  },
42
43
  rules: {
@@ -1,4 +1,3 @@
1
- // eslint-disable-next-line import-x/default
2
1
  import eslintConfigPrettier from "eslint-config-prettier";
3
2
  import eslintPluginImportX from "eslint-plugin-import-x";
4
3
  import { config, configs, parser, plugin } from "typescript-eslint";
@@ -11,7 +10,7 @@ import { getTypescriptNamingConventionRule } from "../rules/typescript/naming-co
11
10
  import { eslintTsdocConfig } from "./internal/tsdoc.js";
12
11
 
13
12
  /**
14
- * @param {import("./internal/base.js").HaltcaseStyleOptions} [options]
13
+ * @type {import("./internal/base.js").HaltcaseStyleCreator}
15
14
  */
16
15
  export const getEslintTypescriptConfig = (options = {}) => {
17
16
  /** @type {import("typescript-eslint").ConfigWithExtends["languageOptions"]} */
package/eslint/index.js CHANGED
@@ -7,9 +7,9 @@ import { getEslintNodeConfigInternal } from "./configs/node.js";
7
7
  import { getEslintReactConfigInternal } from "./configs/react.js";
8
8
 
9
9
  /**
10
- * @param {import("./configs/internal/base.js").HaltcaseStyleOptions} [options]
10
+ * @type {import("./configs/internal/base.js").HaltcaseStyleCreator}
11
11
  */
12
- export const getEslintConfig = (options) =>
12
+ export const getEslintConfig = (options = {}) =>
13
13
  config(
14
14
  ...getEslintBaseConfig(options),
15
15
  ...(options.browser ? getEslintBrowserConfigInternal(options) : []),
@@ -14,54 +14,54 @@ export const reactXRules = {
14
14
  *
15
15
  * 🚫 Not fixable - https://eslint-react.xyz/docs/rules/no-useless-fragment
16
16
  */
17
- "no-useless-fragment": "error",
17
+ "@eslint-react/no-useless-fragment": "error",
18
18
 
19
19
  /**
20
20
  * Enforces using shorthand syntax for boolean attributes.
21
21
  *
22
22
  * 🔧 Fixable - https://eslint-react.xyz/docs/rules/prefer-shorthand-boolean
23
23
  */
24
- "prefer-shorthand-boolean": "error",
24
+ "@eslint-react/prefer-shorthand-boolean": "error",
25
25
 
26
26
  /**
27
27
  * Enforces using shorthand syntax for fragments.
28
28
  *
29
29
  * 🚫 Not fixable - https://eslint-react.xyz/docs/rules/prefer-shorthand-fragment
30
30
  */
31
- "prefer-shorthand-fragment": "error",
31
+ "@eslint-react/prefer-shorthand-fragment": "error",
32
32
 
33
33
  /**
34
34
  * Warns function calls made inside `useState` calls.
35
35
  *
36
36
  * 🚫 Not fixable - https://eslint-react.xyz/docs/rules/hooks-extra-prefer-use-state-lazy-initialization
37
37
  */
38
- "hooks-extra/prefer-use-state-lazy-initialization": "error",
38
+ "@eslint-react/hooks-extra/prefer-use-state-lazy-initialization": "error",
39
39
 
40
40
  /**
41
41
  * Enforces naming conventions for components.
42
42
  *
43
43
  * 🚫 Not fixable - https://eslint-react.xyz/docs/rules/naming-convention-component-name
44
44
  */
45
- "naming-convention/component-name": "warn",
45
+ "@eslint-react/naming-convention/component-name": "warn",
46
46
 
47
47
  /**
48
48
  * Enforces naming convention for JSX files.
49
49
  *
50
50
  * 🚫 Not fixable - https://eslint-react.xyz/docs/rules/naming-convention-filename
51
51
  */
52
- "naming-convention/filename": "warn",
52
+ "@eslint-react/naming-convention/filename": "warn",
53
53
 
54
54
  /**
55
55
  * Enforces consistent use of the JSX file extension.
56
56
  *
57
57
  * 🚫 Not fixable - https://eslint-react.xyz/docs/rules/naming-convention-filename-extension
58
58
  */
59
- "naming-convention/filename-extension": "warn",
59
+ "@eslint-react/naming-convention/filename-extension": "warn",
60
60
 
61
61
  /**
62
62
  * Enforces destructuring and symmetric naming of useState hook value and setter variables.
63
63
  *
64
64
  * 🚫 Not fixable - https://eslint-react.xyz/docs/rules/naming-convention-use-state
65
65
  */
66
- "naming-convention/use-state": "warn"
66
+ "@eslint-react/naming-convention/use-state": "warn"
67
67
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@haltcase/style",
3
- "version": "7.0.0-canary.6",
3
+ "version": "7.0.0-canary.7",
4
4
  "description": "haltcase's web ecosystem style guide & configurations",
5
5
  "keywords": [
6
6
  "eslint",