@plumeria/eslint-plugin 7.5.5 → 7.6.1

package/README.md

@@ -12,6 +12,7 @@ The `plugin:@plumeria/recommended` config enables the following:
 - `@plumeria/no-inner-call`: **error**
 - `@plumeria/no-unused-keys`: **warn**
 - `@plumeria/sort-properties`: **warn**
+- `@plumeria/format-properties`: **warn**
 - `@plumeria/validate-values`: **warn**
 
 ```js
@@ -42,6 +43,11 @@ Warns when object keys are defined but not used, mainly in component files.
 
 Automatically sorts CSS properties in the recommended order for consistency and maintainability.
 
+### format-properties
+Automatically format for consistency and maintainability.
+- Formats a line into a multi-line.  
+- Formats by filling in blank lines.
+
 ### validate-values
 
 Validates CSS property values for correctness. Only standard CSS properties are checked; properties with string literal keys (e.g., computed or dynamic property names) are not validated.

package/dist/index.js

@@ -6,6 +6,7 @@ const no_destructure_1 = require("./rules/no-destructure");
 const no_inner_call_1 = require("./rules/no-inner-call");
 const no_unused_keys_1 = require("./rules/no-unused-keys");
 const sort_properties_1 = require("./rules/sort-properties");
+const format_properties_1 = require("./rules/format-properties");
 const validate_values_1 = require("./rules/validate-values");
 const rules = {
     'no-combinator': no_combinator_1.noCombinator,
@@ -13,6 +14,7 @@ const rules = {
     'no-inner-call': no_inner_call_1.noInnerCall,
     'no-unused-keys': no_unused_keys_1.noUnusedKeys,
     'sort-properties': sort_properties_1.sortProperties,
+    'format-properties': format_properties_1.formatProperties,
     'validate-values': validate_values_1.validateValues,
 };
 const configs = {
@@ -24,6 +26,7 @@ const configs = {
             '@plumeria/no-inner-call': 'error',
             '@plumeria/no-unused-keys': 'warn',
             '@plumeria/sort-properties': 'warn',
+            '@plumeria/format-properties': 'warn',
             '@plumeria/validate-values': 'warn',
         },
     },
@@ -41,6 +44,7 @@ const flatConfigs = {
             '@plumeria/no-inner-call': 'error',
             '@plumeria/no-unused-keys': 'warn',
             '@plumeria/sort-properties': 'warn',
+            '@plumeria/format-properties': 'warn',
             '@plumeria/validate-values': 'warn',
         },
     },

package/dist/rules/format-properties.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'eslint';
+export declare const formatProperties: Rule.RuleModule;

package/dist/rules/format-properties.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatProperties = void 0;
+function getSourceCode(context) {
+    return context.sourceCode ?? context.getSourceCode();
+}
+exports.formatProperties = {
+    meta: {
+        type: 'layout',
+        docs: {
+            description: 'Format nested objects to have one property per line and remove empty lines',
+        },
+        fixable: 'whitespace',
+        schema: [],
+        messages: {
+            mustBeMultiline: 'Property object must be formatted with each property on its own line.',
+            noEmptyLines: 'No empty lines allowed between properties.',
+        },
+    },
+    create(context) {
+        const sourceCode = getSourceCode(context);
+        return {
+            ObjectExpression(node) {
+                if (!node.parent || node.parent.type !== 'Property')
+                    return;
+                if (node.properties.length === 0)
+                    return;
+                const properties = node.properties;
+                const parentLine = sourceCode.lines[node.parent.loc.start.line - 1];
+                const baseIndent = parentLine.match(/^(\s*)/)[1];
+                const innerIndent = baseIndent + '  ';
+                const countNewlines = (text) => (text.match(/\n/g) ?? []).length;
+                const fullText = sourceCode.getText();
+                const openBrace = sourceCode.getFirstToken(node);
+                const closeBrace = sourceCode.getLastToken(node);
+                let hasError = false;
+                let hasBlankLines = false;
+                const textBeforeFirst = fullText.slice(openBrace.range[1], properties[0].range[0]);
+                const newlinesBeforeFirst = countNewlines(textBeforeFirst);
+                if (newlinesBeforeFirst === 0)
+                    hasError = true;
+                for (let i = 0; i < properties.length - 1; i++) {
+                    const current = properties[i];
+                    const next = properties[i + 1];
+                    const comma = sourceCode.getTokenAfter(current);
+                    const sliceStart = comma.range[1];
+                    const between = fullText.slice(sliceStart, next.range[0]);
+                    const newlines = countNewlines(between);
+                    if (newlines === 0)
+                        hasError = true;
+                    if (newlines > 1)
+                        hasBlankLines = true;
+                }
+                const lastProp = properties[properties.length - 1];
+                const lastComma = sourceCode.getTokenAfter(lastProp);
+                const lastSliceStart = lastComma?.value === ',' ? lastComma.range[1] : lastProp.range[1];
+                const textAfterLast = fullText.slice(lastSliceStart, closeBrace.range[0]);
+                const newlinesAfterLast = countNewlines(textAfterLast);
+                if (newlinesAfterLast === 0)
+                    hasError = true;
+                if (!hasError && !hasBlankLines)
+                    return;
+                const buildFixes = (fixer) => {
+                    const fixes = [];
+                    fixes.push(fixer.replaceTextRange([openBrace.range[1], properties[0].range[0]], `\n${innerIndent}`));
+                    for (let i = 0; i < properties.length - 1; i++) {
+                        const current = properties[i];
+                        const next = properties[i + 1];
+                        const comma = sourceCode.getTokenAfter(current);
+                        if (comma.value === ',') {
+                            fixes.push(fixer.replaceTextRange([comma.range[1], next.range[0]], `\n${innerIndent}`));
+                        }
+                    }
+                    const lastComma = sourceCode.getTokenAfter(lastProp);
+                    if (lastComma?.value === ',') {
+                        fixes.push(fixer.replaceTextRange([lastComma.range[1], closeBrace.range[0]], `\n${baseIndent}`));
+                    }
+                    else {
+                        fixes.push(fixer.replaceTextRange([lastProp.range[1], closeBrace.range[0]], `\n${baseIndent}`));
+                    }
+                    return fixes;
+                };
+                if (hasError) {
+                    context.report({
+                        node,
+                        messageId: 'mustBeMultiline',
+                        fix: buildFixes,
+                    });
+                    return;
+                }
+                let reported = false;
+                for (let i = 0; i < properties.length - 1; i++) {
+                    const current = properties[i];
+                    const next = properties[i + 1];
+                    const comma = sourceCode.getTokenAfter(current);
+                    const sliceStart = comma.range[1];
+                    const between = fullText.slice(sliceStart, next.range[0]);
+                    if (countNewlines(between) > 1) {
+                        const blankLineNumber = current.loc.end.line + 1;
+                        context.report({
+                            loc: {
+                                start: {
+                                    line: blankLineNumber,
+                                    column: 0,
+                                },
+                                end: {
+                                    line: blankLineNumber + 1,
+                                    column: 0,
+                                },
+                            },
+                            messageId: 'noEmptyLines',
+                            fix: reported ? null : buildFixes,
+                        });
+                        reported = true;
+                    }
+                }
+            },
+        };
+    },
+};

package/oxlint.json

@@ -9,6 +9,7 @@
     "@plumeria/no-inner-call": "error",
     "@plumeria/no-unused-keys": "warn",
     "@plumeria/sort-properties": "warn",
+    "@plumeria/format-properties": "warn",
     "@plumeria/validate-values": "warn"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plumeria/eslint-plugin",
-  "version": "7.5.5",
+  "version": "7.6.1",
   "description": "Plumeria ESLint plugin",
   "author": "Refirst 11",
   "license": "MIT",