feat: add the ability to ignored keys while sorting

tests/rules/test_key_ordering.py

@@ -147,3 +147,28 @@ def test_locale_accents(self):
                    'hais: true\n'
                    'haïr: true\n', conf,
                    problem=(3, 1))
+
+    def test_ignored_key(self):
+        conf = 'key-ordering:\n  ignored: ["name"]'
+        self.check('---\n'
+                   'versions:\n'
+                   '  - name: v1alpha1\n'
+                   '    foo: bar\n'
+                   '  - name: v2\n'
+                   '    baz: qux\n', conf)
+        self.check('---\n'
+                   'versions:\n'
+                   '  - name: v1alpha1\n'
+                   '    foo: bar\n'
+                   '    baz: qux\n'
+                   '  - name: v2\n'
+                   '    baz: qux\n'
+                   '  - baz: qux\n'
+                   '    name: v3\n'
+                   '    value: whatever\n', conf,
+                   problem=(5, 5))
+        self.check('---\n'
+                   'age: 30\n'
+                   'name: John\n'
+                   'address: 123 Street\n', conf,
+                   problem=(4, 1))

yamllint/rules/key_ordering.py

@@ -19,6 +19,7 @@
 ordering is case-sensitive and not accent-friendly (see examples below).
 This can be changed by setting the global ``locale`` option.  This allows one
 to sort case and accents properly.
+It also allows one to ignore certain keys by setting the ``ignored`` option.
 
 .. rubric:: Examples
 
@@ -78,6 +79,15 @@
       haïr: true
       hais: true
       haïssable: true
+
+#. With rule ``key-ordering: {ignored: ["name"]}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    - name: John
+      age: 30
+      city: New York
 """
 
 from locale import strcoll
@@ -88,7 +98,8 @@
 
 ID = 'key-ordering'
 TYPE = 'token'
-
+CONF = {'ignored': [str]}
+DEFAULT = {'ignored': []}
 MAP, SEQ = range(2)
 
 
@@ -118,7 +129,8 @@ def check(conf, token, prev, next, nextnext, context):
         # sequences... strange, but allowed.
         if len(context['stack']) > 0 and context['stack'][-1].type == MAP:
             if any(strcoll(next.value, key) < 0
-                   for key in context['stack'][-1].keys):
+                    for key in context['stack'][-1].keys
+                    if key not in conf['ignored']):
                 yield LintProblem(
                     next.start_mark.line + 1, next.start_mark.column + 1,
                     f'wrong ordering of key "{next.value}" in mapping')