[naming-convention] Update property schema to accept objects. Add pre…

…fix and suffix option (#201) Co-authored-by: Dotan Simha <dotansimha@gmail.com>
dimaMachina · Dec 23, 2020 · 174a66f · 174a66f
1 parent 5e1bbe6
commit 174a66f
Show file tree

Hide file tree

Showing 7 changed files with 301 additions and 118 deletions.
diff --git a/.changeset/fuzzy-mice-return.md b/.changeset/fuzzy-mice-return.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+[naming-convention] Allow each definition to take either a strng or object. Object can take the following keys: style (naming style), prefix (value must have prefix) and suffix (value must have suffix)
diff --git a/docs/rules/naming-convention.md b/docs/rules/naming-convention.md
@@ -37,104 +37,82 @@ The schema defines an array with all elements of the type `object`.
 
 The array object has the following properties:
 
-#### `FieldDefinition` (string, enum)
+#### `FieldDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `InputObjectTypeDefinition` (string, enum)
+#### `InputObjectTypeDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `EnumValueDefinition` (string, enum)
+#### `EnumValueDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `InputValueDefinition` (string, enum)
+#### `InputValueDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `ObjectTypeDefinition` (string, enum)
+#### `ObjectTypeDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `InterfaceTypeDefinition` (string, enum)
+#### `InterfaceTypeDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `EnumTypeDefinition` (string, enum)
+#### `EnumTypeDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `UnionTypeDefinition` (string, enum)
+#### `UnionTypeDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `ScalarTypeDefinition` (string, enum)
+#### `ScalarTypeDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `OperationDefinition` (string, enum)
+#### `OperationDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
-#### `FragmentDefinition` (string, enum)
+#### `FragmentDefinition`
 
-This element must be one of the following enum values:
+The object must be one of the following types:
 
-* `camelCase`
-* `PascalCase`
-* `snake_case`
-* `UPPER_CASE`
+* `asString`
+* `asObject`
 
 #### `leadingUnderscore` (string, enum)
 
@@ -152,4 +130,31 @@ This element must be one of the following enum values:
 * `allow`
 * `forbid`
 
-Default: `"forbid"`
+Default: `"forbid"`
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `asString` (string)
+
+One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`
+
+## `asObject` (object)
+
+Properties of the `asObject` object:
+
+### `style` (string, enum)
+
+This element must be one of the following enum values:
+
+* `camelCase`
+* `PascalCase`
+* `snake_case`
+* `UPPER_CASE`
+
+### `prefix` (string)
+
+### `suffix` (string)
diff --git a/docs/rules/require-description.md b/docs/rules/require-description.md
@@ -37,4 +37,20 @@ type someTypeName {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
+
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `on` (array)
+
+The object is an array with all elements of the type `string`.
+
+Additional restrictions:
+
+* Minimum items: `1`
+
+Additional restrictions:
+
+* Minimum items: `1`
diff --git a/docs/rules/require-id-when-available.md b/docs/rules/require-id-when-available.md
@@ -50,4 +50,12 @@ query user {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
+
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `fieldName` (string)
+
+Default: `"id"`