Skip to content

Latest commit

 

History

History
849 lines (493 loc) · 37.7 KB

CHANGELOG.md

File metadata and controls

849 lines (493 loc) · 37.7 KB
Raw

v1.7.1 (2024-05-08)

🐛 Bug Fix

  • #524 OS-agnostic handling of end-of-line characters (@bmish)

Committers: 1

v1.7.0 (2024-02-28)

🚀 Enhancement

🐛 Bug Fix

Committers: 2

v1.6.2 (2024-01-14)

🐛 Bug Fix

  • #508 Support multiple potential property locations for config description (@bmish)

Committers: 1

v1.6.1 (2023-11-16)

🐛 Bug Fix

  • #503 Better display of rule option default for array option (@bmish)

Committers: 1

v1.6.0 (2023-11-14)

🚀 Enhancement

  • #502 Support a user-defined function for --path-rule-doc option (@hyoban)

🐛 Bug Fix

📝 Documentation

Committers: 3

v1.5.4 (2023-11-05)

🐛 Bug Fix

  • #498 Handle when an option could have multiple types in rule option lists (@bmish)

Committers: 1

v1.5.3 (2023-10-31)

🐛 Bug Fix

  • #496 Indicate type of array for array options in rule option lists (@bmish)
  • #495 Add hint about using --init-rule-docs when rule doc missing (@bmish)

Committers: 1

v1.5.2 (2023-10-15)

🐛 Bug Fix

  • #486 Include any mandatory sections when generating new rule docs with --init-rule-docs and --rule-doc-section-include (@bmish)
  • #485 Initialize rule doc options section when using --init-rule-docs (@bmish)

Committers: 1

v1.5.1 (2023-10-13)

🐛 Bug Fix

  • #482 Sanitize newlines and pipes from markdown table cells (@bmish)
  • #484 Don't exit with failure about missing mention of rule option when rule option list was just generated (@bmish)
  • #483 Show rule option list "Default" column even with only a falsy value (@bmish)

Committers: 1

v1.5.0 (2023-10-12)

🚀 Enhancement

  • #481 Support auto-generated rule options lists (@bmish)
  • #480 Support auto-generated config lists (@bmish)

Committers: 1

v1.4.3 (2023-02-04)

🐛 Bug Fix

  • #409 Sort emojis before badges for configs in rules list for better aesthetics (@bmish)
  • #411 Fix loading of plugin with JSON entry point (@bmish)

Committers: 1

v1.4.2 (2023-01-10)

🐛 Bug Fix

  • #388 Clarify error message when rule option is missing from rule doc (@bmish)

📝 Documentation

  • #379 Add column for default value to readme options table (@bmish)
  • #326 Mention markdownlint compatibility (@bmish)

Committers: 1

v1.4.1 (2022-12-27)

🐛 Bug Fix

  • #375 Use concise relative paths for rule links (@bmish)

Committers: 1

v1.4.0 (2022-12-26)

🚀 Enhancement

  • #369 Support a user-defined function for --url-rule-doc option (@bmish)

Committers: 1

v1.3.0 (2022-12-23)

🐛 Bug Fix

Committers: 1

v1.2.1 (2022-12-22)

🐛 Bug Fix

  • #367 Ensure correct link used for deprecated rule replacement link when replacement rule is from ESLint core or third-party plugin (@bmish)

Committers: 1

v1.2.0 (2022-12-21)

🚀 Enhancement

  • #365 Support a user-defined function for --rule-list-split option (@bmish)
  • #351 Support splitting by multiple properties in --rule-list-split option (@bmish)

🐛 Bug Fix

  • #357 Ensure deprecated/schema properties are detected from deprecated, function-style rules (@bmish)
  • #355 Improve type for configEmoji option (@bmish)

🏠 Internal

  • #364 Refactor functions for generating and splitting the rules list (@bmish)
  • #356 Refactor how rules are passed around in codebase (@bmish)
  • #352 Better normalize pathRuleList option internally (@bmish)

Committers: 1

v1.1.0 (2022-12-16)

🚀 Enhancement

  • #350 Add rule doc notice type for rule description (@bmish)

🐛 Bug Fix

  • #349 Improve detection of named options to be mentioned in rule docs (@bmish)
  • #344 Hide stack trace when throwing exception (@bmish)

