Misleading instructions at role prefer-property-order

[moshest]

My package.json look like this:

{
  "name": "foo",
  "version": "1.2.3",
  "main": "index.js",
  "repository": "https://github.com/foo/bar",
  "bugs": "https://github.com/foo/bar/issues"
}

With the default ordering bugs should be after version but the message I get is:

Your package.json properties are not in the desired order. Please move bugs before repository.

If I will put bugs before repository I will get:

Your package.json properties are not in the desired order. Please move bugs before main.

I think that better instructions will be (notice the quotes I added also):

Your package.json properties are not in the desired order. Please move "bugs" after "version".

My version is: 2.8.2

[tclindner]

Hi @moshest this is a bit tricky. We don’t require all properties in the list to be in the package.json file. Do you have any recommendations on how to approach this problem? I plan on looking at it more this week.

[moshest]

Yes, I think that should do it:

const propertiesOrder = ['name', 'version', ...];

const orderMap = new Map();
propertiesOrder.forEach((property, index) => {
  orderMap.set(property, index);
});

let i = 0;
Object.keys(packageJson).forEach((property, index) => {
  if (!orderMap.has(property)) return;
  
  const pos = orderMap.get(property);
  if (pos === i) {
    i += 1;
    return;
  }

  if (i > 0) {
    throw new Error(`Please move "${property}" after "${propertiesOrder[i - 1]}".`);
  } else {
    throw new Error(`Please move "${property}" to the top`);
  }
});

To solve #57, We should filter propertiesOrder first:

let propertiesOrder = ['name', 'version', ...];
propertiesOrder = propertiesOrder.filter(property => packageJson.hasOwnProperty(property));

[tclindner]

Thanks for the feedback, @moshest!

[tclindner]

Hi @moshest v2.10.0 has been released! Thank you again.

[moshest]

It's works great!
A added a PR with a small fix the the error message (already tested on my packages).

[tclindner]

Awesome! 🥇