Skip to content

stripOwnedRuleCustomMessageEntries

Removes from a config’s obsidianmd/rule-custom-message options every wrapped rule named in ownedRuleNames.

An entry for a rule NOT in the set keeps running through the wrapper, so an entry upstream adds later is not silently dropped. When nothing is left the wrapper is turned off rather than run with an empty map.

Import:

import { stripOwnedRuleCustomMessageEntries } from 'obsidian-dev-utils/script-utils/linters/obsidianmd-rule-custom-message';

Signature:

function stripOwnedRuleCustomMessageEntries(params: StripOwnedRuleCustomMessageEntriesParams): Linter.Config<RulesConfig>

Parameters:

Parameter Type Description
params StripOwnedRuleCustomMessageEntriesParams The parameters.

Returns: Linter.Config<RulesConfig> — The config, unchanged when it carries no narrowable wrapper entry, otherwise a narrowed copy.


Links to this page: