feat(core): Code tidy

README.md

@@ -1,6 +1,6 @@
 <img src=".github/logo.png" width="190" alt="RulePilot" />
 
-[![npm version](https://badge.fury.io/js/rulepilot.svg)](https://badge.fury.io/js/rulepilot?v1.2.1)
+[![npm version](https://badge.fury.io/js/rulepilot.svg)](https://badge.fury.io/js/rulepilot?v1.3.0)
 
 | Statements                                                                  | Functions                                                                  | Lines                                                                  |
 | --------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------- |

src/builder/builder.ts

@@ -5,8 +5,8 @@ import {
   Constraint,
   ConditionType,
 } from "../types/rule";
+import { RuleError } from "../errors";
 import { Validator } from "../services";
-import { RuleError } from "../types/error";
 import { SubRuleBuilder } from "./sub-rule-builder";
 
 export class Builder {

src/errors/index.ts

@@ -0,0 +1,2 @@
+export * from "./rule.error";
+export * from "./rule-type.error";

src/errors/rule-type.error.ts

@@ -0,0 +1,10 @@
+import { RuleError } from "./rule.error";
+
+export class RuleTypeError extends Error {
+  constructor(message: string) {
+    super(message ?? "The type of rule is not valid for this operation");
+  }
+
+  /** The name/type of the error. */
+  type: string = RuleError.name;
+}

src/types/error.ts → src/errors/rule.error.ts

@@ -12,12 +12,3 @@ export class RuleError extends Error {
   /** The element that caused the error. */
   element: object;
 }
-
-export class RuleTypeError extends Error {
-  constructor(message: string) {
-    super(message ?? "The type of rule is not valid for this operation");
-  }
-
-  /** The name/type of the error. */
-  type: string = RuleError.name;
-}

src/index.ts

@@ -1,4 +1,4 @@
 export * from "./types/rule";
-export * from "./types/error";
+export * from "./errors";
 export { RulePilot } from "./services/rule-pilot";
 export { ValidationResult } from "./services/validator";

src/services/introspector.ts

@@ -7,7 +7,7 @@ import {
   IntrospectionResult,
 } from "../types/rule";
 import { Logger } from "./logger";
-import { RuleTypeError } from "../types/error";
+import { RuleTypeError } from "../errors";
 import { ObjectDiscovery } from "./object-discovery";
 
 interface IntrospectionStep {
@@ -21,6 +21,11 @@ interface IntrospectionStep {
   }[];
 }
 
+/**
+ * Introspection deals with the process of examining the constraints and conditions of a rule to determine all the
+ * possible range of input criteria which would satisfy the rule along with the result of the rule that would be
+ * produced by the criteria.
+ */
 export class Introspector {
   #objectDiscovery: ObjectDiscovery = new ObjectDiscovery();
   #steps: IntrospectionStep[];

src/services/rule-pilot.ts

@@ -1,7 +1,7 @@
 import { Mutator } from "./mutator";
 import { Builder } from "../builder";
+import { RuleError } from "../errors";
 import { Evaluator } from "./evaluator";
-import { RuleError } from "../types/error";
 import { Introspector } from "./introspector";
 import { Validator, ValidationResult } from "./validator";
 import { Rule, IntrospectionResult } from "../types/rule";