Команды Visual Studio Code cli

Обновлено: 01.07.2024

Visual Studio Code – это бесплатный кроссплатформенный текстовый редактор с открытым исходным кодом, разработанный в основном корпорацией Майкрософт. Он использует веб-технологии, такие как JavaScript и CSS, которые помогли создать большую экосистему плагинов, созданных сообществом, для расширения его функциональности на множество различных языков программирования и функций.

В этом руководстве вы установите интерфейс командной строки Visual Studio Code и узнаете, как использовать его для открытия файлов и каталогов, сравнения изменений между файлами и установки расширений.

Предпосылки

Для выполнения этого руководства вам потребуется установить Visual Studio Code. Обратитесь к официальной документации по Настройка Visual Studio Code, чтобы узнать, как установить Code для вашей платформы.

Установка интерфейса командной строки Visual Studio Code

Возможно, вам потребуется установить интерфейс командной строки Visual Studio Code перед его использованием. Для этого сначала запустите обычный графический интерфейс Visual Studio Code. Если вы впервые открываете приложение, на экране по умолчанию будет панель значков слева и вкладка приветствия по умолчанию:

Visual Studio Code предоставляет встроенную команду для установки интерфейса командной строки. Откройте палитру команд Code, набрав Command+Shift+P на Mac или Control+Shift+P на Windows и Linux:

При этом в верхней части окна кода откроется подсказка. Введите команду оболочки в приглашение. Он должен автоматически заполнять правильную команду, которая будет читать Команда оболочки: Установить команду «код» в PATH:

Нажмите клавишу ВВОД, чтобы запустить выделенную команду. Вам может быть предложено ввести учетные данные администратора, чтобы завершить процесс установки.

Теперь у вас установлена команда командной строки кода.

Убедитесь, что установка прошла успешно, запустив код с флагом --version:

Если выходные данные содержат строку версии, вы успешно установили интерфейс командной строки Visual Studio Code. Следующие несколько разделов покажут вам несколько способов его использования.

Открытие файлов с помощью команды кода

Выполнение команды кода с одним или несколькими именами файлов откроет эти файлы в графическом интерфейсе Visual Studio Code:

Это откроет файл file1 в Code.

Это откроет все файлы уценки ( .md ) в текущем каталоге в Code.

По умолчанию файлы будут открываться в существующем окне кода, если оно доступно. Используйте флаг --new-window, чтобы заставить Visual Studio Code открывать новое окно для указанных файлов.

Открытие каталога с помощью команды кода

Используйте команду code, за которой следует одно или несколько имен каталогов, чтобы открыть каталоги в новом окне Visual Studio Code:

Код откроет новое окно для каталогов. Используйте флаг --reuse-window, чтобы указать коду повторно использовать существующее переднее окно.

Открытие файла рабочей области .code-workspace с помощью команды code

Открытие файла рабочей области с помощью команды code работает аналогично открытию каталогов:

Это откроет пример рабочего пространства в новом окне, если только вы не используете существующее окно повторно, добавив флаг --reuse-window.

Установка расширения с помощью команды code

Вы также можете установить расширения Visual Studio Code с помощью инструмента командной строки кода. Для этого вам сначала нужно узнать уникальный идентификатор расширения. Чтобы найти эту информацию, сначала перейдите на страницу расширения в Visual Studio Marketplace.

Например, вот страница расширения Jupyter Notebook:

Обратите внимание на параметр itemName в адресе. Значение этого параметра, ms-toolsai.jupyter, является уникальным идентификатором этого расширения.

Эту информацию также можно найти на самой странице Marketplace в нижней части правого столбца в разделе Дополнительная информация:

Получив этот уникальный идентификатор, вы можете использовать его с кодом --install-extension для установки расширения:

Используйте тот же идентификатор с флагом --uninstall-extension, чтобы удалить расширение.

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

Чтобы отобразить стандартный разделенный экран diff, в котором будут выделены добавления, удаления и изменения между двумя файлами, используйте флаг --diff:

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

Передача стандартного ввода в код Visual Studio с помощью команды code

Важной особенностью большинства оболочек командной строки является возможность направлять (или отправлять) вывод одной команды на ввод следующей. В следующей командной строке обратите внимание на | символ вертикальной черты, соединяющий команду ls ~ с кодом - :

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

code выведет некоторую информацию о временном файле, созданном для хранения входных данных:

Затем этот файл откроется в интерфейсе Code GUI:

Вы также можете запустить VS Code из терминала, введя 'code' после добавления его в путь:

Запустите VS Code.
Откройте палитру команд ( Cmd+Shift+P ) и введите «команда оболочки», чтобы найти команду оболочки: установить команду «код» в команде PATH.

