Перейти к содержанию

BSL006 — Хранение путей к файлам в коде

← Все правила

Кратко

Хранение путей к файлам в коде

Идентификаторы

Поле Значение
Код правила BSL006
Совместимый псевдоним UsingHardcodePath
Серьёзность WARNING
Включено по умолчанию Да
Реализовано Да
Теги security, hardware-related

Поведение

  • Публичный идентификатор BSL006 и псевдоним UsingHardcodePath стабильны.
  • Правило сообщает о случаях, описанных на этой странице.
  • Подавления и проектная конфигурация применяются до публикации результата.
  • Для выполнения правила не требуется внешний анализатор или сетевой доступ.

Настройка и подавление

Код BSL### — основной стабильный идентификатор. Совместимый псевдоним принимается в select, ignore и совместимых блоковых комментариях.

[tool.onec-hbk-bsl]
select = ["BSL006"]
ignore = ["UsingHardcodePath"]

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

  • noqa:
Значение = "пример";  // noqa: BSL006
  • bsl-disable (совместимый вариант):
Значение = "пример";  // bsl-disable: BSL006
  • совместимый BSLLS-вариант:
Значение = "пример";  // BSLLS:UsingHardcodePath-off

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

// noqa: BSL006
// код без этой диагностики
// noqa-enable: BSL006

// bsl-disable: BSL006
// код без этой диагностики
// bsl-enable: BSL006

// BSLLS:UsingHardcodePath-off
// код без этой диагностики
// BSLLS:UsingHardcodePath-on

Чтобы отключить правило до конца файла, не добавляйте закрывающий noqa-enable, bsl-enable или BSLLS:…-on.

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

Описание диагностики

Запрещено хранить в коде:

  • Пути к файлам и папкам (Windows, Unix)

Есть как минимум несколько способов правильного хранения такой информации:

  • Хранение в константе.
  • Хранение в регистре сведений.
  • Хранение в отдельном модулей, в котором отключена проверка правила (не рекомендуется).
  • Хранение в справочнике, узле плана обмена и т.д..

Особенности

При поиске путей Windows / Unix происходит проверка и на URL в строке. Ключевые слова поиска URL: * http * https * ftp

Примеры

Неправильно:

КаталогОбмена = "c:/обмен/обменданными";

Правильно:

КаталогОбмена = Константы.КаталогОбмена.Получить();

или

КаталогОбмена = ОбменДаннымиПовтИсп.КаталогОбмена();