Add optional name to extended rule object

[pajter]

First of all, thanks for this plugin! It's really helpful.

I've added the ability to name an extended rule object. This can improve the user experience by showing a more friendly error message.

Here's an example:

{
  type: 'rule',
  name: 'Pseudo Element',
  selector: /^&::/,
},
{
  type: 'rule',
  name: 'BEM Element',
  selector: /^&__/,
}

Instead of this message:

Expected rule with selector matching "/^&::/" to come before rule with selector matching "/^&__/"

You would get this message:

Expected rule "Pseudo Element" to come before rule "BEM Element".

I updated the docs, changelog and tests. Please let me know if I missed anything!

[hudochenkov]

That's a great idea!

Everything looks very good. Thank you for putting extra effort and adding tests!

Could you please update

stylelint-order/rules/order/validatePrimaryOption.js

Line 62 in 11604e6

if (item.type === 'rule') {

to include:

if (!_.isUndefined(item.name)) {
	result = _.isString(item.name) && item.name.length;
}

It will check name property if it's valid.

[pajter]

Good catch! I added the extra check and some more tests.

[hudochenkov]

Thank you! I'll try to release this weekend.

[hudochenkov]

stylelint-order@4.1.0 is released!