Commitlint - Types for '.commitlintrc.js'

Question

In the .commitlintrc.js file, I wanted to type the exported configuration option, so that my IDE could suggest possible options.

/** @type {import('@commitlint/types').UserConfig} */
module.exports = {
  extends: ["@commitlint/config-conventional"],
}

But it doesn't work for some reason (no suggestions) and I don't know what I'm missing here.

index.d.ts is located in node_modules/@commitlint/types/lib/index.d.ts

In @commitlint/types, the UserConfig is exported like this (https://github.com/conventional-changelog/commitlint/blob/v17.7.1/%40commitlint/types/src/load.ts#L23):

export interface UserConfig {
    extends?: string | string[];
    // other options...
}

---

I've used the same approach for prettier & stylelint config and in that case I get suggestions in my IDE:

/** @type {import('stylelint').Config} */
module.exports = {
  extends: [....]
}

/** @type {import('prettier').Config} */
module.exports = {
  printWidth: 100,
  singleQuote: true,
  jsxSingleQuote: true
};

---

As described in the docs, I can make a ts file with the following content:

import type {UserConfig} from '@commitlint/types';

const Configuration: UserConfig = {
  extends: ["@commitlint/config-conventional"],
};

module.exports = Configuration;

The above approach works; however, I don't understand what is missing in the initial config.

Answer 1

I just had the same issue and was able to make it work with one indirection

/** @type {import('@commitlint/types').UserConfig} */
const config = {
  extends: []
};

module.exports = config;