eslint-plugin-flawless 0.1.6 → 0.1.8

package/README.md

@@ -176,17 +176,17 @@ pnpm eslint-docs
 💭
 Requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
-| Name                                                                                          | Description                                                             | 🔧  | 💭  |
-| :-------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- | :-- | :-- |
-| [jsx-shorthand-boolean](src/rules/jsx-shorthand-boolean/documentation.md)                     | Disallow shorthand boolean JSX attributes                               | 🔧  |     |
-| [jsx-shorthand-fragment](src/rules/jsx-shorthand-fragment/documentation.md)                   | Disallow the shorthand fragment syntax in favour of a named fragment    | 🔧  |     |
-| [naming-convention](src/rules/naming-convention/documentation.md)                             | Enforce naming conventions for everything across a codebase             |     | 💭  |
-| [no-unnecessary-use-callback](src/rules/no-unnecessary-use-callback/documentation.md)         | Disallow unnecessary usage of 'useCallback'                             |     |     |
-| [no-unnecessary-use-memo](src/rules/no-unnecessary-use-memo/documentation.md)                 | Disallow unnecessary usage of 'useMemo'                                 |     |     |
-| [prefer-destructuring-assignment](src/rules/prefer-destructuring-assignment/documentation.md) | Enforce destructuring assignment for component props                    | 🔧  |     |
-| [purity](src/rules/purity/documentation.md)                                                   | Disallow impure calls such as `math.random` or `os.clock` during render |     |     |
-| [toml-sort-keys](src/rules/toml-sort-keys/documentation.md)                                   | Enforce a configured sort order for TOML keys and tables                | 🔧  |     |
-| [yaml-block-key-blank-lines](src/rules/yaml-block-key-blank-lines/documentation.md)           | Enforce blank lines around top-level YAML block collection keys         | 🔧  |     |
+| Name                                                                                          | Description                                                                      | 🔧  | 💭  |
+| :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------- | :-- | :-- |
+| [jsx-shorthand-boolean](src/rules/jsx-shorthand-boolean/documentation.md)                     | Disallow shorthand boolean JSX attributes                                        | 🔧  |     |
+| [jsx-shorthand-fragment](src/rules/jsx-shorthand-fragment/documentation.md)                   | Enforce a consistent fragment form: the shorthand `<>...</>` or a named fragment | 🔧  |     |
+| [naming-convention](src/rules/naming-convention/documentation.md)                             | Enforce naming conventions for everything across a codebase                      |     | 💭  |
+| [no-unnecessary-use-callback](src/rules/no-unnecessary-use-callback/documentation.md)         | Disallow unnecessary usage of 'useCallback'                                      |     |     |
+| [no-unnecessary-use-memo](src/rules/no-unnecessary-use-memo/documentation.md)                 | Disallow unnecessary usage of 'useMemo'                                          |     |     |
+| [prefer-destructuring-assignment](src/rules/prefer-destructuring-assignment/documentation.md) | Enforce destructuring assignment for component props                             | 🔧  |     |
+| [purity](src/rules/purity/documentation.md)                                                   | Disallow impure calls such as `math.random` or `os.clock` during render          |     |     |
+| [toml-sort-keys](src/rules/toml-sort-keys/documentation.md)                                   | Enforce a configured sort order for TOML keys and tables                         | 🔧  |     |
+| [yaml-block-key-blank-lines](src/rules/yaml-block-key-blank-lines/documentation.md)           | Enforce blank lines around top-level YAML block collection keys                  | 🔧  |     |
 
 <!-- end auto-generated rules list -->
 

package/dist/index.d.mts

@@ -9,7 +9,23 @@ interface PluginDocumentation {
 }
 //#endregion
 //#region src/rules/jsx-shorthand-fragment/rule.d.ts
