eslint-plugin-conventions 4.2.6 → 4.2.7

package/src/rules/conventions/filename-case.js

@@ -1,234 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filenameCase = void 0;
-const eslint_devkit_1 = require("@interlace/eslint-devkit");
-const eslint_devkit_2 = require("@interlace/eslint-devkit");
-const eslint_devkit_3 = require("@interlace/eslint-devkit");
-const DEFAULT_ALLOWED_UPPERCASE_FILES = [
-    'README',
-    'LICENSE',
-    'CHANGELOG',
-    'CONTRIBUTING',
-    'AUTHORS',
-    'COPYING',
-    'SECURITY',
-    'NOTICE',
-    'PATENTS',
-    'VERSION',
-];
-exports.filenameCase = (0, eslint_devkit_1.createRule)({
-    name: 'filename-case',
-    meta: {
-        type: 'problem',
-        docs: {
-            url: 'https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/filename-case.md',
-            description: 'Enforce filename case conventions for consistency',
-        },
-        hasSuggestions: true,
-        messages: {
-            filenameCase: (0, eslint_devkit_2.formatLLMMessage)({
-                icon: eslint_devkit_2.MessageIcons.WARNING,
-                issueName: 'Filename Case Convention',
-                description: 'Filename "{{current}}" violates {{case}} naming convention',
-                severity: 'MEDIUM',
-                fix: 'Rename file from "{{current}}" to "{{suggested}}" following {{case}} convention',
-                documentationLink: 'https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md',
-            }),
-        },
-        schema: [
-            {
-                type: 'object',
-                properties: {
-                    case: {
-                        type: 'string',
-                        enum: ['camelCase', 'kebabCase', 'pascalCase', 'snakeCase'],
-                        default: 'kebabCase',
-                    },
-                    ignore: {
-                        type: 'array',
-                        items: {
-                            anyOf: [
-                                { type: 'string' },
-                                { type: 'object' },
-                            ],
-                        },
-                        default: [],
-                    },
-                    allowedUppercaseFiles: {
-                        type: 'array',
-                        items: { type: 'string' },
-                        description: 'List of uppercase filenames to allow (without extension). Defaults to common files like README, LICENSE, etc.',
-                    },
-                    allowedKebabCase: {
-                        type: 'array',
-                        items: { type: 'string' },
-                        description: 'List of filenames allowed to use kebab-case regardless of the global case setting.',
-                        default: [],
-                    },
-                    allowedSnakeCase: {
-                        type: 'array',
-                        items: { type: 'string' },
-                        description: 'List of filenames allowed to use snake_case regardless of the global case setting.',
-                        default: [],
-                    },
-                    allowedCamelCase: {
-                        type: 'array',
-                        items: { type: 'string' },
-                        description: 'List of filenames allowed to use camelCase regardless of the global case setting.',
-                        default: [],
-                    },
-                    allowedPascalCase: {
-                        type: 'array',
-                        items: { type: 'string' },
-                        description: 'List of filenames allowed to use PascalCase regardless of the global case setting.',
-                        default: [],
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
-    },
-    defaultOptions: [{
-            case: 'kebabCase',
-            ignore: [],
-            allowedUppercaseFiles: DEFAULT_ALLOWED_UPPERCASE_FILES,
-            allowedKebabCase: [],
-            allowedSnakeCase: [],
-            allowedCamelCase: [],
-            allowedPascalCase: [],
-        }],
-    create(context) {
-        const [options] = context.options;
-        const { case: caseType = 'kebabCase', ignore = [], allowedUppercaseFiles = DEFAULT_ALLOWED_UPPERCASE_FILES, allowedKebabCase = [], allowedSnakeCase = [], allowedCamelCase = [], allowedPascalCase = [], } = options || {};
-        function toCamelCase(str) {
-            return str.replace(/[-_](.)/g, (_, letter) => letter.toUpperCase());
-        }
-        function toKebabCase(str) {
-            return str
-                .replace(/([a-z])([A-Z])/g, '$1-$2')
-                .replace(/[\s_]+/g, '-')
-                .toLowerCase();
-        }
-        function toPascalCase(str) {
-            const camel = toCamelCase(str);
-            return camel.charAt(0).toUpperCase() + camel.slice(1);
-        }
-        function toSnakeCase(str) {
-            return str
-                .replace(/([a-z])([A-Z])/g, '$1_$2')
-                .replace(/[\s-]+/g, '_')
-                .toLowerCase();
-        }
-        function isCamelCase(str) {
-            return /^[a-z][a-zA-Z0-9]*$/.test(str);
-        }
-        function isKebabCase(str) {
-            return /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/.test(str);
-        }
-        function isPascalCase(str) {
-            return /^[A-Z][a-zA-Z0-9]*$/.test(str);
-        }
-        function isSnakeCase(str) {
-            return /^[a-z][a-z0-9]*(_[a-z0-9]+)*$/.test(str);
-        }
-        function matchesCase(str, expectedCase) {
-            switch (expectedCase) {
-                case 'camelCase':
-                    return isCamelCase(str);
-                case 'kebabCase':
-                    return isKebabCase(str);
-                case 'pascalCase':
-                    return isPascalCase(str);
-                case 'snakeCase':
-                    return isSnakeCase(str);
-                default:
-                    return true;
-            }
-        }
-        function getSuggestedName(basename, nameWithoutExt, targetCase) {
-            let transformed = nameWithoutExt;
-            switch (targetCase) {
-                case 'camelCase':
-                    transformed = toCamelCase(nameWithoutExt);
-                    break;
-                case 'kebabCase':
-                    transformed = toKebabCase(nameWithoutExt);
-                    break;
-                case 'pascalCase':
-                    transformed = toPascalCase(nameWithoutExt);
-                    break;
-                case 'snakeCase':
-                    transformed = toSnakeCase(nameWithoutExt);
-                    break;
-            }
-            const ext = basename.slice(nameWithoutExt.length);
-            return transformed + ext;
-        }
-        return {
-            Program(node) {
-                const filename = context.filename;
-                if (!filename) {
-                    return;
-                }
-                const basename = (0, eslint_devkit_3.getBasename)(filename);
-                const nameWithoutExt = basename.replace(/(\.(spec|test|stories|story|e2e|d))*\.[^.]+$/, '');
-                if (!nameWithoutExt) {
-                    return;
-                }
-                for (const ignorePattern of ignore) {
-                    if (typeof ignorePattern === 'string') {
-                        if (basename === ignorePattern) {
-                            return;
-                        }
-                    }
-                    else if (ignorePattern instanceof RegExp) {
-                        if (ignorePattern.test(basename)) {
-                            return;
-                        }
-                    }
-                }
-                if (allowedUppercaseFiles.includes(nameWithoutExt)) {
-                    return;
-                }
-                if (basename.startsWith('.')) {
-                    return;
-                }
-                if (allowedKebabCase.includes(nameWithoutExt) && matchesCase(nameWithoutExt, 'kebabCase')) {
-                    return;
-                }
-                if (allowedSnakeCase.includes(nameWithoutExt) && matchesCase(nameWithoutExt, 'snakeCase')) {
-                    return;
-                }
-                if (allowedCamelCase.includes(nameWithoutExt) && matchesCase(nameWithoutExt, 'camelCase')) {
-                    return;
-                }
-                if (allowedPascalCase.includes(nameWithoutExt) && matchesCase(nameWithoutExt, 'pascalCase')) {
-                    return;
-                }
-                if (!matchesCase(nameWithoutExt, caseType)) {
-                    const suggestedName = getSuggestedName(basename, nameWithoutExt, caseType);
-                    context.report({
-                        node,
-                        messageId: 'filenameCase',
-                        data: {
-                            case: caseType,
-                            current: basename,
-                            suggested: suggestedName,
-                        },
-                        suggest: [
-                            {
-                                messageId: 'filenameCase',
-                                data: {
-                                    suggestedName,
-                                },
-                                fix() {
-                                    return null;
-                                },
-                            },
-                        ],
-                    });
-                }
-            },
-        };
-    },
-});
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.filenameCase=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const eslint_devkit_3=require("@interlace/eslint-devkit");const DEFAULT_ALLOWED_UPPERCASE_FILES=["README","LICENSE","CHANGELOG","CONTRIBUTING","AUTHORS","COPYING","SECURITY","NOTICE","PATENTS","VERSION"];exports.filenameCase=(0,eslint_devkit_1.createRule)({name:"filename-case",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/filename-case.md",description:"Enforce filename case conventions for consistency"},hasSuggestions:true,messages:{filenameCase:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Filename Case Convention",description:'Filename "{{current}}" violates {{case}} naming convention',severity:"MEDIUM",fix:'Rename file from "{{current}}" to "{{suggested}}" following {{case}} convention',documentationLink:"https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md"})},schema:[{type:"object",properties:{case:{type:"string",enum:["camelCase","kebabCase","pascalCase","snakeCase"],default:"kebabCase"},ignore:{type:"array",items:{anyOf:[{type:"string"},{type:"object"}]},default:[]},allowedUppercaseFiles:{type:"array",items:{type:"string"},description:"List of uppercase filenames to allow (without extension). Defaults to common files like README, LICENSE, etc."},allowedKebabCase:{type:"array",items:{type:"string"},description:"List of filenames allowed to use kebab-case regardless of the global case setting.",default:[]},allowedSnakeCase:{type:"array",items:{type:"string"},description:"List of filenames allowed to use snake_case regardless of the global case setting.",default:[]},allowedCamelCase:{type:"array",items:{type:"string"},description:"List of filenames allowed to use camelCase regardless of the global case setting.",default:[]},allowedPascalCase:{type:"array",items:{type:"string"},description:"List of filenames allowed to use PascalCase regardless of the global case setting.",default:[]}},additionalProperties:false}]},defaultOptions:[{case:"kebabCase",ignore:[],allowedUppercaseFiles:DEFAULT_ALLOWED_UPPERCASE_FILES,allowedKebabCase:[],allowedSnakeCase:[],allowedCamelCase:[],allowedPascalCase:[]}],create(context){const[options]=context.options;const{case:caseType="kebabCase",ignore=[],allowedUppercaseFiles=DEFAULT_ALLOWED_UPPERCASE_FILES,allowedKebabCase=[],allowedSnakeCase=[],allowedCamelCase=[],allowedPascalCase=[]}=options||{};function toCamelCase(str){return str.replace(/[-_](.)/g,(_,letter)=>letter.toUpperCase())}function toKebabCase(str){return str.replace(/([a-z])([A-Z])/g,"$1-$2").replace(/[\s_]+/g,"-").toLowerCase()}function toPascalCase(str){const camel=toCamelCase(str);return camel.charAt(0).toUpperCase()+camel.slice(1)}function toSnakeCase(str){return str.replace(/([a-z])([A-Z])/g,"$1_$2").replace(/[\s-]+/g,"_").toLowerCase()}function isCamelCase(str){return/^[a-z][a-zA-Z0-9]*$/.test(str)}function isKebabCase(str){return/^[a-z][a-z0-9]*(-[a-z0-9]+)*$/.test(str)}function isPascalCase(str){return/^[A-Z][a-zA-Z0-9]*$/.test(str)}function isSnakeCase(str){return/^[a-z][a-z0-9]*(_[a-z0-9]+)*$/.test(str)}function matchesCase(str,expectedCase){switch(expectedCase){case"camelCase":return isCamelCase(str);case"kebabCase":return isKebabCase(str);case"pascalCase":return isPascalCase(str);case"snakeCase":return isSnakeCase(str);default:return true}}function getSuggestedName(basename,nameWithoutExt,targetCase){let transformed=nameWithoutExt;switch(targetCase){case"camelCase":transformed=toCamelCase(nameWithoutExt);break;case"kebabCase":transformed=toKebabCase(nameWithoutExt);break;case"pascalCase":transformed=toPascalCase(nameWithoutExt);break;case"snakeCase":transformed=toSnakeCase(nameWithoutExt);break}const ext=basename.slice(nameWithoutExt.length);return transformed+ext}return{Program(node){const filename=context.filename;if(!filename){return}const basename=(0,eslint_devkit_3.getBasename)(filename);const nameWithoutExt=basename.replace(/(\.(spec|test|stories|story|e2e|d))*\.[^.]+$/,"");if(!nameWithoutExt){return}for(const ignorePattern of ignore){if(typeof ignorePattern==="string"){if(basename===ignorePattern){return}}else if(ignorePattern instanceof RegExp){if(ignorePattern.test(basename)){return}}}if(allowedUppercaseFiles.includes(nameWithoutExt)){return}if(basename.startsWith(".")){return}if(allowedKebabCase.includes(nameWithoutExt)&&matchesCase(nameWithoutExt,"kebabCase")){return}if(allowedSnakeCase.includes(nameWithoutExt)&&matchesCase(nameWithoutExt,"snakeCase")){return}if(allowedCamelCase.includes(nameWithoutExt)&&matchesCase(nameWithoutExt,"camelCase")){return}if(allowedPascalCase.includes(nameWithoutExt)&&matchesCase(nameWithoutExt,"pascalCase")){return}if(!matchesCase(nameWithoutExt,caseType)){const suggestedName=getSuggestedName(basename,nameWithoutExt,caseType);context.report({node,messageId:"filenameCase",data:{case:caseType,current:basename,suggested:suggestedName},suggest:[{messageId:"filenameCase",data:{suggestedName},fix(){return null}}]})}}}}});

