Spec-Zone.ru › Nushell

attr deprecated для core

Атрибут для пометки команды или флага как устаревших.

Сигнатура

> attr deprecated {flags} (message)

Флаги

  • --flag {string}: Пометить флаг как устаревший, а не команду.
  • --since, -s {string}: Указать версию, в которой этот элемент стал устаревшим.
  • --remove, -r {string}: Указать версию, в которой этот элемент будет удалён.
  • --report {string}: Как предупреждать об этом элементе. Возможные значения: first (по умолчанию), every

Параметры

  • message: Сообщение справки, которое будет включено в предупреждение об устаревании.

Типы входных и выходных данных:

входные данные выходные данные
nothing record

Примеры

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

> @deprecated
    def outdated [] {}

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

> @deprecated "Use my-new-command instead."
    @category deprecated
    def my-old-command [] {}
Use my-new-command instead.

Примечания

Помечает команду (по умолчанию) или флаг/переключатель (--flag) как устаревшие. По умолчанию предупреждение об устаревании появляется только при первом использовании.

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

Также можно задать категорию deprecated с помощью @category deprecated

Copyright © 2019–2026 The Nushell Project DevelopersLicensed under the MIT License.
https://www.nushell.sh/commands/docs/attr_deprecated.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API