refactor: renames "context" for future

Author: joelgallant

app-config-core/src/parsed-value.ts

@@ -18,7 +18,7 @@ export type ParsingExtensionKey =
   | [typeof Root];
 
 export interface ParsingExtension {
-  (value: Json, key: ParsingExtensionKey, context: ParsingExtensionKey[]):
+  (value: Json, key: ParsingExtensionKey, parentKeys: ParsingExtensionKey[]):
     | ParsingExtensionTransform
     | false;
 
@@ -355,13 +355,13 @@ async function parseValueInner(
   source: ConfigSource,
   extensions: ParsingExtension[],
   metadata: ParsedValueMetadata = {},
-  context: ParsingExtensionKey[],
+  parentKeys: ParsingExtensionKey[],
   root: Json,
   parent?: JsonObject | Json[],
   visitedExtensions: Set<ParsingExtension | string> = new Set(),
 ): Promise<ParsedValue> {
-  const [currentKey] = context.slice(-1);
-  const contextualKeys = context.slice(0, context.length - 1);
+  const [currentKey] = parentKeys.slice(-1);
+  const parentKeysNext = parentKeys.slice(0, parentKeys.length - 1);
 
   let applicableExtension: ParsingExtensionTransform | undefined;
 
@@ -377,7 +377,7 @@ async function parseValueInner(
     if (visitedExtensions.has(extension)) continue;
     if (extension.extensionName && visitedExtensions.has(extension.extensionName)) continue;
 
-    const applicable = extension(value, currentKey, contextualKeys);
+    const applicable = extension(value, currentKey, parentKeysNext);
 
     if (applicable) {
       applicableExtension = applicable;
@@ -403,7 +403,7 @@ async function parseValueInner(
         sourceOverride ?? source,
         extensionsOverride ?? extensions,
         { ...metadata, ...metadataOverride },
-        context,
+        parentKeys,
         root,
         parent,
         visitedExtensions,
@@ -421,7 +421,7 @@ async function parseValueInner(
           source,
           extensions,
           undefined,
-          context.concat([[InArray, index]]),
+          parentKeys.concat([[InArray, index]]),
           root,
           value,
         );
@@ -446,7 +446,7 @@ async function parseValueInner(
           source,
           extensions,
           undefined,
-          context.concat([[InObject, key]]),
+          parentKeys.concat([[InObject, key]]),
           root,
           value,
         );

app-config-exec/src/index.ts

@@ -33,7 +33,7 @@ function execParsingExtension(): ParsingExtension {
               .addBoolean('parseOutput', {}, false)
               .addBoolean('trimWhitespace', {}, false),
           ),
-        (value) => async (parse, _, context) => {
+        (value) => async (parse, _, source) => {
           let options;
 
           if (typeof value === 'string') {
@@ -50,7 +50,7 @@ function execParsingExtension(): ParsingExtension {
           } = options;
 
           try {
-            const dir = resolveFilepath(context, '.');
+            const dir = resolveFilepath(source, '.');
             const { stdout, stderr } = await execAsync(command, { cwd: dir });
 
             if (failOnStderr && stderr) {

app-config-extension-utils/src/index.ts

@@ -72,7 +72,7 @@ export function validateOptions<T>(
   extension: (
     value: T,
     key: ParsingExtensionKey,
-    context: ParsingExtensionKey[],
+    parentKeys: ParsingExtensionKey[],
   ) => ParsingExtensionTransform | false,
   { lazy = false }: { lazy?: boolean } = {},
 ): ParsingExtension {

app-config-extensions/src/extends-directive.ts

@@ -32,15 +32,15 @@ function fileReferenceDirective(keyName: string, meta: ParsedValueMetadata): Par
 
         return SchemaBuilder.oneOf(reference, SchemaBuilder.arraySchema(reference));
       },
-      (value) => async (_, __, context, extensions) => {
+      (value) => async (_, __, source, extensions) => {
         const retrieveFile = async (filepath: string, subselector?: string, isOptional = false) => {
-          const resolvedPath = resolveFilepath(context, filepath);
+          const resolvedPath = resolveFilepath(source, filepath);
 
           logger.verbose(`Loading file for ${keyName}: ${resolvedPath}`);
 
-          const source = new FileSource(resolvedPath);
+          const resolvedSource = new FileSource(resolvedPath);
 
-          const parsed = await source.read(extensions).catch((error) => {
+          const parsed = await resolvedSource.read(extensions).catch((error) => {
             if (error instanceof NotFoundError && isOptional) {
               return ParsedValue.literal({});
             }

app-config-js/src/index.ts

@@ -13,8 +13,8 @@ export default function jsModuleDirective(): ParsingExtension {
       '$jsModule',
       validateOptions(
         (SchemaBuilder) => SchemaBuilder.stringSchema(),
-        (value) => async (parse, _, context) => {
-          const resolvedPath = resolveFilepath(context, value);
+        (value) => async (parse, _, source) => {
+          const resolvedPath = resolveFilepath(source, value);
 
           let loaded: any = await import(resolvedPath);
 

app-config-node/src/file-source.ts

@@ -151,14 +151,14 @@ export class FlexibleFileSource extends ConfigSource {
   }
 }
 
-export function resolveFilepath(context: ConfigSource, filepath: string) {
+export function resolveFilepath(source: ConfigSource, filepath: string) {
   let resolvedPath = filepath;
 
   // resolve filepaths that are relative to the current FileSource
-  if (!isAbsolute(filepath) && context instanceof FileSource) {
-    resolvedPath = join(dirname(context.filePath), filepath);
+  if (!isAbsolute(filepath) && source instanceof FileSource) {
+    resolvedPath = join(dirname(source.filePath), filepath);
 
-    if (resolve(context.filePath) === resolvedPath) {
+    if (resolve(source.filePath) === resolvedPath) {
       throw new AppConfigError(`An extension tried to resolve to it's own file (${resolvedPath}).`);
     }
   }

app-config-v1-compat/src/index.ts

@@ -8,9 +8,9 @@ import { logger } from '@app-config/logging';
 
 /** V1 app-config compatibility */
 export default function v1Compat(shouldShowDeprecationNotice?: true): ParsingExtension {
-  return named('v1-compat', (value, [_, key], context) => {
+  return named('v1-compat', (value, [_, key], parentKeys) => {
     // only apply in top-level app-config property
-    if (context[context.length - 1]?.[0] !== Root) {
+    if (parentKeys[parentKeys.length - 1]?.[0] !== Root) {
       return false;
     }