1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/JanKinCai-vscodefileheader

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
README-zh_CN.md 8.8 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 25.11.2024 23:05 1ed415b

VSCode FileHeader

Markeetplace Badge Install Download Size BSD License Badge

中文文档 | 英文文档

Автоматически согласно шаблону вставляет содержимое в header и body. Если вам нравится этот плагин, пожалуйста, поставьте лайк 👍~

Установка

1. ctrl + shift + x
2. Search VSCodeFileHeader

или

1. ctrl + p
2. ext install jankincai.vscodefileheader

Функции

  • Автоматическое обновление времени и автора.
  • Пользовательские шаблоны (header/body).
  • Встроенные шаблоны на разных языках.
  • Конфигурирование отображения шаблонов по расширению файла.
  • Фильтрация файлов, в которые не нужно вставлять header/body.
  • Поддержка переменных vscode (https://code.visualstudio.com/docs/editor/variables-reference).
  • Удаленная синхронизация шаблонов (требуется установка git).

Команды

Откройте командную строку vscode с помощью ctrl + shift + p, затем введите File Header, чтобы увидеть следующие команды:

  • File Header: Add header comment: редко используется, только если ctrl+s отключено.
  • File Header: Crate template: необходимо настроить путь к пользовательскому шаблону, чтобы создать новый шаблон.
  • File Header: Open template: должен быть открыт файл, чтобы открыть соответствующий файл шаблона для редактирования; обычно не рекомендуется изменять файлы шаблонов по умолчанию напрямую.
  • File Header: Sync template: необходимо установить удаленный адрес git для синхронизации шаблонов (git clone xxx).

Пример

example

custom-example

Дополнительные примеры

Языки

  • ActionScript
  • AppleScript
  • ASP
  • Batch
  • C
  • C#
  • C++
  • Clojure
  • CSS
  • D
  • Dart
  • Erlang
  • Go
  • Haskell
  • HTML
  • Java
  • JavaScript
  • LaTeX
  • Lisp
  • Lua
  • Matlab
  • Objective-C
  • OCaml
  • Pascal
  • Perl
  • PHP
  • Python
  • R
  • Ruby
  • Scala
  • SCSS
  • ShellScript
  • SQL
  • TypeScript
  • Vue
  • XML
  • YAML

Простая конфигурация

{
    "fileheader.author": "JanKinCai",
}

Расширенная конфигурация

{
    # Настройка имени пользователя (автор)
    "fileheader.author": "Your name",

    # Включить ли body, по умолчанию false
    "fileheader.body": true,

    # Открыть файл для вставки содержимого, по умолчанию false
    "fileheader.open": true,

    # Сохранить файл для вставки содержимого, по умолчанию true
    "fileheader.save": true,

    # Найти максимальное количество строк для заголовка, по умолчанию 10
    "fileheader.header_max_line": 10,

    # Формат времени, по умолчанию YYYY-MM-DD HH:mm:ss
    # moment.js
    "fileheader.dateformat": "YYYY-MM-DD HH:mm:ss",

    # Установить сопоставление расширений файлов с шаблонами
    "fileheader.file_suffix_mapping": {
        ".pyx": "Python",
        "jkc-*.h": "H"
    },

    # Отфильтровать файлы, которые не следует вставлять в шаблон
    "fileheader.ignore": [
        "*.txt",             
        "test.py",           
        "test/"               
    ]
}

Пользовательский шаблон (добавление электронной почты)

Пользовательский шаблон Header template/header/Python.tmpl:

# @Author: {{author}}
# @Date:   {{create_time}}
# @Email:  {{email}}
# @Last Modified by:   JanKinCai
# @Last Modified time: 2021-04-25 01:48:27

Пользовательский шаблон Body template/body/Python.tmpl:



def main():
    print("Hello, World!")


if __name__ == "__main__":
    main()

Настройка пользовательского шаблона:

{
    # Путь к шаблону (абсолютный путь)
    "fileheader.custom_template_path": "xxx/template/",
    "fileheader.other_config": {
        "email": "Ваш email",
    }
    # Сопоставление расширений файлов с шаблонами
    "fileheader.file_suffix_mapping": {
        ".py": "Python"
    },
}
  • Подробнее о настройке пользовательских шаблонов см. здесь

Расширенный пользовательский шаблон (полностью настраиваемый)

Пользовательский шаблон header template/header/JKC.tmpl:

# @Name: {{name}}
# @Time: {{last_modified_time}}
# @Last Modified Author: {{name}}
# @Last Modified Time: {{last_modified_time}}

Пользовательский шаблон body template/body/JKC.tmpl:


Конфигурация:

{
    "fileheader.is_header_exists": "@Name:", # Используется для обнаружения заголовка, чтобы избежать дублирования
    # Используется для определения обновления последнего автора модификации
    "fileheader.update_last_modified_time_flags": "@Last Modified Time:",
    # Используется для определения времени последней модификации
    "fileheader.update_last_modified_author_flags": "@Last Modified Author:",
    "fileheader.other_config": {
        "name": "jankincai",
    },
    "fileheader.file_suffix_mapping": {
        ".jkc": "JKC"
    },   
}

Переменные vscode

https://code.visualstudio.com/docs/editor/variables-reference

Пользовательский заголовок template/header/Python.tmpl:

# @Author: {{author}}
# @Date:   {{create_time}}
# @Last Modified by:   {{last_modified_by}}
# @Last Modified time: {{last_modified_time}}
# {{workspaceFolder}}
# {{workspaceFolderBasename}}
# {{file}}
# {{relativeFile}}
#
``` ### Шаблон для удалённой синхронизации (требуется установка git)

```python
{
    "fileheader.custom_template_path": "xxx/template/",

    # Настройка SSH https://jdblischak.github.io/2014-09-18-chicago/novice/git/05-sshkeys.html
    # "fileheader.remote": "git@github.com:caizhengxin/fileheader-template.git"

    "fileheader.remote": "https://github.com/caizhengxin/fileheader-template.git"
}

Разработчик

$ git clone https://github.com/caizhengxin/vscodefileheader.git
$ code vscodefileheader
$ f5 # Войти в режим разработчика или отладки

Создание и публикация пакета установки

# Каталог node_modules не должен быть исключён .vscodeignore.
$ sudo npm i vsce -g
$ vsce login jankincai
$ vsce package
$ vsce publish

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/JanKinCai-vscodefileheader.git
git@api.gitlife.ru:oschina-mirror/JanKinCai-vscodefileheader.git
oschina-mirror
JanKinCai-vscodefileheader
JanKinCai-vscodefileheader
master