One place for hosting & domains

      Форматирование

      Форматирование кода с помощью Prettier в Visual Studio Code


      Введение

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

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

      Для демонстрации мы будем форматировать следующий код:

      const name = "James";
      
      const person ={first: name
      }
      
      console.log(person);
      
      const sayHelloLinting = (fName) => {
      console.log(`Hello linting, ${fName}`)
      }
      
      sayHelloLinting('James');
      

      Если вы знакомы с форматированием кода, вы можете заметить некоторые упущения:

      • Смесь одинарных и двойных кавычек.
      • Первое свойство объекта person должно находиться в отдельной строке.
      • Выражение консоли внутри функции должно быть выделено отступами.
      • Вам могут понравиться или не понравиться необязательные скобки, в которые заключен параметр функции arrow.

      Предварительные требования

      Для прохождения этого учебного модуля вам нужно будет загрузить и установить Visual Studio Code.

      Чтобы работать с Prettier в Visual Studio Code, вам потребуется установить расширение. Для этого выполните поиск инструмента Prettier - Code Formatter в панели расширений VS Code. Если вы устанавливаете его в первый раз, вы увидите кнопку install вместо кнопки uninstall, как показано здесь:

      Файл readme расширения Prettier

      Шаг 1 — Использование команды форматирования документа

      После установки расширения Prettier вы можете использовать его для форматирования вашего кода. Для начала выполним обзор, используя команду Format Document. Эта команда сделает ваш код более согласованным с отформатированными пробелами, переносами строк и кавычками.

      Чтобы открыть палитру команд, вы можете использовать COMMAND + SHIFT + P в macOS или CTRL + SHIFT + P в Windows.

      Выполните в палитре команд поиск по ключевому слову format и выберите Format Document.

      Открытая палитра команд с результатами поиска format

      Возможно, вам будет предложено выбрать формат для использования. Для этого нажмите кнопку Configure:

      Строка выбора средства форматирования по умолчанию

      Затем выберите Prettier – Code Formatter.

      Выбор Prettier

      Примечание. Если вы не видите диалога выбора формата по умолчанию, вы можете вручную изменить его в разделе «Настройки». Установите для Editor: Default Formatter значение ebsenp.prettier-vscode.

      Теперь ваш код отформатирован с пробелами, переносами строк и единообразными кавычками:

      const name="James";
      
      const person = { first: name };
      
      console.log(person);
      
      const sayHelloLinting = (fname) => {
        console.log(`Hello linting, ${fName}`);
      }
      
      sayHelloLinting('James');
      

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

      body {color: red;
      }
      h1 {
        color: purple;
      font-size: 24px
      }
      

      Будет переформатирован как:

      body {
        color: red;
      }
      h1 {
        color: purple;
        font-size: 24px;
      }
      

      Мы изучили эту команду, и теперь посмотрим, как можно реализовать ее автоматическое выполнение.

      Шаг 2 — Форматирование кода при сохранении

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

      Чтобы изменить эту настройку, нажмите COMMAND + в macOS или CTRL + в Windows, чтобы открыть меню Settings (Настройки). Выполните в меню поиск Editor: Format On Save и убедитесь, что эта опция включена:

      Опция Editor: Format On Save включена

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

      Шаг 3 — Изменение параметров конфигурации Prettier

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

      Откройте меню Settings (Настройки). Выполните поиск Prettier. Вы увидите список всех параметров, которые вы можете изменить:

      Параметры конфигурации для Prettier

      Вот несколько наиболее распространенных параметров:

      • Single Quote — выберите, нужно ли использовать одинарные или двойные кавычки.
      • Semi — выберите, нужно ли добавлять точку с запятой в конце строк.
      • Tab Width — укажите, сколько пробелов должно вставляться при табуляции.

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

      Шаг 4 — Создание файла конфигурации Prettier

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

      Создайте новый файл .prettierrc.extension с одним из следующих расширений:

      Вот пример простого файла конфигурации в формате JSON:

      {
        "trailingComma": "es5",
        "tabWidth": 4,
        "semi": false,
        "singleQuote": true
      }
      

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

      Заключение

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

      Prettier обеспечивает согласованность форматирования кода и позволяет автоматизировать этот процесс.



      Source link

      Форматирование строк в Go


      Строки часто состоят из текста, и нам нужно контролировать читаемость этих строк посредством пунктуации, разрывов строк и отступов.

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

      Литерали строк

      Вначале определим разницу между литералями строк и значениями строк. Литераль строк — это то, что мы видим в исходном коде компьютерной программы, включая кавычки. Значение строки — это то, что мы видим, когда вызываем функцию fmt.Println и запускаем программу.

      В простой программе Hello, World! литераль строки будет выглядеть как "Hello, World!", а значением строки будет Hello, World! без кавычек. Значение строки — это то, что мы видим в окне терминала после запуска программы Go.

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

      Кавычки

      В Go можно использовать одинарные кавычки (`) или двойные кавычки ("), поэтому мы можем легко вставлять цитаты в строку, выделяя их двойными кавычками, в то время как сама строка выделена одинарными кавычками:

      `Sammy says, "Hello!"`
      

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

      "Sammy likes the `fmt` package for formatting strings.."
      

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

      Важно помнить, что при использовании одинарных кавычек в Go создается чистая литераль строки, а при использовании двойных кавычек — интерпретированная литераль строки. Чтобы узнать больше о разнице между ними, ознакомьтесь с руководством Введение в работу со строками в Go.

      Символы перехода

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

      Далее приведен перечень нескольких распространенных символов перехода:

      Символ перехода Формат
      Обратная косая черта
      Двойные кавычки
      n Разрыв строки
      t Табуляция (горизонтальный отступ)

      Используем символ перехода, чтобы добавить символы кавычек в приведенный выше пример, при этом сейчас мы используем двойные кавычки для обозначения строки:

      fmt.Println("Sammy says, "Hello!"")
      

      Output

      Sammy says, "Hello!"

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

      Символ перехода n можно использовать для разрыва строк без нажатия клавиши Enter (Return):

      fmt.Println("This stringnspans multiplenlines.")
      

      Output

      This string spans multiple lines.

      Символы перехода при желании можно комбинировать. Например, мы можем вывести список позиций, напечатав строку из нескольких рядов и добавив разделители в виде табуляции:

      fmt.Println("1.tSharkn2.tShrimpn10.tSquid")
      

      Output

      1. Shark 2. Shrimp 10. Squid

      Горизонтальные отступы, создаваемые за счет символа перехода t, обеспечивают выравнивание со вторым столбцом в предыдущем примере, что делает выводимый текст удобным для чтения.

      Символы перехода используются для добавления в строки дополнительного форматирования, которого иным образом достичь сложно или невозможно. Без символов перехода вы не сможете построить строку Сэмми говорит: "Мне нравится использовать пакет `fmt`".

      Многострочная печать

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

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

      `
      This string is on
      multiple lines
      within three single
      quotes on either side.
      `
      

      Если вы распечатаете этот текст, вы увидите, что символ возврата имеется в начале и в конце строки:

      Output

      This string is on multiple lines within three single quotes on either side.

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

      `This string is on
      multiple lines
      within three single
      quotes on either side.`
      

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

      "This string is onn" +
      "multiple linesn" +
      "within three singlen" +
      "quotes on either side."
      

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

      Чистые литерали строк

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

      Чистая литераль строки указывает Go игнорировать все форматирование строки, включая символы перехода.

      Мы можем создать чистую строку, заключив строку в одинарные кавычки:

      fmt.Println(`Sammy says,"The balloon's color is red."`)
      

      Output

      Sammy says,"The balloon's color is red."

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

      Заключение

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



      Source link