feat(Dpe 135): naming rules

[EthanHonzikSPS]

• Created a ruleset schema
• installed jest types
• added a tsconfig.json such that JS files will be validated for type errors
• updated the camel case rule to use the built in casing function instead of regex to get performance
• Addressed all the comments on the confluence page
• Updated documentation with links

[EthanHonzikSPS]

Performance:

Overall performance improved from 30 seconds down to 23 seconds to run the entire performance test suite. I suspect this is due to using the built in casing function instead of regex.

Problems:

Camel Case

Camel case rule has a very large impact on Identity-service with multi-hundred errors. Network-configuration-service has over 1000 errors. We will likely have to change the severity from error to warning.

General

Warnings had a large jump due to the various naming conventions network-configuration-service again had the largest jump with around 600 additional warnings from the original 254 warnings

[brandonsahadeo]

Couple of questions

[markdebeer]

Looks good to me! Just a few copy/paste issues. As far as the impact test, we should chat as a team about whether we need to start leveraging the recommended property -> https://docs.stoplight.io/docs/spectral/0a73453054745-recommended-or-all

[travisgosselin]

What is the impact specifically on network API related specs (ones that should be conforming already)?

[travisgosselin]

Performance:

Overall performance improved from 30 seconds down to 23 seconds to run the entire performance test suite. I suspect this is due to using the built in casing function instead of regex.

Problems:

Camel Case

Camel case rule has a very large impact on Identity-service with multi-hundred errors. Network-configuration-service has over 1000 errors. We will likely have to change the severity from error to warning.

General

Warnings had a large jump due to the various naming conventions network-configuration-service again had the largest jump with around 600 additional warnings from the original 254 warnings

What was the original rule you were referring to with the regex for camelCase? I didn't see it in the comparison of naming.ruleset.yml...

[EthanHonzikSPS]

What is the impact specifically on network API related specs (ones that should be conforming already)?

With camel case changed to a warning there's a couple additional errors that occur with the sps-invalid-created-date-time-type rule. Additionally there is a bit of uptick in warnings anywhere from 1 to 9. Most of these are camel case issues but there's a couple miscellaneous ones as well.

What was the original rule you were referring to with the regex for camelCase? I didn't see it in the comparison of naming.ruleset.yml...

sps-camel-case-properties regex when I first cloned it, This I'm now realizing was included in @brandonsahadeo's first commit to this branch and wasn't a part of main.

[travisgosselin]

What is the impact specifically on network API related specs (ones that should be conforming already)?

With camel case changed to a warning there's a couple additional errors that occur with the sps-invalid-created-date-time-type rule. Additionally there is a bit of uptick in warnings anywhere from 1 to 9. Most of these are camel case issues but there's a couple miscellaneous ones as well.

OK as long as we feel confident that these are legit issues detected and are mistakes by the team then this is great. How many warnings do the camel case change generate on the network apis? Is it a lot?

What was the original rule you were referring to with the regex for camelCase? I didn't see it in the comparison of naming.ruleset.yml...

sps-camel-case-properties regex when I first cloned it, This I'm now realizing was included in @brandonsahadeo's first commit to this branch and wasn't a part of main.

ah OK makes more sense, was looking for it. So no real performance change against main then.

[EthanHonzikSPS]

I discovered the camel case rule was failing properties with digits. After allowing digits there were no camel casing issues. As such I've changed it back to an error.
This is the performance and impact of the rules in their current state.

[EthanHonzikSPS]

@brandonsahadeo Here's the performance test impact.