📝 Documentation

  • #342 Add table of contents to readme (@bmish)
  • #336 Add table documenting types of notices and columns (@bmish)
  • #332 Mention complementary rule eslint-plugin/require-meta-docs-url (@bmish)

🏠 Internal

Committers: 1

v1.0.2 (2022-12-01)

🐛 Bug Fix

  • #322 Use string union types instead of enums for better TypeScript compatibility with public config file type (@bmish)

Committers: 1

v1.0.1 (2022-12-01)

🐛 Bug Fix

  • #317 More robust handling of boolean-equivalent strings for parsing boolean CLI options and boolean properties in --rule-list-split (@bmish)
  • #314 Handle additional types of variable casing when creating sub-list headers with --rule-list-split (@bmish)
  • #309 Fully utilize readonly modifier for nested array types (@bmish)

📝 Documentation

🏠 Internal

  • #316 Use external library to retrieve an arbitrary property from a rule (@bmish)
  • #313 Avoid recreating readonly array when passing to markdown-table (@bmish)

Committers: 1

v1.0.0 (2022-11-28)

Now considered stable and already successfully adopted in many of the top ESLint plugins.

v0.28.1 (2022-11-28)

🐛 Bug Fix

  • #303 Use TypeScript readonly modifier for external/array types (@bmish)

📝 Documentation

Committers: 1

v0.28.0 (2022-11-27)

💥 Breaking Change

  • #301 Rename --split-by option to --rule-list-split (@bmish)
  • #300 Use arrays instead of CSV strings for config file types (@bmish)

📝 Documentation

  • #299 Add JSDocs for exported GenerateOptions type (@bmish)

Committers: 1

v0.27.1 (2022-11-27)

🐛 Bug Fix

Committers: 1

v0.27.0 (2022-11-27)

🚀 Enhancement

  • #285 Add postprocess config file option (useful for applying prettier formatting) (@G-Rath)
  • #296 Always display plugin prefix in deprecated rule replacement rule name (@bmish)

🐛 Bug Fix

  • #286 Remove extra closing quote from error message (@G-Rath)

🏠 Internal

Committers: 2

v0.26.1 (2022-11-25)

🐛 Bug Fix

  • #279 Ensure deprecated rule replacement link respects --path-rule-doc (@bmish)
  • #280 Fix default rules list path of README.md (@bmish)
  • #275 Fix rule links when specifying a rule list file in a subdirectory with --path-rule-list (@bmish)

🏠 Internal

Committers: 2

v0.26.0 (2022-11-23)

🚀 Enhancement

  • #271 Use correct header level when splitting rules list into sub-lists with --split-by (@bmish)
  • #270 Allow specifying multiple rules lists with --path-rule-list (@bmish)
  • #269 Allow content above rule doc title (@bmish)
  • #264 Export type for config file (@bmish)

🏠 Internal

Committers: 1

v0.25.0 (2022-11-21)

🚀 Enhancement

Committers: 1

v0.24.0 (2022-11-19)

💥 Breaking Change

  • #259 Add prefix to link name for readme config badge (@bmish)

📝 Documentation

🏠 Internal

  • #256 Add test for variation of scoped plugin name (@bmish)
  • #251 Add test that external rules are ignored (@bmish)
  • #249 Use TypeScript satisfies operator for option defaults (@bmish)
  • #241 Ensure tests are type-checked but not published (@bmish)

Committers: 1

v0.23.0 (2022-11-18)

🚀 Enhancement

🏠 Internal

  • #239 Split up tests into multiple test files (@bmish)

Committers: 2

v0.22.0 (2022-11-17)

🚀 Enhancement

  • #232 Add optional options column and notice to indicate whether a rule is configurable (@bmish)
  • #141 More robust loading of CJS plugins using require() (@bmish)
  • #234 Support absolute path for plugin root CLI argument (@bmish)

🐛 Bug Fix

  • #233 Target ES2020 for TypeScript output (@bmish)

Committers: 1

v0.21.0 (2022-11-15)

🚀 Enhancement

  • #229 Add optional rule list column fixableAndHasSuggestions (@bmish)

🐛 Bug Fix

  • #230 Remove special case handling for rule doc notice fixableAndHasSuggestions (@bmish)

Committers: 1

v0.20.0 (2022-11-15)

🚀 Enhancement

  • #223 Implement config file support (@bmish)
  • #222 Add --path-rule-doc and --path-rule-list options (@bmish)

🏠 Internal

Committers: 1

v0.19.1 (2022-11-09)

