updated a couple of variable names to make things nicer

platers · Mar 14, 2023 · 35fb603 · 35fb603
1 parent aba779a
commit 35fb603
Show file tree

Hide file tree

Showing 58 changed files with 193 additions and 193 deletions.
diff --git a/src/rules/auto-correct-common-misspellings.ts b/src/rules/auto-correct-common-misspellings.ts
@@ -14,7 +14,7 @@ export default class AutoCorrectCommonMisspellings extends RuleBuilder<AutoCorre
  constructor() {
  super({
  nameTextKey: 'rules.auto-correct-common-misspellings.name',
- descriptionTextKey: 'rules.auto-correct-common-misspellings.description',
+ descriptionKey: 'rules.auto-correct-common-misspellings.description',
  type: RuleType.CONTENT,
  });
  }
@@ -111,8 +111,8 @@ export default class AutoCorrectCommonMisspellings extends RuleBuilder<AutoCorre
  return [
  new TextAreaOptionBuilder({
  OptionsClass: AutoCorrectCommonMisspellingsOptions,
- nameTextKey: 'rules.auto-correct-common-misspellings.ignore-words.name',
- descriptionTextKey: 'rules.auto-correct-common-misspellings.ignore-words.description',
+ nameKey: 'rules.auto-correct-common-misspellings.ignore-words.name',
+ descriptionKey: 'rules.auto-correct-common-misspellings.ignore-words.description',
  optionsKey: 'ignoreWords',
  splitter: wordSplitterRegex,
  separator: ', ',

diff --git a/src/rules/blockquotify-on-paste.ts b/src/rules/blockquotify-on-paste.ts
@@ -12,8 +12,8 @@ class BlockquotifyOnPasteOptions implements Options {
 export default class BlockquotifyOnPaste extends RuleBuilder<BlockquotifyOnPasteOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.add-blockquote-indentation-on-paste.name',
- descriptionTextKey: 'rules.add-blockquote-indentation-on-paste.description',
+ nameKey: 'rules.add-blockquote-indentation-on-paste.name',
+ descriptionKey: 'rules.add-blockquote-indentation-on-paste.description',
  type: RuleType.PASTE,
  });
  }

diff --git a/src/rules/capitalize-headings.ts b/src/rules/capitalize-headings.ts
@@ -400,8 +400,8 @@ class CapitalizeHeadingsOptions implements Options {
 export default class CapitalizeHeadings extends RuleBuilder<CapitalizeHeadingsOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.capitalize-headings.name',
- descriptionTextKey: 'rules.capitalize-headings.description',
+ nameKey: 'rules.capitalize-headings.name',
+ descriptionKey: 'rules.capitalize-headings.description',
  type: RuleType.HEADING,
  });
  }
