Merge pull request #56 from snyk/fix/properties-naming

fix: schema properties should use snake case names

docs/standards.md

@@ -66,7 +66,7 @@ Entities will be commonly represented as types or classes when generating code.
 
 ### Schema properties
 
-Schema properties use **camel case** names.
+Schema properties use **snake case** names.
 
 ### Operation IDs
 

naming.yaml

@@ -24,6 +24,16 @@ rules:
       functionOptions:
         type: snake
 
+  property-names-snake-case:
+    description: Property names must be snake_case.
+    message: '{{description}}'
+    severity: error
+    given: $..properties[*]~
+    then:
+      function: casing
+      functionOptions:
+        type: snake
+
   component-names-pascal-case:
     description: Component names must be PascalCase (except responses).
     message: '{{description}}'

tests/propCasing.test.js

@@ -0,0 +1,71 @@
+const { Spectral } = require('@stoplight/spectral-core');
+const { loadRules, loadSpec } = require('./utils');
+
+let rules;
+
+beforeAll(async () => {
+  rules = await loadRules('naming.yaml');
+});
+
+it('fails on snake case violation', async () => {
+  const spectral = new Spectral();
+  spectral.setRuleset(rules);
+  const result = await spectral.run(loadSpec('fixtures/propCasing.fail.yaml'));
+  expect(result).toHaveLength(8);
+  expect(result).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        code: 'property-names-snake-case',
+        path: [
+          'components',
+          'schemas',
+          'HelloWorld',
+          'properties',
+          'attributes',
+          'properties',
+          'deprecatedField',
+        ],
+      }),
+      expect.objectContaining({
+        code: 'property-names-snake-case',
+        path: [
+          'components',
+          'schemas',
+          'HelloWorld',
+          'properties',
+          'attributes',
+          'properties',
+          'requestSubject',
+        ],
+      }),
+      expect.objectContaining({
+        code: 'property-names-snake-case',
+        path: [
+          'components',
+          'schemas',
+          'HelloWorld',
+          'properties',
+          'attributes',
+          'properties',
+          'requestSubject',
+          'properties',
+          'clientId',
+        ],
+      }),
+      expect.objectContaining({
+        code: 'property-names-snake-case',
+        path: [
+          'components',
+          'schemas',
+          'HelloWorld',
+          'properties',
+          'attributes',
+          'properties',
+          'requestSubject',
+          'properties',
+          'publicId',
+        ],
+      }),
+    ]),
+  );
+});