Flat config support & improvements for d.ts

[what1s1ove]

Hey guys! First of all, thank you for such a cool plugin!

Since ESLint 9 is soon to be released, are there any plans to add a Flat config and, equally importantly, improve the d.ts files of the plugin?

eslint.config.js:17:3 - error TS2322: Type 'typeof import("node_modules/eslint-plugin-lit/lib/index")' is not assignable to type 'Plugin'.
  Types of property 'configs' are incompatible.
    Type '{ all: { plugins: string[]; rules: { 'lit/attribute-value-entities': string; 'lit/binding-positions': string; 'lit/lifecycle-super': string; 'lit/no-duplicate-template-bindings': string; 'lit/no-invalid-escape-sequences': string; ... 15 more ...; 'lit/value-after-constraints': string; }; }; recommended: { ...; }; }' is not assignable to type 'Record<string, FlatConfig | ConfigData<RulesRecord> | FlatConfig[]>'.
      Property 'all' is incompatible with index signature.
        Type '{ plugins: string[]; rules: { 'lit/attribute-value-entities': string; 'lit/binding-positions': string; 'lit/lifecycle-super': string; 'lit/no-duplicate-template-bindings': string; 'lit/no-invalid-escape-sequences': string; ... 15 more ...; 'lit/value-after-constraints': string; }; }' is not assignable to type 'FlatConfig | ConfigData<RulesRecord> | FlatConfig[]'.
          Type '{ plugins: string[]; rules: { 'lit/attribute-value-entities': string; 'lit/binding-positions': string; 'lit/lifecycle-super': string; 'lit/no-duplicate-template-bindings': string; 'lit/no-invalid-escape-sequences': string; ... 15 more ...; 'lit/value-after-constraints': string; }; }' is not assignable to type 'ConfigData<RulesRecord>'.
            Types of property 'rules' are incompatible.
              Type '{ 'lit/attribute-value-entities': string; 'lit/binding-positions': string; 'lit/lifecycle-super': string; 'lit/no-duplicate-template-bindings': string; 'lit/no-invalid-escape-sequences': string; ... 15 more ...; 'lit/value-after-constraints': string; }' is not assignable to type 'Partial<RulesRecord>'.
                Property ''lit/attribute-value-entities'' is incompatible with index signature.
                  Type 'string' is not assignable to type 'RuleEntry<any[]> | undefined'.

17   lit,
     ~~~

eslint.config.js:19:2 - error TS2322: Type '{ 'lit/attribute-value-entities': string; 'lit/binding-positions': string; 'lit/lifecycle-super': string; 'lit/no-duplicate-template-bindings': string; 'lit/no-invalid-escape-sequences': string; ... 15 more ...; 'lit/value-after-constraints': string; }' is not assignable to type 'RulesRecord'.
  Property ''lit/attribute-value-entities'' is incompatible with index signature.
    Type 'string' is not assignable to type 'RuleEntry<any[]>'.

19  rules: lit.configs.all.rules,
    ~~~~~

  ../../node_modules/@types/eslint/index.d.ts:1116:9
    1116         rules?: RulesRecord;
                 ~~~~~
    The expected type comes from property 'rules' which is declared here on type 'FlatConfig'

[43081j]

would love to add support for flat config, just haven't had chance yet to fully understand how to have "dual" support (i.e. support flag config and rc files)

ill ask around but i think we would need to have two exported config sets

a flat config needs the plugin as a reference afaik, while an rc config needs it as a string

[what1s1ove]

would love to add support for flat config, just haven't had chance yet to fully understand how to have "dual" support (i.e. support flag config and rc files)

ill ask around but i think we would need to have two exported config sets

a flat config needs the plugin as a reference afaik, while an rc config needs it as a string

Recently, several plugins have migrated to similar support. You might find it interesting to take a look.

• eslint-plugin-jsdoc – @types/eslint-plugin-jsdoc or bundle .d.ts gajus/eslint-plugin-jsdoc#1130
• eslint-plugin-typescript – ESLint Flat Config Support typescript-eslint/typescript-eslint#7694

By the way, here in the issue of my personal project what1s1ove/whatislove.dev#270 where I track the migration progress of my favorite plugins. You can find issues of some other well-known plugins that are in the process of migration.