OBKoro1/koro1FileHeader

LastEditTime不更新

Closed this issue · 4 comments

描述bug(必填)

自定义语言注释时,由于head中有换行符,导致LastEditTime不能自动更新。

注释设置(必填):

VsCode设置:

{
    "security.workspace.trust.untrustedFiles": "open",
    "go.toolsManagement.autoUpdate": true,
    "editor.fontLigatures": false,
    "fileheader.configObj": {
        "createFileTime": true,
        "language": {
            "python": {
                "head": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-", // 不能换行,换行则不能自动更新时间
                "middle": "# @",
                "end": "",
                // 函数自定义注释符号:如果有此配置 会默认使用
                "functionSymbol": {
                    "head": "\"\"\"", // 统一增加几个*号
                    "middle": ":",
                    "end": "\"\"\"",
                }
            },
        },
        "autoAdd": true,
        "autoAddLine": 100,
        "autoAlready": true, // 是否只让language中自定义的语言支持自动添加
        // "annotationStr": {
        //     "head": "/*",
        //     "middle": " * @",
        //     "end": " */",
        //     "use": false
        // },
        "headInsertLine": {
            "php": 2,
            "sh": 2
        },
        "beforeAnnotation": {
            "文件后缀": "该文件后缀的头部注释之前添加某些内容"
        },
        "afterAnnotation": {
            "文件后缀": "该文件后缀的头部注释之后添加某些内容"
        },
        "specialOptions": {
            "特殊字段": "自定义比如LastEditTime/LastEditors"
        },
        "switch": {
            "newlineAddAnnotation": true
        },
        "supportAutoLanguage": [],
        "prohibitAutoAdd": [
            "json"
        ],
        "folderBlacklist": [
            "node_modules",
            "文件夹禁止自动添加头部注释"
        ],
        "prohibitItemAutoAdd": [
            "项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"
        ],
        "moveCursor": true,
        "dateFormat": "YYYY-MM-DD HH:mm:ss",
        "atSymbol": [
            "@",
            "@"
        ],
        "atSymbolObj": {
            "文件后缀": [
                "头部注释@符号",
                "函数注释@符号"
            ]
        },
        "colon": [
            ": ",
            ": "
        ],
        "colonObj": {
            "文件后缀": [
                "头部注释冒号",
                "函数注释冒号"
            ]
        },
        "filePathColon": "路径分隔符替换",
        "showErrorMessage": false,
        "writeLog": false,
        "wideSame": false,
        "wideNum": 13,
        "functionWideNum": 0,
        "CheckFileChange": false,
        "createHeader": false,
        "useWorker": false,
        "designAddHead": false,
        "headDesignName": "random",
        "headDesign": false,
        "cursorModeInternalAll": {},
        "openFunctionParamsCheck": true,
        "functionParamsShape": [
            "{",
            "}"
        ],
        "functionBlankSpaceAll": {},
        "functionTypeSymbol": "*",
        "typeParamOrder": "type param",
        "customHasHeadEnd": {},
        "throttleTime": 1000,
        "functionParamAddStr": "",
        "NoMatchParams": "no show param"
    },
    "fileheader.customMade": {
        "Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        "LastModifyBy": "",//最后更新的人
        "Description": "", // 介绍文件的作用、文件的入参、出参。
    },
    // 函数注释
    "fileheader.cursorMode": {
        "description": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
    }
}

文件后缀(必填):

py

你得到的注释(必填):

预期的行为(必填):

预期得到的注释/行为:更新文件后,LastEditTime更新

正常工作配置

{
    "security.workspace.trust.untrustedFiles": "open",
    "go.toolsManagement.autoUpdate": true,
    "editor.fontLigatures": false,
    "fileheader.configObj": {
        "createFileTime": true,
        "language": {
            "python": {
                "head": "# -*- coding: utf-8 -*-", // 不能换行,换行则不能自动更新时间
                "middle": "# @",
                "end": "",
                // 函数自定义注释符号:如果有此配置 会默认使用
                "functionSymbol": {
                    "head": "\"\"\"", // 统一增加几个*号
                    "middle": ":",
                    "end": "\"\"\"",
                }
            },
        },
        "autoAdd": true,
        "autoAddLine": 100,
        "autoAlready": true, // 是否只让language中自定义的语言支持自动添加
        // "annotationStr": {
        //     "head": "/*",
        //     "middle": " * @",
        //     "end": " */",
        //     "use": false
        // },
        "headInsertLine": {
            "php": 2,
            "sh": 2
        },
        "beforeAnnotation": {
            "文件后缀": "该文件后缀的头部注释之前添加某些内容"
        },
        "afterAnnotation": {
            "文件后缀": "该文件后缀的头部注释之后添加某些内容"
        },
        "specialOptions": {
            "特殊字段": "自定义比如LastEditTime/LastEditors"
        },
        "switch": {
            "newlineAddAnnotation": true
        },
        "supportAutoLanguage": [],
        "prohibitAutoAdd": [
            "json"
        ],
        "folderBlacklist": [
            "node_modules",
            "文件夹禁止自动添加头部注释"
        ],
        "prohibitItemAutoAdd": [
            "项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"
        ],
        "moveCursor": true,
        "dateFormat": "YYYY-MM-DD HH:mm:ss",
        "atSymbol": [
            "@",
            "@"
        ],
        "atSymbolObj": {
            "文件后缀": [
                "头部注释@符号",
                "函数注释@符号"
            ]
        },
        "colon": [
            ": ",
            ": "
        ],
        "colonObj": {
            "文件后缀": [
                "头部注释冒号",
                "函数注释冒号"
            ]
        },
        "filePathColon": "路径分隔符替换",
        "showErrorMessage": false,
        "writeLog": false,
        "wideSame": false,
        "wideNum": 13,
        "functionWideNum": 0,
        "CheckFileChange": false,
        "createHeader": false,
        "useWorker": false,
        "designAddHead": false,
        "headDesignName": "random",
        "headDesign": false,
        "cursorModeInternalAll": {},
        "openFunctionParamsCheck": true,
        "functionParamsShape": [
            "{",
            "}"
        ],
        "functionBlankSpaceAll": {},
        "functionTypeSymbol": "*",
        "typeParamOrder": "type param",
        "customHasHeadEnd": {},
        "throttleTime": 1000,
        "functionParamAddStr": "",
        "NoMatchParams": "no show param"
    },
    "fileheader.customMade": {
        "Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        "LastModifyBy": "",//最后更新的人
        "Description": "", // 介绍文件的作用、文件的入参、出参。
    },
    // 函数注释
    "fileheader.cursorMode": {
        "description": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
    }
}

建议在fileheader.customMade中加入Path参数,根据作者描述判断一个文件是否有head的标准有四个,其中一个是Path,但是发现你并没有Path这个选项所以自然可能出现无法识别注释从而修改时间的情况

建议在fileheader.customMade中加入Path参数,根据作者描述判断一个文件是否有head的标准有四个,其中一个是Path,但是发现你并没有Path这个选项所以自然可能出现无法识别注释从而修改时间的情况

建议在fileheader.customMade中加入Path参数,根据作者描述判断一个文件是否有head的标准有四个,其中一个是Path,但是发现你并没有Path这个选项所以自然可能出现无法识别注释从而修改时间的情况

非常感谢,我先试试

python 头部两行应该使用该配置来插入:头部注释前面插入内容