Как добавить gitignore в visual studio code

Обновлено: 05.07.2024

Visual Studio Code отличный выбор для начинающего программиста, имеет необходимый минимум:

неплохую документацию
автодополнение кода (с использованием IntelliSense)
подсветка синтаксиса
встроенный отладчик
расширение функционала за счет плагинов
управление системой контроля версий git
кроссплатформенный
бесплатный, с открытым исходным кодом

Также редактор адаптирован для Веб-разработки и вполне подойдет для серьезных проектов как основной инструмент редактирования кода.

Установка¶

Linux¶

Для Linux существуют два типа пакетов, самых популярных форматов, rpm и deb.

Установка в Ubuntu/Debian:

Fedora > 22 версии:

После установки можно запустить редактор следующей командой:

Пакетный менеджер Nix работает на любом Linux дистрибутиве, содержит богатую базу уже готовых пакетов, в том числе и vscode.

Установка пакетного менеджера:

Плагины¶

Редактор имеет возможность расширения функционала за счет плагинов и удобный интерфейс их установки, доступный по нажатию кнопки:

Из списка можно выбрать любой плагин и установить, после чего он применит свои настройки к редактору.

Расширения можно искать введя название или ключевые слова в строке поиска, например Python .

Python¶

После установки плагина Python нам становятся доступны многие функции:

Автодополнение кода
Проверка синтаксиса
Отладка
Подсказки
Переход к определению функции, класса и прочее

Автодополнение¶

Работает при наборе по нажатию Ctrl + Space .

Проверка синтаксиса¶

Показывает ошибки в коде:

Работает если установлены Python пакеты Pylint , Pep8 или Flake8 .

Отладка¶

Встроенный в редактор отладчик позволяет отлаживать код визуально, устанавливать точки останова мышкой и просматривать переменные в отдельном окне. Это похоже на отладку в различных IDE, таких как QtCreator или Wingware.

Также избавляет программиста писать мучительные строки типа printf или import pdb;pdb.set_trace(); .

Настройки¶

Настройки хранятся в формате JSON и доступны из меню File->Preferences->User Settings .

Шрифт¶

Шрифт задается в настройках File->Preferences->User Settings :

Автодополнение через <Tab>¶

Более привычно дополнять код по клавише <Tab> . Для этого необходимо открыть настройки пользователя File->Preferences->User Settings и прописать опцию editor.tabCompletion :

Открываем командную строку Ctrl + Shift + P

Вводим команду Configure Language

Меняем локаль на нужную, например ru :

Цветовое оформление задается в настройках File->Preferences->Color Theme .

Умеет подсвечивать изменения в файлах с предыдущего коммита, выполнять команды git и отслеживать состояние, например какая текущая ветка.

Python скрипты¶

Visual Studio Code требует для отладки открывать не просто файл, а директорию. Это необходимо, чтобы в этом каталоге сохранить локальные настройки редактора. Такая директория будет считаться проектом для редактора.

Для примера, создадим директорию hello1 и откроем в редакторе File->Open Folder. .

Создадим в этой директории файл myapp.py :

Для запуска приложения, заходим в режим отладки по нажатию на кнопку:

Пока у нас нет никаких настроек отладки/запуска проекта, но при первом запуске редактор предложит их выбрать из существующих шаблонов.

Шаблон Python создает настройки в файле launch.json в локальной директории, которые выглядят примерно так:

Это универсальный шаблон, который добавляет несколько вариантов запуска приложений. Нас будет интересовать первый вариант Python , просто запускающий python файл.

Запущенное приложение останавливается на первой строчке, что позволяет нам продолжать выполнение программы по шагам.

После выполнения второй строки, интерпретатор выдаст ошибку ImportError: No module named pyramid.config . Это происходит из-за того что в нашем Python окружении не установлен модуль pyramid .

Решить эту проблему можно двумя способами:

Установить Pyramid в глобальное окружение.

Создать виртуальное окружение, установить в нем Pyramid и прописать его в настройках Visual Studio Code.

Создаем виртуальное окружение:

Прописываем путь до виртуального окружения в настройках проекта Visual Studio Code (файл launch.json ):

Добавим файл .gitignore :

Создаем первый коммит

Для создания коммита требуется ввести комментарий и нажать на кнопку в виде галочки.

Прописываем путь до гитхаба в нашем проекте, при помощи команды Git Easy:Add Orign

Отправляем изменения на GitHub , при помощи команды Git Easy:Push Current Branch to Origin

Для того чтобы проверка синтаксиса заработала, необходимо создать файл .vscode/settings.json и переопределить в нем глобальные настройки для нашего проекта:

Pyramid¶

Фреймворк Pyramid имеет несколько стартовых шаблонов, которые нужны для того, чтобы не начинать писать код с нуля. Рассмотрим как создать шаблон с БД sqlite + SQLAlchemy и настроить его в Visual Studio Code.