package/src/rules/conventions/no-commented-code.js

@@ -1,237 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.noCommentedCode = void 0;
-const eslint_devkit_1 = require("@interlace/eslint-devkit");
-const eslint_devkit_2 = require("@interlace/eslint-devkit");
-function looksLikeCode(comment, isBlockComment) {
-    let text = comment;
-    if (isBlockComment) {
-        text = text.replace(/^\s*\/\*+/, '').replace(/\*+\/\s*$/, '');
-        text = text
-            .split('\n')
-            .map((line) => line.replace(/^\s*\*+\s*/, ''))
-            .join('\n');
-    }
-    else {
-        text = text
-            .split('\n')
-            .map((line) => line.replace(/^\s*\/\/+\s*/, ''))
-            .join('\n');
-    }
-    const lines = text
-        .split('\n')
-        .map((line) => line.trim())
-        .filter((line) => line.length > 0);
-    if (lines.length === 0) {
-        return false;
-    }
-    const codePatterns = [
-        /^(const|let|var|function|class|if|for|while|return|import|export)\s+/,
-        /^[a-zA-Z_$][a-zA-Z0-9_$]*\s*[=:]\s*/,
-        /^[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,
-        /^[{}[\]]/,
-    ];
-    let codeLikeLines = 0;
-    for (const line of lines) {
-        if (/^(TODO|FIXME|HACK|XXX)/i.test(line)) {
-            continue;
-        }
-        for (const pattern of codePatterns) {
-            if (pattern.test(line)) {
-                codeLikeLines++;
-                break;
-            }
-        }
-    }
-    return codeLikeLines > 0;
-}
-function countCommentLines(comment) {
-    if (!comment)
-        return 0;
-    const newlineCount = (comment.match(/\n/g) || []).length;
-    return newlineCount > 0 ? newlineCount + 1 : 1;
-}
-exports.noCommentedCode = (0, eslint_devkit_2.createRule)({
-    name: 'no-commented-code',
-    meta: {
-        type: 'suggestion',
-        docs: {
-            url: 'https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/no-commented-code.md',
-            description: 'Detects commented-out code blocks',
-        },
-        hasSuggestions: true,
-        messages: {
-            commentedCode: (0, eslint_devkit_1.formatLLMMessage)({
-                icon: eslint_devkit_1.MessageIcons.WARNING,
-                issueName: 'Commented code',
-                description: 'Commented-out code detected ({{lines}} lines)',
-                severity: 'LOW',
-                fix: 'Remove commented code or use version control for history',
-                documentationLink: 'https://rules.sonarsource.com/javascript/RSPEC-125/',
-            }),
-            removeCode: (0, eslint_devkit_1.formatLLMMessage)({
-                icon: eslint_devkit_1.MessageIcons.INFO,
-                issueName: 'Remove Code',
-                description: 'Remove commented code block',
-                severity: 'LOW',
-                fix: 'Delete the commented code block',
-                documentationLink: 'https://rules.sonarsource.com/javascript/RSPEC-125/',
-            }),
-            useVersionControl: (0, eslint_devkit_1.formatLLMMessage)({
-                icon: eslint_devkit_1.MessageIcons.INFO,
-                issueName: 'Use Git',
-                description: 'Use version control for code history',
-                severity: 'LOW',
-                fix: 'Delete commented code and use git history instead',
-                documentationLink: 'https://git-scm.com/docs/git-log',
-            }),
-        },
-        schema: [
-            {
-                type: 'object',
-                properties: {
-                    ignoreSingleLine: {
-                        type: 'boolean',
-                        default: false,
-                        description: 'Ignore single-line comments',
-                    },
-                    ignoreInTests: {
-                        type: 'boolean',
-                        default: true,
-                        description: 'Ignore comments in test files',
-                    },
-                    minLines: {
-                        type: 'number',
-                        default: 1,
-                        minimum: 1,
-                        description: 'Minimum lines of commented code to trigger',
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
-    },
-    defaultOptions: [
-        {
-            ignoreSingleLine: false,
-            ignoreInTests: true,
-            minLines: 1,
-        },
-    ],
-    create(context, [options = {}]) {
-        const { ignoreSingleLine = false, ignoreInTests = true, minLines = 1, } = options || {};
-        const filename = context.filename;
-        const isTestFile = ignoreInTests && /\.(test|spec)\.(ts|tsx|js|jsx)$/.test(filename);
-        if (isTestFile) {
-            return {};
-        }
-        const sourceCode = context.sourceCode;
-        function checkComment(node) {
-            try {
-                const commentText = node.value || '';
-                const isBlockComment = node.type === 'Block';
-                const lines = countCommentLines(commentText);
-                if (ignoreSingleLine && lines === 1 && !isBlockComment) {
-                    return;
-                }
-                if (lines < minLines) {
-                    return;
-                }
-                if (looksLikeCode(commentText, isBlockComment)) {
-                    context.report({
-                        node,
-                        messageId: 'commentedCode',
-                        data: {
-                            lines: String(lines),
-                        },
-                        suggest: [
-                            {
-                                messageId: 'removeCode',
-                                fix: (fixer) => {
-                                    try {
-                                        return fixer.remove(node);
-                                    }
-                                    catch {
-                                        return null;
-                                    }
-                                },
-                            },
-                            {
-                                messageId: 'useVersionControl',
-                                fix: () => null,
-                            },
-                        ],
-                    });
-                }
-            }
-            catch {
-                return;
-            }
-        }
-        return {
-            Program() {
-                const comments = sourceCode.getAllComments();
-                const groupedComments = [];
-                let currentGroup = [];
-                for (let i = 0; i < comments.length; i++) {
-                    const comment = comments[i];
-                    const commentText = comment.value || '';
-                    const isBlockComment = comment.type === 'Block';
-                    if (looksLikeCode(commentText, isBlockComment)) {
-                        currentGroup.push(comment);
-                    }
-                    else {
-                        if (currentGroup.length > 0) {
-                            groupedComments.push([...currentGroup]);
-                            currentGroup = [];
-                        }
-                    }
-                }
-                if (currentGroup.length > 0) {
-                    groupedComments.push(currentGroup);
-                }
-                groupedComments.forEach((group) => {
-                    if (group.length === 1) {
-                        checkComment(group[0]);
-                    }
-                    else {
-                        const firstComment = group[0];
-                        const totalLines = group.reduce((sum, comment) => {
-                            const commentText = comment.value || '';
-                            return sum + countCommentLines(commentText);
-                        }, 0);
-                        if (totalLines >= minLines) {
-                            context.report({
-                                node: firstComment,
-                                messageId: 'commentedCode',
-                                data: {
-                                    lines: String(totalLines),
-                                },
-                                suggest: [
-                                    {
-                                        messageId: 'removeCode',
-                                        fix: (fixer) => {
-                                            try {
-                                                return fixer.removeRange([
-                                                    group[0].range[0],
-                                                    group[group.length - 1].range[1],
-                                                ]);
-                                            }
-                                            catch {
-                                                return null;
-                                            }
-                                        },
-                                    },
-                                    {
-                                        messageId: 'useVersionControl',
-                                        fix: () => null,
-                                    },
-                                ],
-                            });
-                        }
-                    }
-                });
-            },
-        };
-    },
-});
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noCommentedCode=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");function looksLikeCode(comment,isBlockComment){let text=comment;if(isBlockComment){text=text.replace(/^\s*\/\*+/,"").replace(/\*+\/\s*$/,"");text=text.split("\n").map(line=>line.replace(/^\s*\*+\s*/,"")).join("\n")}else{text=text.split("\n").map(line=>line.replace(/^\s*\/\/+\s*/,"")).join("\n")}const lines=text.split("\n").map(line=>line.trim()).filter(line=>line.length>0);if(lines.length===0){return false}const codePatterns=[/^(const|let|var|function|class|if|for|while|return|import|export)\s+/,/^[a-zA-Z_$][a-zA-Z0-9_$]*\s*[=:]\s*/,/^[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,/^[{}[\]]/];let codeLikeLines=0;for(const line of lines){if(/^(TODO|FIXME|HACK|XXX)/i.test(line)){continue}for(const pattern of codePatterns){if(pattern.test(line)){codeLikeLines++;break}}}return codeLikeLines>0}function countCommentLines(comment){if(!comment)return 0;const newlineCount=(comment.match(/\n/g)||[]).length;return newlineCount>0?newlineCount+1:1}exports.noCommentedCode=(0,eslint_devkit_2.createRule)({name:"no-commented-code",meta:{type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/no-commented-code.md",description:"Detects commented-out code blocks"},hasSuggestions:true,messages:{commentedCode:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.WARNING,issueName:"Commented code",description:"Commented-out code detected ({{lines}} lines)",severity:"LOW",fix:"Remove commented code or use version control for history",documentationLink:"https://rules.sonarsource.com/javascript/RSPEC-125/"}),removeCode:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Remove Code",description:"Remove commented code block",severity:"LOW",fix:"Delete the commented code block",documentationLink:"https://rules.sonarsource.com/javascript/RSPEC-125/"}),useVersionControl:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Git",description:"Use version control for code history",severity:"LOW",fix:"Delete commented code and use git history instead",documentationLink:"https://git-scm.com/docs/git-log"})},schema:[{type:"object",properties:{ignoreSingleLine:{type:"boolean",default:false,description:"Ignore single-line comments"},ignoreInTests:{type:"boolean",default:true,description:"Ignore comments in test files"},minLines:{type:"number",default:1,minimum:1,description:"Minimum lines of commented code to trigger"}},additionalProperties:false}]},defaultOptions:[{ignoreSingleLine:false,ignoreInTests:true,minLines:1}],create(context,[options={}]){const{ignoreSingleLine=false,ignoreInTests=true,minLines=1}=options||{};const filename=context.filename;const isTestFile=ignoreInTests&&/\.(test|spec)\.(ts|tsx|js|jsx)$/.test(filename);if(isTestFile){return{}}const sourceCode=context.sourceCode;function checkComment(node){try{const commentText=node.value||"";const isBlockComment=node.type==="Block";const lines=countCommentLines(commentText);if(ignoreSingleLine&&lines===1&&!isBlockComment){return}if(lines<minLines){return}if(looksLikeCode(commentText,isBlockComment)){context.report({node,messageId:"commentedCode",data:{lines:String(lines)},suggest:[{messageId:"removeCode",fix:fixer=>{try{return fixer.remove(node)}catch{return null}}},{messageId:"useVersionControl",fix:()=>null}]})}}catch{return}}return{Program(){const comments=sourceCode.getAllComments();const groupedComments=[];let currentGroup=[];for(let i=0;i<comments.length;i++){const comment=comments[i];const commentText=comment.value||"";const isBlockComment=comment.type==="Block";if(looksLikeCode(commentText,isBlockComment)){currentGroup.push(comment)}else{if(currentGroup.length>0){groupedComments.push([...currentGroup]);currentGroup=[]}}}if(currentGroup.length>0){groupedComments.push(currentGroup)}groupedComments.forEach(group=>{if(group.length===1){checkComment(group[0])}else{const firstComment=group[0];const totalLines=group.reduce((sum,comment)=>{const commentText=comment.value||"";return sum+countCommentLines(commentText)},0);if(totalLines>=minLines){context.report({node:firstComment,messageId:"commentedCode",data:{lines:String(totalLines)},suggest:[{messageId:"removeCode",fix:fixer=>{try{return fixer.removeRange([group[0].range[0],group[group.length-1].range[1]])}catch{return null}}},{messageId:"useVersionControl",fix:()=>null}]})}}})}}}});

package/src/rules/conventions/no-console-spaces.js

@@ -1,113 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.noConsoleSpaces = void 0;
-const eslint_devkit_1 = require("@interlace/eslint-devkit");
-const eslint_devkit_2 = require("@interlace/eslint-devkit");
-exports.noConsoleSpaces = (0, eslint_devkit_1.createRule)({
-    name: 'no-console-spaces',
-    meta: {
-        type: 'problem',
-        docs: {
-            url: 'https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/no-console-spaces.md',
-            description: 'Prevent leading/trailing space between console.log parameters',
-        },
-        fixable: 'code',
-        hasSuggestions: true,
-        messages: {
-            noConsoleSpaces: (0, eslint_devkit_2.formatLLMMessage)({
-                icon: eslint_devkit_2.MessageIcons.WARNING,
-                issueName: 'Console Spaces',
-                description: 'Remove leading/trailing spaces in console method parameters',
-                severity: 'MEDIUM',
-                fix: 'Remove spaces from console method arguments',
-                documentationLink: 'https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-console-spaces.md',
-            }),
-        },
-        schema: [],
-    },
-    defaultOptions: [],
-    create(context) {
-        const consoleMethods = new Set([
-            'log',
-            'debug',
-            'info',
-            'warn',
-            'error',
-            'table',
-            'trace',
-            'group',
-            'groupCollapsed',
-        ]);
-        function isInAllowedContext() {
-            return false;
-        }
-        function isConsoleMethodCall(node) {
-            if (node.callee.type === 'MemberExpression' &&
-                node.callee.object.type === 'Identifier' &&
-                node.callee.object.name === 'console' &&
-                node.callee.property.type === 'Identifier' &&
-                consoleMethods.has(node.callee.property.name)) {
-                return true;
-            }
-            return false;
-        }
-        function getConsoleMethodName(node) {
-            if (node.callee.type === 'MemberExpression' &&
-                node.callee.property.type === 'Identifier') {
-                return node.callee.property.name;
-            }
-            return 'console';
-        }
-        function hasLeadingOrTrailingSpaces(text) {
-            const trimmed = text.trim();
-            return trimmed.length > 0 && /^\s|\s$/.test(text);
-        }
-        function hasLeadingOrTrailingSpacesInTemplate(text) {
-            return /^\s|\s$/.test(text);
-        }
-        return {
-            CallExpression(node) {
-                if (isConsoleMethodCall(node) && !isInAllowedContext()) {
-                    for (const arg of node.arguments) {
-                        if (arg.type === 'Literal' && typeof arg.value === 'string') {
-                            if (hasLeadingOrTrailingSpaces(arg.value)) {
-                                context.report({
-                                    node: arg,
-                                    messageId: 'noConsoleSpaces',
-                                    data: {
-                                        method: getConsoleMethodName(node),
-                                        arg: arg.value,
-                                    },
-                                    fix(fixer) {
-                                        const trimmed = arg.value.trim();
-                                        return fixer.replaceText(arg, `'${trimmed}'`);
-                                    },
-                                });
-                            }
-                        }
-                        else if (arg.type === 'TemplateLiteral') {
-                            let hasSpacesInTemplate = false;
-                            for (const quasi of arg.quasis) {
-                                if (hasLeadingOrTrailingSpacesInTemplate(quasi.value.raw)) {
-                                    hasSpacesInTemplate = true;
-                                    break;
-                                }
-                            }
-                            if (hasSpacesInTemplate) {
-                                context.report({
-                                    node: arg,
-                                    messageId: 'noConsoleSpaces',
-                                    data: {
-                                        method: getConsoleMethodName(node),
-                                        arg: 'template literal with spaces',
-                                    },
-                                    fix: null,
-                                });
-                            }
-                        }
-                    }
-                }
-            },
-        };
-    },
-});
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noConsoleSpaces=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");exports.noConsoleSpaces=(0,eslint_devkit_1.createRule)({name:"no-console-spaces",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/no-console-spaces.md",description:"Prevent leading/trailing space between console.log parameters"},fixable:"code",hasSuggestions:true,messages:{noConsoleSpaces:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Console Spaces",description:"Remove leading/trailing spaces in console method parameters",severity:"MEDIUM",fix:"Remove spaces from console method arguments",documentationLink:"https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-console-spaces.md"})},schema:[]},defaultOptions:[],create(context){const consoleMethods=new Set(["log","debug","info","warn","error","table","trace","group","groupCollapsed"]);function isInAllowedContext(){return false}function isConsoleMethodCall(node){if(node.callee.type==="MemberExpression"&&node.callee.object.type==="Identifier"&&node.callee.object.name==="console"&&node.callee.property.type==="Identifier"&&consoleMethods.has(node.callee.property.name)){return true}return false}function getConsoleMethodName(node){if(node.callee.type==="MemberExpression"&&node.callee.property.type==="Identifier"){return node.callee.property.name}return"console"}function hasLeadingOrTrailingSpaces(text){const trimmed=text.trim();return trimmed.length>0&&/^\s|\s$/.test(text)}function hasLeadingOrTrailingSpacesInTemplate(text){return/^\s|\s$/.test(text)}return{CallExpression(node){if(isConsoleMethodCall(node)&&!isInAllowedContext()){for(const arg of node.arguments){if(arg.type==="Literal"&&typeof arg.value==="string"){if(hasLeadingOrTrailingSpaces(arg.value)){context.report({node:arg,messageId:"noConsoleSpaces",data:{method:getConsoleMethodName(node),arg:arg.value},fix(fixer){const trimmed=arg.value.trim();return fixer.replaceText(arg,`'${trimmed}'`)}})}}else if(arg.type==="TemplateLiteral"){let hasSpacesInTemplate=false;for(const quasi of arg.quasis){if(hasLeadingOrTrailingSpacesInTemplate(quasi.value.raw)){hasSpacesInTemplate=true;break}}if(hasSpacesInTemplate){context.report({node:arg,messageId:"noConsoleSpaces",data:{method:getConsoleMethodName(node),arg:"template literal with spaces"},fix:null})}}}}}}}});