Repo: Ideas for avoiding drift between a renamed rule and the original about typescript-eslint

[bradzacher]

I think an existing rule should be able to be written as something like

export default Object.assign(
  {},
  renamedRule,
  {
    name: "old-name",
    meta: Object.assign(
      {},
      renamedRule.meta,
      {
        deprecated: true,
        replacedBy: ['new-rule-name'],
      },
    ),
  },
);

and everything should work as expected then. It'll cause syntactic conflicts with anyone trying to modify the old file and it'll ensure we only have one copy of the file in the codebase.

[bradzacher]

on small fix that replacedBy should be replacedBy: [renamedRule.name]
could make this a util for future renaming efforts.

[kirkwaiblinger]

@bradzacher
Nice! That basically worked perfectly. (Only trivial change was the doc link)

import noUselessTemplateExpression from './no-useless-template-expression';

export default {
  ...noUselessTemplateExpression,
  ...{
    name: 'no-useless-template-literals',
    meta: {
      ...noUselessTemplateExpression.meta,
      ...{
        deprecated: true,
        replacedBy: ['no-useless-template-expression'],
      },
      docs: {
        ...noUselessTemplateExpression.meta.docs,
        url: 'https://typescript-eslint.io/rules/no-useless-template-literals',
      },
    },
  },
};

The only thing this doesn't address, then, is the copypasta of the tests.... But maybe that's not so important as long as the rule is written in this way? What do you think?

[kirkwaiblinger]

I like that!

fun fact - our rules don't actually have the name property right now 😮 (at runtime or in the types; it gets used in the url creation then immediately dropped). Will take some slightly tedious tweaking of RuleCreator types to get this working.

[bradzacher]

Oh I thought that we started persisting the name for our doc gen infra.