Для начала создадим директорию hello2 и виртуальное окружение hello2_env :

После установки Pyramid , в окружении появляется команда pcreate . С ее помощью создадим проект по шаблону:

Устанавливаем его как Python пакет:

Но так-как БД еще не создана, отображается страница с подсказкой как ее инициализировать:

Не все файлы, созданные или обновленные в коде, следует фиксировать в Git. Временные файлы из среды разработки, тестовые выходные данные и журналы — все это примеры файлов, которые создаются, но не являются частью базы кода. Настройка файлов, отслеживаемых Git с помощью функции gitignore .

Из этого руководства вы узнаете, как выполнить следующие задачи:

Использование gitignore для предотвращения отслеживания файлов
Пропускать файлы только в вашей системе
Пропускать файлы во всех репозиториев в системе
Игнорировать изменения в зафиксированных файлах

Использование gitignore для предотвращения отслеживания файлов

Создайте gitignore -файл в репозитории Git, чтобы не допустить размещения в Git нежелательных файлов. Share . gitignore в ветви по умолчанию в репозитории. Вы и ваша команда можете обновить файл, чтобы изменить типы файлов, которые следует игнорировать.

Создание. gitignore

Если вы используете Visual Studio 2019 версии 16.8 или выше, опробуйте систему управления версиями Git. Узнайте, чем интерфейс Git отличается от Team Explorer, на странице наглядного сравнения.

Visual Studio автоматически создает файл . gitignore в репозитории при создании нового репозитория для проекта.

Скачайте файл template. gitignore для типа проекта и настройте его в соответствии с вашими потребностями. Если проект не соответствует шаблону, можно создать пустой . gitignore из командной строки. Перейдите в репозиторий Git и выполните одну из следующих команд, используя сведения о репозитории:

Windows

Linux и macOS

Git применяет . gitignore к папке и вложенным папкам, где она находится. Мы рекомендуем разместить . gitignore в корневой папке репозитория, чтобы избежать путаницы.

Настройка. gitignore

Измените gitignore , чтобы включить в репозиторий типы файлов, пути и шаблоны файлов. Git начинает пропускать эти файлы сразу после обновления . gitignore. Если другим пользователям вашей команды требуется один и тот же набор игнорируемых файлов, обязательно зафиксируйте изменения.

чтобы изменить файл gitignore для репозитория, перейдите в представление Параметры в Team Explorer, а затем выберите репозиторий Параметры. Выберите изменить для gitignore.

Используйте текстовый редактор, например следующий пример, в котором используется vim:

Каждая строка в . gitignore исключает файл или набор файлов, соответствующих шаблону. Полный синтаксис gitignore очень гибок. Ниже приведены некоторые примеры наиболее распространенных записей.

Windows users: все пути к файлам в gitignore -файле используют разделитель косой черты, а не обратную косую черту.

Пропускать файлы только в вашей системе

Ваш gitignore является общим для участников команды, так как файл зафиксирован и отправлен в репозиторий Git. Чтобы исключить файлы только в системе, измените файл . git/info/Exclude в локальном репозитории. Изменения в этом файле не являются общими для других пользователей. Они применяются только к файлам в этом репозитории. Для этого файла используется тот же синтаксис , что и в файле. gitignore.

Пропускать файлы во всех репозиториев в системе

Настройте Global . gitignore для использования во всех репозиториев в системе с помощью программы командной строки , как показано в следующем примере:

Этот подход удобен для игнорирования целых типов файлов, которые вы не хотите зафиксировать, например скомпилированных двоичных файлов.

Игнорировать изменения в зафиксированных файлах

Временно игнорировать изменения

Во время разработки удобно отключить отслеживание изменений файлов в файле, зафиксированном в репозитории Git. Этот подход удобен при настройке параметров или файлов конфигурации, которые являются частью источника проекта, для собственной рабочей среды.

Возобновление отслеживания файлов с помощью следующей команды:

Вместо этого можно использовать следующие параметры. Эти параметры предназначены главным образом для отметки файлов, которые не должны изменяться разработчиками.

Чтобы отключить отслеживание изменений, выполните следующие действия.

Чтобы возобновить отслеживание изменений, выполните следующие действия.

Безвозвратная отмена отслеживания файла

Если файл уже записан в Git, он .gitignore не применяется. Git продолжит отслеживание изменений в этом файле.

Если вы хотите отключить отслеживание файла, необходимо явно указать git, который он должен удалить из отслеживания. Следуя этим указаниям, файл останется в локальном рабочем каталоге, но не будет относиться к записи в Git.

Добавьте файл в .gitignore .

Выполните следующую команду:

Зафиксируйте удаление файла и обновленный файл . gitignore в репозитории.