🐛 Bug Fix

  • #220 Fix deprecated rule replacement rule link with nested rule name (@bmish)
  • #218 Fix deprecated rule replacement rule link when plugin prefix included in replacement rule name (@bmish)

📝 Documentation

🏠 Internal

  • #211 Update Dependabot URL in comment (@ddzz)

Committers: 2

v0.19.0 (2022-11-02)

💥 Breaking Change

  • #205 Redesign information architecture of rules table columns and rule doc notices for representing rule configs/severities (@bmish)

Committers: 1

v0.18.2 (2022-11-01)

🐛 Bug Fix

  • #203 Redo fix to ensure notation for config that warns/disables a rule does not wrap to two lines in rules table cell (@bmish)

Committers: 1

v0.18.1 (2022-11-01)

🐛 Bug Fix

  • #202 Ensure config emoji isn't missing in multi-sentence rule doc notice (@bmish)
  • #201 Ensure notation for config that warns/disables a rule does not wrap to separate line (@bmish)

Committers: 1

v0.18.0 (2022-10-31)

🚀 Enhancement

  • #198 Indicate when a rule is set to off/warn by a config in the README rules list (@bmish)
  • #199 Add default emoji for TypeScript configs, adjust default emoji for accessibility configs (@bmish)

📝 Documentation

  • #200 Demonstrage usage with a build step or prettier formatting (@bmish)

Committers: 1

v0.17.0 (2022-10-30)

🚀 Enhancement

  • #187 Show diff when --check fails because docs are out-of-sync (@bmish)
  • #188 Reduce complexity by removing prettier formatting of outputted markdown (@bmish)

📝 Documentation

  • #190 Encourage complementary use of eslint-plugin/require-meta-docs-description lint rule in readme (@bmish)
  • #183 Mention popular plugins that use this (@bmish)

Committers: 1

v0.16.0 (2022-10-28)

🚀 Enhancement

  • #180 Indicate which configs warn for a rule (@bmish)
  • #178 Add option --rule-doc-section-options (@bmish)

🐛 Bug Fix

  • #181 Handle rule with no meta object (@bmish)
  • #177 Throw error when trying to use general configs emoji for a config when multiple configs are present (@bmish)
  • #176 Also check for escaped version of option name in rule doc for rules with options (@bmish)
  • #175 Use correct rule doc title format fallback when rule missing description (@bmish)
  • #172 Use actual nbsp character instead of HTML entity when avoiding wrapping rule names in rules list (@bmish)

Committers: 1

v0.15.0 (2022-10-26)

🚀 Enhancement

🐛 Bug Fix

  • #170 Use code-style around rule name in rule doc title only when description also present (@bmish)
  • #169 Use case-insensitive sorting for rules, configs, and lists (@bmish)

📝 Documentation

🏠 Internal

Committers: 2

v0.14.0 (2022-10-21)

💥 Breaking Change

  • #155 Indicate that content is auto-generated in marker comments (@bmish)

🚀 Enhancement

  • #156 Indicate which configs disable a rule (@bmish)

🐛 Bug Fix

  • #154 Use code styling for replacement rule name in deprecated rule notice (@bmish)
  • #153 Avoid potentially having two legends for the same config emoji (@bmish)
  • #152 Use markdown-table for generating rules list (@bmish)

Committers: 1

v0.13.0 (2022-10-20)

🚀 Enhancement

  • #149 Add consolidated rule doc notice for fixable and suggestions (@bmish)

🐛 Bug Fix

  • #148 Avoid wrapping name column in rules list (@bmish)

Committers: 1

v0.12.0 (2022-10-19)

🚀 Enhancement

  • #139 Add --rule-doc-notices option (@bmish)
  • #136 Add default emojis for common configs (@bmish)
  • #134 Add optional column and notice for rule type (@bmish)
  • #137 Support removing the default emoji for a config with --config-emoji option (@bmish)

🐛 Bug Fix

  • #147 Hide ignored configs from rule list legend (@bmish)
  • #140 Handle plugins using exports in package.json (@bmish)

📝 Documentation

Committers: 1

v0.11.0 (2022-10-13)

🚀 Enhancement

Committers: 1

v0.10.0 (2022-10-12)

🚀 Enhancement

  • #126 Add rule doc notice when type-checking is required (@bmish)

🐛 Bug Fix

📝 Documentation

🏠 Internal

  • #127 Refactor to ensure a rule doc notice is defined for each rule list column (@bmish)