@@ -520,8 +520,8 @@ export default class CapitalizeHeadings extends RuleBuilder<CapitalizeHeadingsOp
  return [
  new DropdownOptionBuilder({
  OptionsClass: CapitalizeHeadingsOptions,
- nameTextKey: 'rules.capitalize-headings.style.name',
- descriptionTextKey: 'rules.capitalize-headings.style.description',
+ nameKey: 'rules.capitalize-headings.style.name',
+ descriptionKey: 'rules.capitalize-headings.style.description',
  optionsKey: 'style',
  records: [
  {
@@ -540,22 +540,22 @@ export default class CapitalizeHeadings extends RuleBuilder<CapitalizeHeadingsOp
  }),
  new BooleanOptionBuilder({
  OptionsClass: CapitalizeHeadingsOptions,
- nameTextKey: 'rules.capitalize-headings.ignore-case-words.name',
- descriptionTextKey: 'rules.capitalize-headings.ignore-case-words.description',
+ nameKey: 'rules.capitalize-headings.ignore-case-words.name',
+ descriptionKey: 'rules.capitalize-headings.ignore-case-words.description',
  optionsKey: 'ignoreCasedWords',
  }),
  new TextAreaOptionBuilder({
  OptionsClass: CapitalizeHeadingsOptions,
- nameTextKey: 'rules.capitalize-headings.ignore-words.name',
- descriptionTextKey: 'rules.capitalize-headings.ignore-words.description',
+ nameKey: 'rules.capitalize-headings.ignore-words.name',
+ descriptionKey: 'rules.capitalize-headings.ignore-words.description',
  optionsKey: 'ignoreWords',
  splitter: wordSplitterRegex,
  separator: ', ',
  }),
  new TextAreaOptionBuilder({
  OptionsClass: CapitalizeHeadingsOptions,
- nameTextKey: 'rules.capitalize-headings.lowercase-words.name',
- descriptionTextKey: 'rules.capitalize-headings.lowercase-words.description',
+ nameKey: 'rules.capitalize-headings.lowercase-words.name',
+ descriptionKey: 'rules.capitalize-headings.lowercase-words.description',
  optionsKey: 'lowercaseWords',
  splitter: wordSplitterRegex,
  separator: ', ',

diff --git a/src/rules/compact-yaml.ts b/src/rules/compact-yaml.ts
@@ -11,8 +11,8 @@ class CompactYamlOptions implements Options {
 export default class CompactYaml extends RuleBuilder<CompactYamlOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.compact-yaml.name',
- descriptionTextKey: 'rules.compact-yaml.description',
+ nameKey: 'rules.compact-yaml.name',
+ descriptionKey: 'rules.compact-yaml.description',
  type: RuleType.SPACING,
  });
  }
@@ -89,8 +89,8 @@ export default class CompactYaml extends RuleBuilder<CompactYamlOptions> {
  return [
  new BooleanOptionBuilder({
  OptionsClass: CompactYamlOptions,
- nameTextKey: 'rules.compact-yaml.inner-new-lines.name',
- descriptionTextKey: 'rules.compact-yaml.inner-new-lines.description',
+ nameKey: 'rules.compact-yaml.inner-new-lines.name',
+ descriptionKey: 'rules.compact-yaml.inner-new-lines.description',
  optionsKey: 'innerNewLines',
  }),
  ];

diff --git a/src/rules/consecutive-blank-lines.ts b/src/rules/consecutive-blank-lines.ts
@@ -9,8 +9,8 @@ class ConsecutiveBlankLinesOptions implements Options {}
 export default class ConsecutiveBlankLines extends RuleBuilder<ConsecutiveBlankLinesOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.consecutive-blank-lines.name',
- descriptionTextKey: 'rules.consecutive-blank-lines.description',
+ nameKey: 'rules.consecutive-blank-lines.name',
+ descriptionKey: 'rules.consecutive-blank-lines.description',
  type: RuleType.SPACING,
  });
  }

diff --git a/src/rules/convert-bullet-list-markers.ts b/src/rules/convert-bullet-list-markers.ts
@@ -10,7 +10,7 @@ export default class ConvertBulletListMarkers extends RuleBuilder<ConvertBulletL
  constructor() {
  super({
  nameTextKey: 'rules.convert-bullet-list-markers.name',
- descriptionTextKey: 'rules.convert-bullet-list-markers.description',
+ descriptionKey: 'rules.convert-bullet-list-markers.description',
  type: RuleType.CONTENT,
  });
  }

diff --git a/src/rules/convert-spaces-to-tabs.ts b/src/rules/convert-spaces-to-tabs.ts
@@ -12,7 +12,7 @@ export default class ConvertSpacesToTabs extends RuleBuilder<ConvertSpacesToTabs
  constructor() {
  super({
  nameTextKey: 'rules.convert-spaces-to-tabs.name',
- descriptionTextKey: 'rules.convert-spaces-to-tabs.description',
+ descriptionKey: 'rules.convert-spaces-to-tabs.description',
  type: RuleType.SPACING,
  });
  }
@@ -61,8 +61,8 @@ export default class ConvertSpacesToTabs extends RuleBuilder<ConvertSpacesToTabs
  return [
  new NumberOptionBuilder({
  OptionsClass: ConvertSpacesToTabsOptions,
- nameTextKey: 'rules.convert-spaces-to-tabs.tabsize.name',
- descriptionTextKey: 'rules.convert-spaces-to-tabs.tabsize.description',
+ nameKey: 'rules.convert-spaces-to-tabs.tabsize.name',
+ descriptionKey: 'rules.convert-spaces-to-tabs.tabsize.description',
  optionsKey: 'tabsize',
  }),
  ];

diff --git a/src/rules/emphasis-style.ts b/src/rules/emphasis-style.ts
@@ -15,7 +15,7 @@ export default class EmphasisStyle extends RuleBuilder<EmphasisStyleOptions> {
  constructor() {
  super({
  nameTextKey: 'rules.emphasis-style.name',
- descriptionTextKey: 'rules.emphasis-style.description',
+ descriptionKey: 'rules.emphasis-style.description',
  type: RuleType.CONTENT,
  });
  }
@@ -165,8 +165,8 @@ export default class EmphasisStyle extends RuleBuilder<EmphasisStyleOptions> {
  return [
  new DropdownOptionBuilder<EmphasisStyleOptions, EmphasisStyleValues>({
  OptionsClass: EmphasisStyleOptions,
- nameTextKey: 'rules.emphasis-style.style.name',
- descriptionTextKey: 'rules.emphasis-style.style.description',
+ nameKey: 'rules.emphasis-style.style.name',
+ descriptionKey: 'rules.emphasis-style.style.description',
  optionsKey: 'style',
  records: [
  {

diff --git a/src/rules/empty-line-around-blockquotes.ts b/src/rules/empty-line-around-blockquotes.ts
@@ -9,8 +9,8 @@ class EmptyLineAroundBlockquotesOptions implements Options {}
 export default class EmptyLineAroundBlockquotes extends RuleBuilder<EmptyLineAroundBlockquotesOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.empty-line-around-blockquotes.name',
- descriptionTextKey: 'rules.empty-line-around-blockquotes.description',
+ nameKey: 'rules.empty-line-around-blockquotes.name',
+ descriptionKey: 'rules.empty-line-around-blockquotes.description',
  type: RuleType.SPACING,
  });
  }

diff --git a/src/rules/empty-line-around-code-fences.ts b/src/rules/empty-line-around-code-fences.ts
@@ -9,8 +9,8 @@ class EmptyLineAroundCodeFencesOptions implements Options {}
 export default class EmptyLineAroundCodeFences extends RuleBuilder<EmptyLineAroundCodeFencesOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.empty-line-around-code-fences.name',
- descriptionTextKey: 'rules.empty-line-around-code-fences.description',
+ nameKey: 'rules.empty-line-around-code-fences.name',
+ descriptionKey: 'rules.empty-line-around-code-fences.description',
  type: RuleType.SPACING,
  });
  }

diff --git a/src/rules/empty-line-around-math-block.ts b/src/rules/empty-line-around-math-block.ts
@@ -13,8 +13,8 @@ class EmptyLineAroundMathBlockOptions implements Options {
 export default class EmptyLineAroundMathBlock extends RuleBuilder<EmptyLineAroundMathBlockOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.empty-line-around-math-blocks.name',
- descriptionTextKey: 'rules.empty-line-around-math-blocks.description',
+ nameKey: 'rules.empty-line-around-math-blocks.name',
+ descriptionKey: 'rules.empty-line-around-math-blocks.description',
  type: RuleType.SPACING,
  });
  }

