feat: allow extending settings via config

[blackxored]

Simplified usage (there's a lot more dynamic stuff on my config, so apologies for typos/syntax):

module.exports = {
  extends: ['@commitlint/config-angular'],
  settings: {
    scope: {
      enumerables: {
         "auth": { description: "Authentication code, login, user profile, etc." },
         "settings": { description: "Settings and preferences" },
      }
    },
  },
  rules: {
    'scope-enum': () => {
      const scopes = ['auth', 'settings'];
      return [2, 'always', scopes.concat(['system'])];
    },
  },
};

[marionebl]

Thanks for contributing this PR. I'd prefer a format that combines the enum values with the descriptions, e.g.:

  rules: {
    'scope-enum': () => {
      const scopes = [
          {value: 'auth', description: 'something something' }, 
          {value: 'settings', description: 'something differnt'}
      ];
      return [2, 'always', scopes];
    }
  }

Cool things about this:

• Can be implemented while maintaining backwards compat
• Keep unified API for all commitlint tools
• Make help texts available in liniting eventually
• Can be adapted beyond the *-enum fields

What do you think?

[blackxored]

Hi, unfortunately I’m not yet that familiar to the codebase to be able to come up with a new format or something that’s scope specific. I took a look at the settings at prompt and replicated that format.

[marionebl]

Yeah sure, I'd implement that change myself. I'd like your perspective as an API consumer on that one, though.

[RayBenefield]

@marionebl I think the API you proposed looks solid for me as a consumer. I was actually just looking for this feature now so I hope this gets implemented soon. :)

[blackxored]

I think the problem with that is that while it solves the scope problem, we'll need something custom just like this for, let's say, types, or something else configs might want to change, so you're not really "extending" the config; which is exactly where I started and had to modify prompt itself to be able to get help descriptions. In that case, they were missing and accepted but that won't always be the case for custom config authors.

IMHO think having both would the best but I'd definitely give this one a second look.

[marionebl]

Closing this for now. The extension of the configuration by "described values" is on the roadmap.

[mogelbrod]

Closing this for now. The extension of the configuration by "described values" is on the roadmap.

Any progress on this? Couldn't find any mention outside of the README.

[escapedcat]

Any progress on this? Couldn't find any mention outside of the README.

Hey @mogelbrod , didn't see your comment, sorry. There wasn't any progress afaik.