Committers: 2

v0.9.0 (2022-10-10)

🚀 Enhancement

📝 Documentation

  • #108 Improve README especially about config options (@bmish)

Committers: 1

v0.8.1 (2022-10-10)

🐛 Bug Fix

Committers: 1

v0.8.0 (2022-10-09)

🚀 Enhancement

  • #104 Add desc format to --rule-doc-title-format option (@bmish)

🐛 Bug Fix

  • #103 Left-align rule list column headers (@bmish)
  • #102 Use Name instead of Rule for rule list column header (@bmish)
  • #101 Improve notice/legend wording consistency and conciseness (@bmish)

Committers: 1

v0.7.0 (2022-10-09)

🚀 Enhancement

  • #93 Add --ignore-config option (@bmish)
  • #92 Add --ignore-deprecated-rules option (@bmish)

Committers: 1

v0.6.0 (2022-10-09)

🚀 Enhancement

  • #84 Add --rule-doc-section-include and --rule-doc-section-exclude options (@bmish)
  • #83 Add --rule-doc-title-format option (@bmish)
  • #82 Add --url-configs option (@bmish)

🐛 Bug Fix

  • #87 Handle when prettier is not installed (@bmish)
  • #81 Throw error when missing README.md (@bmish)
  • #80 Throw error when missing rule doc (@bmish)

Committers: 1

v0.5.0 (2022-10-08)

🚀 Enhancement

  • #75 Automatically generate legend for rules list (@bmish)
  • #76 Hide empty columns from rules list (@bmish)
  • #73 Hide config column from rules list when no configs present and move deprecations to a separate column (@bmish)

🐛 Bug Fix

  • #72 Improve section header detection (@bmish)

📝 Documentation

Committers: 2

v0.4.0 (2022-10-07)

🐛 Bug Fix

  • #70 Handle string extends from ESLint config, deprecated/function-style rules, missing rule descriptions (and use actual ESLint types to detect issues like these) (@bmish)

Committers: 1

v0.3.5 (2022-10-06)

🐛 Bug Fix

Committers: 1

v0.3.4 (2022-10-05)

🐛 Bug Fix

  • #62 Fix plugin importing on Windows (@bmish)

Committers: 1

v0.3.3 (2022-10-04)

🐛 Bug Fix

  • #60 Ignore external configs during ESLint config resolution (@bmish)

Committers: 1

v0.3.2 (2022-10-04)

🐛 Bug Fix

  • #59 Resolve extends in ESLint configs (@bmish)

🏠 Internal

Committers: 1

v0.3.1 (2022-10-03)

🐛 Bug Fix

  • #48 Only apply prettier formatting to managed doc content (@bmish)

Committers: 1

v0.3.0 (2022-10-02)

🐛 Bug Fix

  • #47 Throw exception when plugin does not export a rules object (@bmish)
  • #45 Handle various possible names for options section when checking for its presence in rule doc (@bmish)
  • #43 Improved detection for README rules section when marker comments are missing (@bmish)
  • #42 Allow plugin to omit configs (@bmish)
  • #41 Handle scoped plugin names (@bmish)
  • #40 Description in rule doc title should begin with a capital letter and omit a trailing period (@bmish)
  • #39 Add plugin prefix to rule name in rule doc title (@bmish)
  • #28 Use prettier's own config resolution when formatting docs (@bmish)

Committers: 1

v0.2.0 (2022-10-01)

🚀 Enhancement

  • #17 Automatically insert missing rule list markers in README rules section (@bmish)

🐛 Bug Fix

  • #18 Allow deprecated rules to forgo a doc file or description (@bmish)
  • #12 Avoid creating a duplicate title when rule doc is missing marker comment (@bmish)
  • #8 Use recommended config emoji in rule doc when rule is only in that config (@bmish)
  • #7 Use recommended config emoji in rules list header when no custom configs present (@bmish)

📝 Documentation

  • #19 Tweak README (@bmish)
  • #11 Provide rule list marker comments in error message when missing from README (@bmish)

🏠 Internal

  • #6 Move emojis into centralized file (@bmish)

Committers: 1

v0.1.1 (2022-10-01)

🐛 Bug Fix

  • #5 Add missing Node shebang to binary (@bmish)

Committers: 1

v0.1.0 (2022-10-01)

🚀 Enhancement

🏠 Internal

Committers: 2