diff --git a/src/rules/empty-line-around-tables.ts b/src/rules/empty-line-around-tables.ts
@@ -10,8 +10,8 @@ class EmptyLineAroundTablesOptions implements Options {}
 export default class EmptyLineAroundTables extends RuleBuilder<EmptyLineAroundTablesOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.empty-line-around-tables.name',
- descriptionTextKey: 'rules.empty-line-around-tables.description',
+ nameKey: 'rules.empty-line-around-tables.name',
+ descriptionKey: 'rules.empty-line-around-tables.description',
  type: RuleType.SPACING,
  });
  }

diff --git a/src/rules/escape-yaml-special-characters.ts b/src/rules/escape-yaml-special-characters.ts
@@ -13,8 +13,8 @@ class EscapeYamlSpecialCharactersOptions implements Options {
 export default class EscapeYamlSpecialCharacters extends RuleBuilder<EscapeYamlSpecialCharactersOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.escape-yaml-special-characters.name',
- descriptionTextKey: 'rules.escape-yaml-special-characters.description',
+ nameKey: 'rules.escape-yaml-special-characters.name',
+ descriptionKey: 'rules.escape-yaml-special-characters.description',
  type: RuleType.YAML,
  hasSpecialExecutionOrder: true,
  });
@@ -199,8 +199,8 @@ export default class EscapeYamlSpecialCharacters extends RuleBuilder<EscapeYamlS
  return [
  new BooleanOptionBuilder({
  OptionsClass: EscapeYamlSpecialCharactersOptions,
- nameTextKey: 'rules.escape-yaml-special-characters.try-to-escape-single-line-arrays.description',
- descriptionTextKey: 'rules.escape-yaml-special-characters.try-to-escape-single-line-arrays.name',
+ nameKey: 'rules.escape-yaml-special-characters.try-to-escape-single-line-arrays.description',
+ descriptionKey: 'rules.escape-yaml-special-characters.try-to-escape-single-line-arrays.name',
  optionsKey: 'tryToEscapeSingleLineArrays',
  }),
  ];