-type Options$3 = [fragmentName?: string];
+declare const MESSAGE_ID_NAMED = "useNamedFragment";
+declare const MESSAGE_ID_SHORTHAND = "useShorthandFragment";
+type MessageIds$3 = typeof MESSAGE_ID_NAMED | typeof MESSAGE_ID_SHORTHAND;
+interface JsxShorthandFragmentOptions {
+  /**
+   * The identifier used for the named fragment element in `"element"` mode
+   * (e.g. `"Fragment"` or `"React.Fragment"`). Defaults to `"Fragment"`.
+   */
+  readonly fragmentName?: string;
+  /**
+   * Which form to enforce: `"syntax"` (shorthand `<>...</>`, the default) or
+   * `"element"` (a named fragment such as `<Fragment>...</Fragment>`).
+   */
+  readonly mode?: Mode;
+}
+type Options$3 = [JsxShorthandFragmentOptions?];
+type Mode = "element" | "syntax";
 //#endregion
 //#region src/rules/naming-convention/utils/enums.d.ts
 declare const Selector: {
@@ -166,7 +182,7 @@ declare const plugin: {
     "jsx-shorthand-boolean": TSESLint.RuleModule<"setAttributeValue", [], PluginDocumentation, TSESLint.RuleListener> & {
       name: string;
     };
-    "jsx-shorthand-fragment": TSESLint.RuleModule<"useNamedFragment", Options$3, PluginDocumentation, TSESLint.RuleListener> & {
+    "jsx-shorthand-fragment": TSESLint.RuleModule<MessageIds$3, Options$3, PluginDocumentation, TSESLint.RuleListener> & {
       name: string;
     };
     "naming-convention": TSESLint.RuleModule<MessageIds$2, Options$2, PluginDocumentation, TSESLint.RuleListener> & {
@@ -207,7 +223,7 @@ declare const _default: {
             "jsx-shorthand-boolean": import("${configDir}").RuleModule<"setAttributeValue", [], PluginDocumentation, import("${configDir}").RuleListener> & {
               name: string;
             };
-            "jsx-shorthand-fragment": import("${configDir}").RuleModule<"useNamedFragment", Options$3, PluginDocumentation, import("${configDir}").RuleListener> & {
+            "jsx-shorthand-fragment": import("${configDir}").RuleModule<MessageIds$3, Options$3, PluginDocumentation, import("${configDir}").RuleListener> & {
               name: string;
             };
             "naming-convention": import("${configDir}").RuleModule<MessageIds$2, Options$2, PluginDocumentation, import("${configDir}").RuleListener> & {
@@ -245,7 +261,7 @@ declare const _default: {
     "jsx-shorthand-boolean": import("${configDir}").RuleModule<"setAttributeValue", [], PluginDocumentation, import("${configDir}").RuleListener> & {
       name: string;
     };
-    "jsx-shorthand-fragment": import("${configDir}").RuleModule<"useNamedFragment", Options$3, PluginDocumentation, import("${configDir}").RuleListener> & {
+    "jsx-shorthand-fragment": import("${configDir}").RuleModule<MessageIds$3, Options$3, PluginDocumentation, import("${configDir}").RuleListener> & {
       name: string;
     };
     "naming-convention": import("${configDir}").RuleModule<MessageIds$2, Options$2, PluginDocumentation, import("${configDir}").RuleListener> & {

package/dist/index.mjs

@@ -1,14 +1,14 @@
 import { RuleCreator, getParserServices } from "@typescript-eslint/utils/eslint-utils";
+import { ASTUtils, AST_NODE_TYPES, ESLintUtils, TSESLint } from "@typescript-eslint/utils";
 import { DefinitionType, ImplicitLibVariable, PatternVisitor, ScopeType, Visitor } from "@typescript-eslint/scope-manager";
 import { requiresQuoting } from "@typescript-eslint/type-utils";
-import { ASTUtils, AST_NODE_TYPES, ESLintUtils, TSESLint } from "@typescript-eslint/utils";
 import assert from "node:assert";
 import * as core from "@eslint-react/core";
 import { findVariable } from "@typescript-eslint/utils/ast-utils";
 import { getStaticTOMLValue } from "toml-eslint-parser";
 //#region package.json
 var name = "eslint-plugin-flawless";
-var version = "0.1.6";
+var version = "0.1.8";
 var repository = {
 	"url": "git+https://github.com/christopher-buss/eslint-plugin-flawless.git",
 	"type": "git"
@@ -36,8 +36,8 @@ function createEslintRule(rule) {
 //#endregion
 //#region src/rules/jsx-shorthand-boolean/rule.ts
 const RULE_NAME$8 = "jsx-shorthand-boolean";
-const MESSAGE_ID$4 = "setAttributeValue";
-const messages$8 = { [MESSAGE_ID$4]: "Set an explicit value for boolean attribute '{{name}}'." };
+const MESSAGE_ID$3 = "setAttributeValue";
+const messages$8 = { [MESSAGE_ID$3]: "Set an explicit value for boolean attribute '{{name}}'." };
 function create$8(context) {
 	const { sourceCode } = context;
 	return { JSXAttribute(node) {
@@ -45,7 +45,7 @@ function create$8(context) {
 		context.report({
 			data: { name: sourceCode.getText(node.name) },
 			fix: (fixer) => fixer.insertTextAfter(node.name, "={true}"),
-			messageId: MESSAGE_ID$4,
+			messageId: MESSAGE_ID$3,
 			node
 		});
 	} };
@@ -70,23 +70,79 @@ const jsxShorthandBoolean = createEslintRule({
 //#endregion
 //#region src/rules/jsx-shorthand-fragment/rule.ts
 const RULE_NAME$7 = "jsx-shorthand-fragment";
-const MESSAGE_ID$3 = "useNamedFragment";
+const MESSAGE_ID_NAMED = "useNamedFragment";
+const MESSAGE_ID_SHORTHAND = "useShorthandFragment";
+const DEFAULT_MODE = "syntax";
 const DEFAULT_FRAGMENT_NAME = "Fragment";
-const messages$7 = { [MESSAGE_ID$3]: "Use the '{{name}}' component instead of fragment shorthand syntax." };
+const messages$7 = {
+	[MESSAGE_ID_NAMED]: "Use the '{{name}}' component instead of fragment shorthand syntax.",
+	[MESSAGE_ID_SHORTHAND]: "Use the fragment shorthand syntax '<>...</>' instead of the '{{name}}' component."
+};
 const schema$2 = [{
-	description: "The identifier to use for the named fragment element.",
-	type: "string"
+	additionalProperties: false,
+	properties: {
+		fragmentName: {
+			description: "The identifier to use for the named fragment element in \"element\" mode.",
+			type: "string"
+		},
+		mode: {
+			description: "Which form to enforce: \"syntax\" (shorthand `<>...</>`, default) or \"element\" (a named fragment).",
+			enum: ["element", "syntax"],
+			type: "string"
+		}
+	},
+	type: "object"
 }];
+/**
+* Flattens a JSX element name into a dotted string, e.g. `Fragment` or
+* `React.Fragment`. Returns `null` for namespaced names (`<a:b>`) which cannot
+* be a fragment.
+*
+* @param node - The JSX element name node.
+* @returns The dotted name, or `null` when it is not a plain identifier chain.
+*/
+function jsxNameToString(node) {
+	if (node.type === AST_NODE_TYPES.JSXIdentifier) return node.name;
+	if (node.type === AST_NODE_TYPES.JSXMemberExpression) {
+		const object = jsxNameToString(node.object);
+		if (object === null) return null;
+		return `${object}.${node.property.name}`;
+	}
+	return null;
+}
 function create$7(context) {
-	const name = context.options[0] ?? DEFAULT_FRAGMENT_NAME;
-	return { JSXFragment(node) {
+	const options = context.options[0] ?? {};
+	const mode = options.mode ?? DEFAULT_MODE;
+	const fragmentName = options.fragmentName ?? DEFAULT_FRAGMENT_NAME;
+	if (mode === "element") return { JSXFragment(node) {
 		const { closingFragment, openingFragment } = node;
+		context.report({
+			data: { name: fragmentName },
+			fix: (fixer) => {
+				return [fixer.replaceText(openingFragment, `<${fragmentName}>`), fixer.replaceText(closingFragment, `</${fragmentName}>`)];
+			},
+			messageId: MESSAGE_ID_NAMED,
+			node
+		});
+	} };
+	const namedFragments = /* @__PURE__ */ new Set([
+		"Fragment",
+		fragmentName,
+		"React.Fragment"
+	]);
+	return { JSXElement(node) {
+		const { openingElement } = node;
+		const name = jsxNameToString(openingElement.name);
+		if (name === null || !namedFragments.has(name)) return;
+		if (openingElement.attributes.length > 0) return;
 		context.report({
 			data: { name },
 			fix: (fixer) => {
-				return [fixer.replaceText(openingFragment, `<${name}>`), fixer.replaceText(closingFragment, `</${name}>`)];
+				const { closingElement } = node;
+				if (closingElement === null) return fixer.replaceText(node, "<></>");
+				return [fixer.replaceText(openingElement, "<>"), fixer.replaceText(closingElement, "</>")];
 			},
-			messageId: MESSAGE_ID$3,
+			messageId: MESSAGE_ID_SHORTHAND,
 			node
 		});
 	} };
@@ -94,11 +150,17 @@ function create$7(context) {
 const jsxShorthandFragment = createEslintRule({
 	name: RULE_NAME$7,
 	create: create$7,
-	defaultOptions: [DEFAULT_FRAGMENT_NAME],
+	defaultOptions: [{
+		fragmentName: DEFAULT_FRAGMENT_NAME,
+		mode: DEFAULT_MODE
+	}],
 	meta: {
-		defaultOptions: [DEFAULT_FRAGMENT_NAME],
+		defaultOptions: [{
+			fragmentName: DEFAULT_FRAGMENT_NAME,
+			mode: DEFAULT_MODE
+		}],
 		docs: {
-			description: "Disallow the shorthand fragment syntax in favour of a named fragment",
+			description: "Enforce a consistent fragment form: the shorthand `<>...</>` or a named fragment",
 			recommended: false,
 			requiresTypeChecking: false
 		},
@@ -2412,14 +2474,18 @@ function makeFallback(config) {
 /**
 * Builds a comparator for one table body. Explicit-order entries sort first by
 * their listed position, then unlisted entries fall back to a natural/asc sort
-* (mirroring `yaml/sort-keys`). At the top level, bare key-values are always
-* kept before any `[table]` header, since TOML would otherwise re-scope them.
+* (mirroring `yaml/sort-keys`). The fallback compares keys as written in
+* source, so quotes participate in the order and quoted keys (e.g.
+* `"github:owner/repo"`) group before bare keys. At the top level, bare
+* key-values are always kept before any `[table]` header, since TOML would
+* otherwise re-scope them.
 *
 * @param order - The order configuration for this table's path.
 * @param isTopLevel - Whether the body is the top-level table.
+* @param rawName - Returns an entry's key exactly as written in source.
 * @returns A comparator over two entries.
 */
-function makeComparator(order, isTopLevel) {
+function makeComparator(order, isTopLevel, rawName) {
 	const rank = Array.isArray(order) ? makeRank(order) : void 0;
 	const fallback = makeFallback(Array.isArray(order) ? {
 		natural: true,
@@ -2440,7 +2506,7 @@ function makeComparator(order, isTopLevel) {
 				return aRank - bRank;
 			}
 		}
-		return fallback(nameOf(a), nameOf(b));
+		return fallback(rawName(a), rawName(b));
 	};
 }
 function create$1(context) {
@@ -2519,7 +2585,7 @@ function create$1(context) {
 		const order = resolveOrder(path);
 		if (order === void 0) return;
 		const entries = [...body];
-		const target = [...entries].sort(makeComparator(order, isTopLevel));
+		const target = [...entries].sort(makeComparator(order, isTopLevel, (entry) => sourceCode.getText(entry.key)));
 		let outOfPlace;
 		for (const [index, entry] of entries.entries()) if (entry !== target[index]) {
 			outOfPlace = entry;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-flawless",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "Your ESLint plugin description",
   "keywords": [
     "eslint",