Skip to content

Function: createMdGlobalRulesBuilder() ​

ts
function createMdGlobalRulesBuilder(glob): MdFrontmatterSourceBuilder<readonly object[]>;

Defined in: markdown/src/builders/create-md-global-rules-builder.ts:15

Builds a MdFrontmatterSourceBuilder<readonly GlobalRule[]> for md.globalRules(glob).

Configures kind: 'global-rules' and id: "md:global-rules:${glob}" so matched Markdown files are parsed and validated against GlobalRuleSchema relative to the host repository root.

Parameters ​

ParameterTypeDescription
globstringHost-root-relative file path or glob pattern targeting global rule Markdown files.

Returns ​

MdFrontmatterSourceBuilder<readonly object[]>

Frozen global rules source builder.

Released under the MIT License.