Plan V4 Release

[bmish]

Planned changes for v4

• Add exports to package.json to restrict access to private internals #2208
  • Expose generateRuleTests as named export in public NodeJS API #2209
  • Should we expose lib/helpers/create-error-message (used here)? For now, decided no.
• Convert to ESM #2262
• Require Node ^12.22.0 || ^14.17.0 || >=16.0.0 #2176
• Remove deprecated CLI options
  • Remove CLI option --json #2193
  • Remove CLI option --print-pending #2207
• Remove deprecated properties / behavior
  • // TODO: add a deprecation for accessing _filePath
  • The _moduleName property used in the '${this.ruleName}' rule has been removed. Please use _filePath instead.
• Update core linting / rule reporting behavior
  • Rule Reporting: When logging a rule violation, require passing the node or all loc properties #2228
  • Rule Reporting: When logging a rule violation, require passing message #2242
  • Disallow specifying non-existent files on CLI #2245
  • Disallow unknown CLI options #2261
• Remove deprecated rules
  • Remove rule deprecated-each-syntax #2191
  • Remove rule no-invalid-block-param-definition #2188
• Update rule configs
  • Rule Configs: Remove config octane #2192
  • Rule Configs: Add additional recommended rules for v4 #2211
  • Rule Configs: Remove config 2-x-recommended and add 3-x-recommended config #2237
  • Rule Configs: Add no-autofocus-attribute to recommended config #2256
• Update rule behavior
  • Update no-invalid-link-title rule to check for link title being substring of link text #1881
  • Update no-invalid-link-text rule to set allowEmptyLinks option default to false #2195
  • Update no-bare-strings rule to check the arguments to {{page-title ...}} helper #2089
  • Update no-bare-strings rule options to augment instead of replace the default config  #2241
  • Update no-element-event-actions rule to set requireActionHelper option default to false #2278
  • Rename and narrow rule no-down-event-binding to no-pointer-down-event-binding #2054 (only will be included if PR gets finished)
• Update test behavior
  • Testing: Disallow unexpected properties in rule test cases #2216
  • Testing: Require auto-fixable test cases to assert the fixed template #2217
  • Testing: Only fixable test cases are allowed to assert fixedTemplate #2230
  • Testing: Disallow identical template and fixedTemplate in a test case #2240
  • Testing: Disallow duplicate test cases #2279
    • Fix false positives with non-serializable rule configs in duplicate test case check #2301
• Remove pending internals
  • Remove deprecated pending functionality #2252
• Update core TODO functionality
  • Todos: Convert to single file storage #2255
• Update config file behavior
  • Config Files: Disallow unexpected properties at top-level of configuration file #2236
  • Config Files: Disallow extending an invalid configuration #2238
  • Config Files: Disallow invalid plugin in configuration file #2239
• Update non-ESM dependencies
  • Upgrade ember-template-recast to v6 #2172
  • Upgrade yargs dependency to v17 #2197
• Update ESM dependencies
  • Update chalk to v5 #2292 (dependency)
  • Update execa to v6 #2295 (dev-dependency)
  • Upgrade find-up to v6 #2293 (dependency)
  • Upgrade get-stdin to v9 #2294 (dependency)
  • Upgrade globby to v6 #2296 (dependency)
• New features unblocked in v4
  • Add autofixer to quotes rule #2143
• Add v4 migration guide #2297

Future changes for v5

• Require rules with options to provide a JSON Schema in meta.options like ESLint. This is a large feature and requires the meta property for rules to be implemented.

Pre-release checklist:

• Release a minor/patch version ahead of the major release for any non-breaking changes
• Test with Ember v4
• Test on large codebases
• Advertise in Ember Times newsletter: Add ember-template-lint v4 section to No. 192 - November 28th 2021 ember-learn/ember-blog#1061

Post-release checklist:

• Advertise in Ember Times newsletter: Add ember-template-lint v4 section to No. 194 ember-learn/ember-blog#1086
• Upgrade to ember-template-lint v4 in blueprint ember-cli/ember-cli#9753

Pre-release versions:

• v4.0.0-beta.3 (2021-12-29)
• v4.0.0-beta.2 (2021-12-23)
• v4.0.0-beta.1 (2021-12-15)
• v4.0.0-beta.0 (2021-12-03)
• v4.0.0-alpha.0 (2021-11-24)

See the migration guide for a summary.

Please edit this list directly or reply in a comment to suggest additional changes to include or provide feedback about existing changes. Help with testing or implementing changes/fixes is welcome!

For reference, V3 was released 2021-03-02 (#1315).

Release command for betas:

EDITOR=vim  yarn release --preReleaseId=beta --npm.tag=next --github.preRelease 

[dcyriller]

Hi @bmish, #2172 upgrades @glimmer/syntax from v0.65.0 to v0.83.0 via ember-template-recast v6. It will probably be a breaking change and could be released in the same release train? I am adding it to the list.

[bmish]

@ember-template-lint/maintainers we actually have a pretty large list of breaking changes lined up here already. It would be straightforward for me to address all of the current items when we decide we're ready to proceed with a major release. So it could be a good time for a major release soon.

Open questions:

1. I added all the new rules since v3 to the list of new recommended rules. Let me know if any of these are unsuitable, or if there are other additional rules we should add to the recommended config.
2. Should we add exports to package.json to restrict access to package internals? ESLint v8 did this too, but I'm not sure if there are valid/necessary use cases for accessing package internals directly in our plugin.
3. We could consider converting this plugin to ESM. While most of this involve updating imports/exports, there could be some tricky parts too, so I'm not sure how much work it would be yet. If too much work or too big of a change, I'm not attached to it being part of this release.
4. Are there other breaking changes we should add to this list?
5. Is it a good time for a major release?

[lifeart]

1.) I think we could add:

• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-capital-arguments.md because capital arguments is not working in ember
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-class-bindings.md
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-element-event-actions.md
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-dynamic-subexpression-invocations.md
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-link-to-tagname.md
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-model-argument-in-route-templates.md
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-mut-helper.md
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-route-action.md
• https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-yield-to-default.md

[bmish]

To get the ball rolling on this, I've begun merging changes into the next branch. I've also added more breaking changes to the list in this ticket. I still need to review the proposed list of new recommended rules. Interested to gather feedback from others too. Once we have all these changes ready in next, we can release an alpha version.