Это правильный путь? не могу ли я просто запустить проект из vscode, а затем загрузить его на свой git?

ИЗМЕНИТЬ 2020:

Теперь вы можете сделать это прямо внутри vscode! просто выполните следующие действия:

1- Откройте папку с новым проектом с помощью vscode

2- щелкните меню управления источником на боковой панели (или нажмите Ctrl + Shift + G)

3- Нажмите «Опубликовать в github».

4- Оттуда просто войдите и следуйте инструкциям, и все готово.

Ответ @ Debu подробно описывает каждый шаг, так что вы можете перейти к нему

это правильный путь. и легко сделать с помощью графического интерфейса. @ifconfig извините, что это была опечатка, я имел в виду "старт", я ее исправил

Что ж, это довольно просто.

Откройте свой локальный проект.

Добавить README.md файл (если вам еще нечего добавить)

Нажмите на Publish on Github

Выбирайте как хотите

Выберите файлы, которые вы хотите включить в первую фиксацию.
Примечание. Если вы не выберете файл или папку, они будут добавлены в .gitignore файл.

Тебе хорошо идти. он опубликован.

PS Если бы это был ты впервые. Вам будет предложено ввести ваши учетные данные Github, заполните их, и все готово. Это опубликовано.

Вот подробные шаги, необходимые для этого.

Существующие команды можно просто запустить через терминал CLI VS-CODE. Подразумевается, что Git установлен в системе, настроен с желаемым именем пользователя и идентификатором электронной почты.

1) Перейдите в локальный каталог проекта и создайте локальный репозиторий git:

3) Теперь вам нужно зайти в свою учетную запись GitHub и создать новый репозиторий. Исключить создание файлов README.md, .gitIgnore. Также не добавляйте лицензию в репо. Иногда эти настройки вызывают проблемы при нажатии.

4) Скопируйте ссылку на этот только что созданный репозиторий GitHub.

5) Вернитесь в терминал в VS-CODE и введите последовательно следующие команды:

Примечание. Если локальная учетная запись git пытается подключиться к GitHub впервые, вам может потребоваться ввести учетные данные для GitHub в отдельном окне.

Интеграция Git с Visual Studio Code

В веб-разработке Visual Studio Code (VS Code) стал одним из самых популярных редакторов. Он приобрел такую популярность благодаря множеству встроенных функций, среди которых есть и интеграция системы управления версиями Git. Использование Git через VS Code может сделать ваш рабочий процесс более эффективным и надежным.

В этом мануале мы расскажем, как использовать интеграцию системы управления версиями Git в VS Code.

Требования

Установка Git (инструкции вы найдете в мануале Разработка проектов с открытым исходным кодом: начало работы с Git).
Последняя версия Visual Studio Code.

1: Вкладка Source Control

