refactor: rename all references of ctx with field

Author: thetutlage

benchmarks/flat_object.ts

@@ -12,9 +12,9 @@ const data = { username: 'virk' }
 const meta = {}
 const refs = {
   'ref://1': {
-    validator(value: unknown, _: any, ctx: any) {
+    validator(value: unknown, _: any, field: any) {
       if (typeof value !== 'string') {
-        ctx.report('Value is not a string')
+        field.report('Value is not a string')
       }
     },
     options: {},

benchmarks/nested_object.ts

@@ -12,9 +12,9 @@ const data = { profile: { username: 'virk' } }
 const meta = {}
 const refs = {
   'ref://1': {
-    validator(value: unknown, _: any, ctx: any) {
+    validator(value: unknown, _: any, field: any) {
       if (typeof value !== 'string') {
-        ctx.report('Value is not a string')
+        field.report('Value is not a string')
       }
     },
     options: {},

benchmarks/object_with_arrays.ts

@@ -12,9 +12,9 @@ const data = { contacts: [{ email: '[email protected]' }] }
 const meta = {}
 const refs = {
   'ref://1': {
-    validator(value: unknown, _: any, ctx: any) {
+    validator(value: unknown, _: any, field: any) {
       if (typeof value !== 'string') {
-        ctx.report('Value is not a string', ctx)
+        field.report('Value is not a string', field)
       }
     },
     options: {},

src/scripts/define_inline_functions.ts

@@ -12,48 +12,48 @@
  * validation runtime code.
  */
 export function defineInlineFunctions(options: { convertEmptyStringsToNull: boolean }) {
-  return `function report(message, rule, ctx, args) {
-  ctx.isValid = false;
-  errorReporter.report(messagesProvider.getMessage(message, rule, ctx, args), rule, ctx, args);
+  return `function report(message, rule, field, args) {
+  field.isValid = false;
+  errorReporter.report(messagesProvider.getMessage(message, rule, field, args), rule, field, args);
 };
-function defineValue(value, ctx) {
+function defineValue(value, field) {
   ${options.convertEmptyStringsToNull ? `if (value === '') { value = null; }` : ''}
-  ctx.value = value;
-  ctx.isDefined = value !== undefined && value !== null;
-  return ctx;
+  field.value = value;
+  field.isDefined = value !== undefined && value !== null;
+  return field;
 };
-function ensureExists(ctx) {
-  if (ctx.value === undefined || ctx.value === null) {
-    ctx.report(REQUIRED, 'required', ctx);
+function ensureExists(field) {
+  if (field.value === undefined || field.value === null) {
+    field.report(REQUIRED, 'required', field);
     return false;
   }
   return true;
 };
-function ensureIsDefined(ctx) {
-  if (ctx.value === undefined) {
-    ctx.report(REQUIRED, 'required', ctx);
+function ensureIsDefined(field) {
+  if (field.value === undefined) {
+    field.report(REQUIRED, 'required', field);
     return false;
   }
   return true;
 };
-function ensureIsObject(ctx) {
-  if (!ctx.isDefined) {
+function ensureIsObject(field) {
+  if (!field.isDefined) {
     return false;
   }
-  if (typeof ctx.value == 'object' && !Array.isArray(ctx.value)) {
+  if (typeof field.value == 'object' && !Array.isArray(field.value)) {
     return true;
   }
-  ctx.report(NOT_AN_OBJECT, 'object', ctx);
+  field.report(NOT_AN_OBJECT, 'object', field);
   return false;
 };
-function ensureIsArray(ctx) {
-  if (!ctx.isDefined) {
+function ensureIsArray(field) {
+  if (!field.isDefined) {
     return false;
   }
-  if (Array.isArray(ctx.value)) {
+  if (Array.isArray(field.value)) {
     return true;
   }
-  ctx.report(NOT_AN_ARRAY, 'array', ctx);
+  field.report(NOT_AN_ARRAY, 'array', field);
   return false;
 };
 function copyProperties(val) {

src/types.ts

@@ -77,7 +77,7 @@ export type FieldContext = {
   /**
    * Mutate the value of field under validation.
    */
-  mutate(newValue: any, ctx: FieldContext): void
+  mutate(newValue: any, field: FieldContext): void
 
   /**
    * Report error to the error reporter
@@ -128,7 +128,7 @@ export type ValidationRule = {
   /**
    * Performs validation
    */
-  validator(value: unknown, options: any, ctx: FieldContext): any
+  validator(value: unknown, options: any, field: FieldContext): any
 
   /**
    * Options to pass
@@ -144,12 +144,12 @@ export type ParseFn = (value: unknown) => any
 /**
  * The shape of transform function picked from the refs
  */
-export type TransformFn<Input, Output> = (value: Input, ctx: FieldContext) => Output
+export type TransformFn<Input, Output> = (value: Input, field: FieldContext) => Output
 
 /**
  * The shape of conditional function used for narrowing down unions.
  */
-export type ConditionalFn<Input> = (value: Input, ctx: FieldContext) => boolean
+export type ConditionalFn<Input> = (value: Input, field: FieldContext) => boolean
 
 /**
  * Shape of a validation rule accepted by the compiler
@@ -475,7 +475,7 @@ export interface ErrorReporterContract {
   /**
    * Report error for a field
    */
-  report(message: string, rule: string, ctx: FieldContext, args?: Record<string, any>): any
+  report(message: string, rule: string, field: FieldContext, args?: Record<string, any>): any
 }
 
 /**
@@ -490,7 +490,7 @@ export interface MessagesProviderContact {
   getMessage(
     defaultMessage: string,
     rule: string,
-    ctx: FieldContext,
+    field: FieldContext,
     args?: Record<string, any>
   ): string
 }