diff --git a/src/rules/file-name-heading.ts b/src/rules/file-name-heading.ts
@@ -14,7 +14,7 @@ export default class FileNameHeading extends RuleBuilder<FileNameHeadingOptions>
  constructor() {
  super({
  nameTextKey: 'rules.file-name-heading.name',
- descriptionTextKey: 'rules.file-name-heading.description',
+ descriptionKey: 'rules.file-name-heading.description',
  type: RuleType.HEADING,
  });
  }

diff --git a/src/rules/footnote-after-punctuation.ts b/src/rules/footnote-after-punctuation.ts
@@ -9,8 +9,8 @@ class FootnoteAfterPunctuationOptions implements Options {}
 export default class FootnoteAfterPunctuation extends RuleBuilder<FootnoteAfterPunctuationOptions> {
  constructor() {
  super({
- nameTextKey: 'rules.footnote-after-punctuation.name',
- descriptionTextKey: 'rules.footnote-after-punctuation.description',
+ nameKey: 'rules.footnote-after-punctuation.name',
+ descriptionKey: 'rules.footnote-after-punctuation.description',
  type: RuleType.FOOTNOTE,
  });
  }

diff --git a/src/rules/force-yaml-escape.ts b/src/rules/force-yaml-escape.ts
@@ -14,7 +14,7 @@ export default class ForceYamlEscape extends RuleBuilder<ForceYamlEscapeOptions>
  constructor() {
  super({
  nameTextKey: 'rules.force-yaml-escape.name',
- descriptionTextKey: 'rules.force-yaml-escape.description',
+ descriptionKey: 'rules.force-yaml-escape.description',
  type: RuleType.YAML,
  hasSpecialExecutionOrder: true,
  });
@@ -91,8 +91,8 @@ export default class ForceYamlEscape extends RuleBuilder<ForceYamlEscapeOptions>
  return [
  new TextAreaOptionBuilder({
  OptionsClass: ForceYamlEscapeOptions,
- nameTextKey: 'rules.force-yaml-escape.force-yaml-escape-keys.name',
- descriptionTextKey: 'rules.force-yaml-escape.force-yaml-escape-keys.description',
+ nameKey: 'rules.force-yaml-escape.force-yaml-escape-keys.name',
+ descriptionKey: 'rules.force-yaml-escape.force-yaml-escape-keys.description',
  optionsKey: 'forceYamlEscape',
  }),
  ];

diff --git a/src/rules/format-tags-in-yaml.ts b/src/rules/format-tags-in-yaml.ts
@@ -10,7 +10,7 @@ export default class FormatTagsInYaml extends RuleBuilder<FormatTagsInYamlOption
  constructor() {
  super({
  nameTextKey: 'rules.format-tags-in-yaml.name',
- descriptionTextKey: 'rules.format-tags-in-yaml.description',
+ descriptionKey: 'rules.format-tags-in-yaml.description',
  type: RuleType.YAML,
  hasSpecialExecutionOrder: true,
  });

diff --git a/src/rules/format-yaml-arrays.ts b/src/rules/format-yaml-arrays.ts
@@ -37,7 +37,7 @@ export default class RuleTemplate extends RuleBuilder<FormatYamlArrayOptions> {
  constructor() {
  super({
  nameTextKey: 'rules.format-yaml-array.name',
- descriptionTextKey: 'rules.format-yaml-array.description',
+ descriptionKey: 'rules.format-yaml-array.description',
  type: RuleType.YAML,
  });
  }
@@ -232,20 +232,20 @@ export default class RuleTemplate extends RuleBuilder<FormatYamlArrayOptions> {
  return [
  new BooleanOptionBuilder({
  OptionsClass: FormatYamlArrayOptions,
- nameTextKey: 'rules.format-yaml-array.alias-key.name',
- descriptionTextKey: 'rules.format-yaml-array.alias-key.description',
+ nameKey: 'rules.format-yaml-array.alias-key.name',
+ descriptionKey: 'rules.format-yaml-array.alias-key.description',
  optionsKey: 'formatAliasKey',
  }),
  new BooleanOptionBuilder({
  OptionsClass: FormatYamlArrayOptions,
- nameTextKey: 'rules.format-yaml-array.tag-key.name',
- descriptionTextKey: 'rules.format-yaml-array.tag-key.description',
+ nameKey: 'rules.format-yaml-array.tag-key.name',
+ descriptionKey: 'rules.format-yaml-array.tag-key.description',
  optionsKey: 'formatTagKey',
  }),
  new DropdownOptionBuilder({
  OptionsClass: FormatYamlArrayOptions,
- nameTextKey: 'rules.format-yaml-array.default-array-style.name',
- descriptionTextKey: 'rules.format-yaml-array.default-array-style.description',
+ nameKey: 'rules.format-yaml-array.default-array-style.name',
+ descriptionKey: 'rules.format-yaml-array.default-array-style.description',
  optionsKey: 'defaultArrayStyle',
  records: [
  {
@@ -260,20 +260,20 @@ export default class RuleTemplate extends RuleBuilder<FormatYamlArrayOptions> {
  }),
  new BooleanOptionBuilder({
  OptionsClass: FormatYamlArrayOptions,
- nameTextKey: 'rules.format-yaml-array.default-array-keys.name',
- descriptionTextKey: 'rules.format-yaml-array.default-array-keys.description',
+ nameKey: 'rules.format-yaml-array.default-array-keys.name',
+ descriptionKey: 'rules.format-yaml-array.default-array-keys.description',
  optionsKey: 'formatArrayKeys',
  }),
  new TextAreaOptionBuilder({
  OptionsClass: FormatYamlArrayOptions,
- nameTextKey: 'rules.format-yaml-array.force-single-line-array-style.name',
- descriptionTextKey: 'rules.format-yaml-array.force-single-line-array-style.description',
+ nameKey: 'rules.format-yaml-array.force-single-line-array-style.name',
+ descriptionKey: 'rules.format-yaml-array.force-single-line-array-style.description',
  optionsKey: 'forceSingleLineArrayStyle',
  }),
  new TextAreaOptionBuilder({
  OptionsClass: FormatYamlArrayOptions,
- nameTextKey: 'rules.format-yaml-array.force-multi-line-array-style.name',
- descriptionTextKey: 'rules.format-yaml-array.force-multi-line-array-style.description',
+ nameKey: 'rules.format-yaml-array.force-multi-line-array-style.name',
+ descriptionKey: 'rules.format-yaml-array.force-multi-line-array-style.description',
  optionsKey: 'forceMultiLineArrayStyle',
  }),
  ];

diff --git a/src/rules/header-increment.ts b/src/rules/header-increment.ts
@@ -13,7 +13,7 @@ export default class HeaderIncrement extends RuleBuilder<HeaderIncrementOptions>
  constructor() {
  super({
  nameTextKey: 'rules.header-increment.name',
- descriptionTextKey: 'rules.header-increment.description',
+ descriptionKey: 'rules.header-increment.description',
  type: RuleType.HEADING,
  });
  }
@@ -167,8 +167,8 @@ export default class HeaderIncrement extends RuleBuilder<HeaderIncrementOptions>
  return [
  new BooleanOptionBuilder({
  OptionsClass: HeaderIncrementOptions,
- nameTextKey: 'rules.header-increment.start-at-h2.name',
- descriptionTextKey: 'rules.header-increment.start-at-h2.description',
+ nameKey: 'rules.header-increment.start-at-h2.name',
+ descriptionKey: 'rules.header-increment.start-at-h2.description',
  optionsKey: 'startAtH2',
  }),
  ];

diff --git a/src/rules/heading-blank-lines.ts b/src/rules/heading-blank-lines.ts
@@ -14,7 +14,7 @@ export default class HeadingBlankLines extends RuleBuilder<HeadingBlankLinesOpti
  constructor() {
  super({
  nameTextKey: 'rules.heading-blank-lines.name',
- descriptionTextKey: 'rules.heading-blank-lines.description',
+ descriptionKey: 'rules.heading-blank-lines.description',
  type: RuleType.SPACING,
  });
  }
@@ -120,14 +120,14 @@ export default class HeadingBlankLines extends RuleBuilder<HeadingBlankLinesOpti
  return [
  new BooleanOptionBuilder({
  OptionsClass: HeadingBlankLinesOptions,
- nameTextKey: 'rules.heading-blank-lines.bottom.name',
- descriptionTextKey: 'rules.heading-blank-lines.bottom.description',
+ nameKey: 'rules.heading-blank-lines.bottom.name',
+ descriptionKey: 'rules.heading-blank-lines.bottom.description',
  optionsKey: 'bottom',
  }),
  new BooleanOptionBuilder({
  OptionsClass: HeadingBlankLinesOptions,
- nameTextKey: 'rules.heading-blank-lines.empty-line-after-yaml.name',
- descriptionTextKey: 'rules.heading-blank-lines.empty-line-after-yaml.description',
+ nameKey: 'rules.heading-blank-lines.empty-line-after-yaml.name',
+ descriptionKey: 'rules.heading-blank-lines.empty-line-after-yaml.description',
  optionsKey: 'emptyLineAfterYaml',
  }),
  ];