Перезапустите терминал, чтобы новое значение $PATH вступило в силу. Вы сможете ввести «код». в любой папке, чтобы начать редактирование файлов в этой папке.

Примечание. Если у вас все еще есть старый псевдоним кода в вашем .bash_profile (или его эквиваленте) из ранней версии VS Code, удалите его и замените, выполнив команду оболочки: установите команду 'code' в команде PATH. .

Альтернативные ручные инструкции

Вместо выполнения приведенной выше команды вы можете вручную добавить VS Code к своему пути, для этого выполните следующие команды:

Запустите новый терминал, чтобы принять изменения .bash_profile.

Примечание. Передняя косая черта \ необходима для предотвращения расширения $PATH во время объединения. Удалите косую черту в начале, если вы хотите запустить команду экспорта непосредственно в терминале.

Примечание. Поскольку zsh стал оболочкой по умолчанию в macOS Catalina, выполните следующие команды, чтобы добавить VS Code к вашему пути:

Поддержка сенсорной панели

По умолчанию VS Code добавляет действия для навигации по истории редактора, а также полную панель инструментов отладки для управления отладчиком на сенсорной панели:

Защита конфиденциальности Мохаве

После обновления до версии macOS Mojave вы можете увидеть диалоговые окна с сообщением «Visual Studio Code хочет получить доступ к вашему файлу .» Это связано с новой защитой конфиденциальности в Мохаве и не относится к VS Code. Те же диалоги могут отображаться и при запуске других приложений. Диалоговое окно отображается один раз для каждого типа личных данных, и можно выбрать «Не разрешать», поскольку VS Code не требует доступа к этим папкам. Вы можете прочитать более подробное объяснение в этой записи блога.

Обновления

VS Code выпускает ежемесячные выпуски и поддерживает автоматическое обновление при выходе нового выпуска.Если VS Code предложит вам принять последнее обновление, оно будет установлено (вам не нужно ничего делать, чтобы получить последние версии).

Примечание. Вы можете отключить автоматическое обновление, если предпочитаете обновлять VS Code по собственному расписанию.

Меню настроек

Вы можете настроить VS Code с помощью настроек, цветовых тем и пользовательских сочетаний клавиш, доступных в группе меню Code > Preferences.

Вы можете встретить упоминание о File > Preferences в документации, которая является расположением группы меню Preferences в Windows и Linux. В macOS группа меню «Настройки» находится в разделе «Код», а не «Файл».

Дальнейшие шаги

После того как вы установили VS Code, эти темы помогут вам узнать больше о VS Code:

- Узнайте, как установить Git, Node.js, TypeScript и такие инструменты, как Yeoman. - Быстрое знакомство с VS Code. - Узнайте, как настроить VS Code в соответствии с вашими предпочтениями.

Частые вопросы

Почему я вижу сообщение «Visual Studio Code запрашивает доступ к вашему календарю».

Если вы используете версию Mojave для macOS, вы можете увидеть диалоговые окна с сообщением «Visual Studio Code хочет получить доступ к вашему файлу .» Это связано с новой защитой конфиденциальности в Мохаве, о которой говорилось выше. Можно выбрать «Не разрешать», поскольку VS Code не требует доступа к этим папкам.

VS Code не обновляется

Если VS Code не обновляется после перезапуска, macOS может поместить его в карантин. Выполните шаги, описанные в этой проблеме, чтобы решить ее.

Работает ли VS Code на компьютерах Mac M1?

Да, VS Code поддерживает сборки macOS ARM64, которые могут работать на компьютерах Mac с процессором Apple M1. Вы можете установить универсальную сборку, включающую сборки Intel и Apple Silicon, или одну из сборок для конкретной платформы.

Команды запускают действия в Visual Studio Code. Если вы когда-либо настраивали привязку клавиш, значит, вы работали с командами. Команды также используются расширениями для предоставления функций пользователям, привязки к действиям в пользовательском интерфейсе VS Code и реализации внутренней логики.

Использование команд

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

Программное выполнение команды

Например, команда editor.action.addCommentLine комментирует выделенные в данный момент строки в активном текстовом редакторе:

Некоторые команды принимают аргументы, управляющие их поведением. Команды также могут возвращать результат. Например, похожая на API команда vscode.executeDefinitionProvider запрашивает в документе определения в заданной позиции. Он принимает URI документа и позицию в качестве аргументов и возвращает обещание со списком определений:

Чтобы найти доступные команды:

URI команд