Откройте Visual Studio Code и запустите встроенный терминал. Вы можете открыть его с помощью сочетания клавиш CTRL+` (в Linux, macOS или Windows).

В терминале создайте каталог для нового проекта и перейдите в него:

Затем создайте репозиторий Git:

Есть и другой способ сделать это в Visual Studio Code: в левой панели нужно открыть вкладку Source Control (значок выглядит как развилка). Затем выберите Open Folder – и в текущем каталоге откроется файловый менеджер. Выберите нужный каталог проекта и нажмите Open.

Затем выберите Initialize Repository.

После этого проверьте свою файловую систему, и вы увидите, что она включает каталог .git. Чтобы убедиться в этом, с помощью терминала перейдите в каталог проекта и запросите все его содержимое:

Вы увидите созданный каталог .git:

После инициализации репозитория создайте файл index.html.

После этого в панели Source Control вы увидите новый файл с буквой U рядом с ним. Символ U означает, что файл неотслеживаемый (untracked) – этот новый или отредактированный файл еще не добавлен в репозиторий.

Теперь вы можете нажать кнопку с плюсом (+) рядом с файлом index.html, чтобы отслеживать файл по репозиторию.

После добавления файла в репозиторий буква U рядом с файлом изменится на A. Символ A (added) представляет новый файл, который был добавлен в репозиторий.

После этого вы увидите, что у вас нет изменений, ожидающих проверки и сохранения.

Затем добавьте немного кода в файл index.html.

Для создания скелета HTML5 в VS Code можно использовать плагин Emmet, нажав клавиши !+Tab. Добавьте что-нибудь в <body>, например, заголовок <h1>, и сохраните его.

В панели Source Control вы увидите, что ваш файл изменился. Рядом с ним будет отображаться буква M (modified), которая указывает на отредактированный файл

Это изменение можно также сохранить через коммит.

Теперь, когда вы знакомы с панелью Source Control, мы можем переходить к индикаторам gutter.

2: Интерпретация индикаторов gutter

На этом этапе мы рассмотрим индикаторы gutter, или индикаторы желоба. Желоб – это узкая область, которая находится между индикатором строк и кодом.

Если ранее вы использовали сворачивание кода, то знаете, что значки разворачивания и сворачивания кода расположены именно в области желоба.

Начнем с внесения небольших изменений в файл index.html – можно, например, изменить контент в теге <h1>. После этого вы увидите синюю вертикальную метку в желобе напротив измененной строки. Вертикальная синяя метка означает, что соответствующая строка кода была отредактирована.

Теперь попробуйте удалить одну из строк в разделе <body> вашего файла index.html. Обратите внимание на красный треугольник в желобе. Красный треугольник указывает на строку или группу строк, которые были удалены.

Теперь перейдите к нижней части раздела <body> и добавьте туда новую строку кода. Обратите внимание на вертикальную зеленую полосу – она указывает на добавленную строку кода.

3: Определение отличий между версиями файла

VS Code также может сравнивать версии кода. Как правило, для этого нужно загружать специальный инструмент, но в VS Code есть встроенная функция, и она поможет вам работать более эффективно.

Чтобы просмотреть отличия между версиями файла, откройте панель управления исходным кодом Source Control и дважды кликните на измененный файл. В нашем случае нужно дважды кликнуть на файл index.html. На экране появится сравнение текущей версии файла (слева) и его предыдущей версии (справа).

4: Работа с ветками

В нижней панели вы можете создавать и переключать ветки. Если вы посмотрите в самый нижний левый угол редактора, вы увидите значок управления версиями (он выглядит как развилка), рядом с которым будет указано имя текущей рабочей ветки (например, master).

Чтобы создать нову ветку, кликните на имя текущей ветки. На экране должно появиться меню, дающее вам возможность создать новую ветку.

Для примера создайте новую ветку под названием test.

Теперь внесите изменения в свой файл index.html, чтобы обозначить, что вы находитесь в новой ветке: например добавьте текст «this is the new test branch».

Сохраните эти изменения в ветке test с помощью коммита. Затем снова кликните на имя ветки в левом нижнем углу, чтобы вернуться к ветке master.

После переключения на ветку master вы заметите, что текст «this is the new test branch», сохраненный в ветке test, не присутствует в вашем файле.

5: Работа с удаленными репозиториями

В этом руководстве мы не будем подробно останавливаться на удаленных репозиториях.

С помощью панели управления Source Control у вас есть доступ к удаленным репозиториям. Если вы работали с такими репозиториями ранее, вы найдете здесь знакомые команды, такие как pull, sync, publish, stash и т.п.

6: Установка расширений

VS Code не только предоставляет множество встроенных функций для Git, но также позволяет установить несколько очень популярных расширений для расширения набора функций.

Git Blame

Расширение Git Blame предоставляет возможность просматривать информацию состояния для текущей выбранной строки.

Название этого расширения может прозвучать пугающе, но Git Blame не предполагает, что вы будете буквально винить или стыдить кого-то в изменении кода: практичность расширения заключается в том, что оно позволяет выяснить, кому можно задать вопросы по определенным фрагментам кода.

Git History

Просматривать текущие изменения, отслеживать разницу между версиями и управлять ветками можно и с помощью встроенных функций VS Code, однако они не предоставляют подробной истории Git. Расширение Git History решает эту проблему.

Это расширение позволяет тщательно изучить историю файла, автора, ветки. Чтобы активировать окно Git History, нужно кликнуть на файл правой кнопкой мыши и выбрать Git: View File History.

Кроме того, вы можете сравнивать ветки и коммиты, создавать ветки из коммитов и многое другое.

Git Lens

Git Lens расширяет возможности Git, встроенные в Visual Studio Code. Этот плагин помогает с первого взгляда определить авторство кода с помощью аннотаций Git blame и линзы кода, перемещаться по репозиториям Git и исследовать их, получать ценную информацию с помощью команд сравнения и многое другое.

Расширение Git Lens – одно из самых популярных и мощных. В большинстве случаев его функциональность может заменить каждое из двух предыдущих расширений.

Это расширение предоставляет множество функций, позволяющих получить историю Git, в том числе легкий доступ к множеству опций (отображение истории файлов, просмотр различий между версиями и многое другое). Чтобы открыть эти параметры, вы можете кликнуть на текст в строке состояния (он содержит информацию об авторе, который редактировал строку кода, и о времени последней редакции).

Это расширение обладает множеством функций, и вам, вероятно, потребуется время, чтобы разобраться со всеми ними.

Заключение

В этом мануале вы узнали, как использовать интеграцию системы управления версиями Git с VS Code.

VS Code «из коробки» предлагает многие функции, для которых ранее требовалась загрузка отдельного инструмента.

Читайте также: