test: add ignores test

Author: hyiso

lib/src/lint.dart

@@ -1,3 +1,4 @@
+
 import 'is_ignored.dart';
 import 'parse.dart';
 import 'rules.dart';
@@ -29,7 +30,7 @@ Future<LintOutcome> lint(String message, Map<String, Rule> rules,
   if (missing.isNotEmpty) {
     final names = [...allRules.keys];
     throw RangeError(
-        'Found invalid rule names: ${missing.join(', ')}. Supported rule names are: ${names.join(', ')}');
+        'Found invalid rule names: ${missing.join(', ')}. \nSupported rule names are: ${names.join(', ')}');
   }
 
   /// Validate against all rules

lib/src/load.dart

@@ -28,17 +28,14 @@ Future<CommitLint> load(
   if (file != null && file.existsSync()) {
     final yaml = loadYaml(await file.readAsString());
     final include = yaml?['include'] as String?;
-    final rulesMap = yaml?['rules'] as Map?;
-    Map<String, Rule> rules = {};
-    if (rulesMap != null) {
-      for (var entry in rulesMap.entries) {
-        rules[entry.key] = _extractRule(entry.value);
-      }
-    }
+    final rules = yaml?['rules'] as YamlMap?;
+    final ignores = yaml?['ignores'] as YamlList?;
+    final defaultIgnores = yaml?['defaultIgnores'] as bool?;
     final config = CommitLint(
-        rules: rules,
-        deafultIgnores: yaml?['deafultIgnores'] as bool?,
-        ignores: yaml?['ignores'] as Iterable<String>?);
+        rules: rules?.map((key, value) => MapEntry(key, _extractRule(value))) ??
+            {},
+        ignores: ignores?.cast(),
+        defaultIgnores: defaultIgnores);
     if (include != null) {
       final upstream = await load(include, directory: file.parent);
       return config.inherit(upstream);

lib/src/runner.dart

@@ -47,7 +47,7 @@ class CommitLintRunner extends CommandRunner {
     final config = await load(topLevelResults['config']);
     final results = (await Future.wait(messages.map((message) async =>
         await lint(message, config.rules,
-            defaultIgnores: config.deafultIgnores, ignores: config.ignores))));
+            defaultIgnores: config.defaultIgnores, ignores: config.ignores))));
     if (config.rules.isEmpty) {
       String input = '';
       if (results.isNotEmpty) {

lib/src/types/commitlint.dart

@@ -1,11 +1,11 @@
 import 'rule.dart';
 
 class CommitLint {
-  CommitLint({this.rules = const {}, this.deafultIgnores, this.ignores});
+  CommitLint({this.rules = const {}, this.defaultIgnores, this.ignores});
 
   final Map<String, Rule> rules;
 
-  final bool? deafultIgnores;
+  final bool? defaultIgnores;
 
   final Iterable<String>? ignores;
 
@@ -15,7 +15,7 @@ class CommitLint {
         ...other.rules,
         ...rules,
       },
-      deafultIgnores: other.deafultIgnores ?? deafultIgnores,
+      defaultIgnores: defaultIgnores ?? other.defaultIgnores,
       ignores: [
         ...?other.ignores,
         ...?ignores,

test/__fixtures__/include-package.yaml

@@ -4,4 +4,7 @@ rules:
   type-case:
     - 2
     - always
-    - 'upper-case'
+    - 'upper-case'
+
+ignores:
+  - r'^fixup'

test/__fixtures__/include-path.yaml

@@ -4,4 +4,8 @@ rules:
   type-case:
     - 2
     - always
-    - 'upper-case'
+    - 'upper-case'
+
+defaultIgnores: false
+ignores:
+  - r'^fixup'

test/lint_test.dart

@@ -62,4 +62,33 @@ void main() {
         defaultIgnores: false);
     expect(result.valid, false);
   });
+
+  test('positive on custom ignored message and broken rule', () async {
+    final ignoredMessage = 'some ignored custom message';
+    final result = await lint(ignoredMessage, {
+      'type-empty': Rule(
+        severity: RuleSeverity.error,
+        condition: RuleCondition.never,
+      ),
+    }, ignores: [
+      ignoredMessage
+    ]);
+    expect(result.valid, true);
+    expect(result.input, equals(ignoredMessage));
+  });
+
+  test('throws for invalid rule names', () async {
+    await expectLater(
+        lint('foo', {
+          'foo': Rule(
+            severity: RuleSeverity.error,
+            condition: RuleCondition.always,
+          ),
+          'bar': Rule(
+            severity: RuleSeverity.warning,
+            condition: RuleCondition.never,
+          ),
+        }),
+        throwsRangeError);
+  });
 }

test/load_test.dart

@@ -17,6 +17,8 @@ void main() {
     expect((config.rules['type-case'] as CaseRule).type, Case.lower);
     expect((config.rules['type-enum'] as EnumRule).allowed,
         equals(['feat', 'fix', 'docs', 'chore']));
+    expect(config.defaultIgnores, equals(null));
+    expect(config.ignores, equals(null));
   });
   test('include relative path should work', () async {
     final config = await load('test/__fixtures__/include-path.yaml');
@@ -25,6 +27,8 @@ void main() {
     expect(config.rules['type-case'], isA<CaseRule>());
     expect(config.rules['type-enum'], isA<EnumRule>());
     expect((config.rules['type-case'] as CaseRule).type, Case.upper);
+    expect(config.defaultIgnores, equals(false));
+    expect(config.ignores, equals(["r'^fixup'"]));
   });
   test('include package path should work', () async {
     final config = await load('test/__fixtures__/include-package.yaml');
@@ -33,5 +37,7 @@ void main() {
     expect(config.rules['type-case'], isA<CaseRule>());
     expect(config.rules['type-enum'], isA<EnumRule>());
     expect((config.rules['type-case'] as CaseRule).type, Case.upper);
+    expect(config.defaultIgnores, equals(null));
+    expect(config.ignores, equals(["r'^fixup'"]));
   });
 }