Команды URI — это ссылки, по которым выполняется заданная команда. Их можно использовать в качестве интерактивных ссылок в тексте при наведении курсора, сведениях об элементах завершения или внутри веб-просмотров.

Командный URI использует схему команды, за которой следует имя команды. URI команды для команды editor.action.addCommentLine, например, будет command:editor.action.addCommentLine . Вот провайдер наведения, который показывает ссылку в комментариях к текущей строке в активном текстовом редакторе:

Список аргументов команды передается в виде массива JSON с правильно закодированным URI. В приведенном ниже примере команда git.stage используется для создания ссылки при наведении курсора на текущий файл:

Вы можете включить URI команд в веб-представлениях, установив enableCommandUris в WebviewOptions при создании веб-представления.

Создание новых команд

Регистрация команды

Функция обработчика будет вызываться всякий раз, когда выполняется команда myExtension.sayHello, будь то программно с помощью executeCommand , из пользовательского интерфейса VS Code или с помощью привязки клавиш.

Создание команды для пользователя

Дополнение команд сообщает VS Code, что ваше расширение предоставляет данную команду, а также позволяет вам управлять тем, как эта команда отображается в пользовательском интерфейсе. Теперь наша команда появится в палитре команд:

Нам по-прежнему нужно вызвать registerCommand, чтобы связать идентификатор команды с обработчиком. Это означает, что если пользователь выберет команду myExtension.sayHello из палитры команд, но наше расширение еще не активировано, ничего не произойдет. Чтобы предотвратить это, расширения должны зарегистрировать событие активации onCommand для всех команд, с которыми сталкивается пользователь:

Теперь, когда пользователь впервые вызывает команду myExtension.sayHello из палитры команд или с помощью сочетания клавиш, расширение будет активировано, а registerCommand привяжет myExtension.sayHello к соответствующему обработчику.

Вам не нужно событие активации onCommand для внутренних команд, но вы должны определить его для любых команд, которые:

Можно вызвать с помощью палитры команд.
Можно вызвать с помощью привязки клавиш.
Можно вызвать через пользовательский интерфейс VS Code, например через строку заголовка редактора.
Предназначен как API для использования другими расширениями.

Управление отображением команды в палитре команд

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

Теперь команда myExtension.sayHello будет отображаться в палитре команд только тогда, когда пользователь находится в файле Markdown.

Включение команд

Команды поддерживают включение через свойство включения, значением которого является предложение when. Включение распространяется на все меню и зарегистрированные сочетания клавиш.

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

Наконец, меню с командами, такие как палитра команд или контекстные меню, реализуют различные способы включения. Контекстные меню редактора и проводника отображают элементы включения/отключения, а палитра команд фильтрует их.

Использование пользовательского контекста предложения when

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

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

Справка по командной строке

Чтобы получить обзор интерфейса командной строки VS Code, откройте терминал или командную строку и введите code --help .

Вы увидите версию, пример использования и список параметров командной строки.

Запуск из командной строки

Вы можете запустить VS Code из командной строки, чтобы быстро открыть файл, папку или проект. Откройте терминал или командную строку, перейдите в папку проекта и введите код .

Вы видите, что папка Visual Studio Code открыта.

При установке Windows и Linux необходимо добавить расположение двоичных файлов VS Code в системный путь. Если это не так, вы можете вручную добавить местоположение в переменную среды Path.

Основные параметры интерфейса командной строки

Вот необязательные аргументы, которые вы можете использовать при запуске VS Code из командной строки через код:

< /th> < td style="text-align: left;"> Откройте редактор различий файлов. В качестве аргументов требуется два пути к файлам.

Аргумент	Описание
-h или --help	Использование печати
-v или --version	Вывести версию кода VS (для например, 1.22.2), идентификатор фиксации GitHub и архитектура (например, x64).
-n или --new -window	Открывает новый сеанс VS Code вместо восстановления предыдущего сеанса (по умолчанию).
-r или --reuse-window	Принудительно открывает файл или папку в последнем активном окне.
-g или --goto	При использовании с файлом: line[:character] , открывает файл в определенной строке и необязательном положении символа. Этот аргумент предоставляется, поскольку некоторые операционные системы позволяют: в имени файла.
-d или --diff
-w или --wait	Подождите, пока файлы должны быть закрыты перед возвратом.
--locale	Установите язык отображения (локаль) для сеанса VS Code. (например, en-US или zh-TW)

Открытие файлов и папок

Чтобы открыть файл, вы можете открыть его с помощью команды кода.

Теперь вы видите, что указанный файл открыт в редакторе.

Если указанный файл не существует, VS Code создаст его вместе с любыми новыми промежуточными папками.

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