fix: lint config with refs

Redocly · Dec 1, 2023 · 2b9c103 · 2b9c103
1 parent b4d6100
commit 2b9c103
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 38 deletions.
diff --git a/packages/cli/src/commands/lint.ts b/packages/cli/src/commands/lint.ts
@@ -1,13 +1,10 @@
 import {
   Config,
-  findConfig,
   formatProblems,
   getMergedConfig,
   getTotals,
   lint,
   lintConfig,
-  makeDocumentFromString,
-  stringifyYaml,
 } from '@redocly/openapi-core';
 import { ConfigValidationError } from '@redocly/openapi-core/lib/config';
 import {
@@ -21,7 +18,7 @@ import {
   printLintTotals,
   printUnusedWarnings,
 } from '../utils';
-import type { OutputFormat, ProblemSeverity, RawConfig, RuleSeverity } from '@redocly/openapi-core';
+import type { OutputFormat, ProblemSeverity, Document, RuleSeverity } from '@redocly/openapi-core';
 import type { CommandOptions, Skips, Totals } from '../types';
 import { blue, gray } from 'colorette';
 import { performance } from 'perf_hooks';
@@ -130,13 +127,13 @@ export function lintConfigCallback(
     return;
   }
 
-  return async (config: RawConfig, resolvedRefMap?: ResolvedRefMap) => {
-    const configPath = findConfig(argv.config) || '';
-    const stringYaml = stringifyYaml(config);
-    const configContent = makeDocumentFromString(stringYaml, configPath);
+  return async (config: Document, resolvedRefMap?: ResolvedRefMap) => {
+    // const configPath = findConfig(argv.config) || '';
+    // const stringYaml = stringifyYaml(config);
+    // const configContent = makeDocumentFromString(stringYaml, configPath);
 
     const problems = await lintConfig({
-      document: configContent,
+      document: config,
       severity: (argv['lint-config'] || 'warn') as ProblemSeverity,
       resolvedRefMap,
     });

diff --git a/packages/cli/src/utils.ts b/packages/cli/src/utils.ts
@@ -17,7 +17,7 @@ import {
   stringifyYaml,
   isAbsoluteUrl,
   loadConfig,
-  RawConfig,
+  Document,
   Region,
   Config,
   Oas3Definition,
@@ -426,7 +426,7 @@ export async function loadConfigAndHandleErrors(
   options: {
     configPath?: string;
     customExtends?: string[];
-    processRawConfig?: (rawConfig: RawConfig, resolvedRefMap?: ResolvedRefMap) => void | Promise<void>;
+    processRawConfig?: (rawConfig: Document, resolvedRefMap?: ResolvedRefMap) => void | Promise<void>;
     files?: string[];
     region?: Region;
   } = {}

diff --git a/packages/core/src/bundle.ts b/packages/core/src/bundle.ts
@@ -46,16 +46,16 @@ export type BundleOptions = {
   keepUrlRefs?: boolean;
 };
 
-export async function bundleConfig(
-  opts: {
-    ref?: string;
-  } & BundleOptions
-) {
+
+export async function resolveConfigFile(opts: {
+  ref?: string;
+} & BundleOptions) {
   const {
     ref,
     externalRefResolver = new BaseResolver(/* opts.config.resolve */),
     base = null,
   } = opts;
+
   if (!(ref)) {
     throw new Error('Reference to a config is required.\n');
   }
@@ -68,7 +68,21 @@ export async function bundleConfig(
 
   const types = normalizeTypes(ConfigTypes);
 
-  // console.log('TYPES', types.ConfigRoot);
+  const resolvedRefMap = await resolveDocument({
+    rootDocument: document,
+    rootType: types.ConfigRoot,
+    externalRefResolver,
+  });
+
+  return { document: document as Document,  resolvedRefMap };
+}
+
+export async function bundleConfig(
+  document: Document,
+  resolvedRefMap: ResolvedRefMap,
+) {
+
+  const types = normalizeTypes(ConfigTypes);
 
   const ctx: BundleContext = {
     problems: [],
@@ -77,12 +91,6 @@ export async function bundleConfig(
     visitorsData: {},
   };
 
-  const resolvedRefMap = await resolveDocument({
-    rootDocument: document,
-    rootType: types.ConfigRoot,
-    externalRefResolver,
-  });
-
   const bundleVisitor = normalizeVisitors(
     [
       {
@@ -108,7 +116,7 @@ export async function bundleConfig(
     ctx,
   });
 
-  return { parsed: document.parsed,  resolvedRefMap };
+  return document.parsed;
 }
 
 export async function bundle(

diff --git a/packages/core/src/config/load.ts b/packages/core/src/config/load.ts
@@ -1,20 +1,15 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import { RedoclyClient } from '../redocly';
-import { isEmptyObject, loadYaml, doesYamlFileExist } from '../utils';
+import { doesYamlFileExist, isEmptyObject } from '../utils';
 import { parseYaml } from '../js-yaml';
 import { Config, DOMAINS } from './config';
 import { ConfigValidationError, transformConfig } from './utils';
 import { resolveConfig } from './config-resolvers';
-import type {
-  DeprecatedInRawConfig,
-  FlatRawConfig,
-  RawConfig,
-  RawUniversalConfig,
-  Region,
-} from './types';
+import type { RawConfig, RawUniversalConfig, Region } from './types';
 import { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
-import { bundleConfig } from '../bundle';
+import {bundleConfig, resolveConfigFile} from '../bundle';
+import { Document } from '../resolve';
 import type { ResolvedRefMap } from '../resolve';
 
 async function addConfigMetadata({
@@ -78,7 +73,10 @@ export async function loadConfig(
   options: {
     configPath?: string;
     customExtends?: string[];
-    processRawConfig?: (rawConfig: RawConfig, resolvedRefMap?: ResolvedRefMap) => void | Promise<void>;
+    processRawConfig?: (
+      rawConfig: Document,
+      resolvedRefMap?: ResolvedRefMap
+    ) => void | Promise<void>;
     files?: string[];
     region?: Region;
   } = {}
@@ -118,17 +116,19 @@ export function findConfig(dir?: string): string | undefined {
 
 export async function getConfig(
   configPath: string | undefined = findConfig(),
-  processRawConfig?: (rawConfig: RawConfig, resolvedRefMap?: ResolvedRefMap) => void | Promise<void>
+  processRawConfig?: (rawConfig: Document, resolvedRefMap?: ResolvedRefMap) => void | Promise<void>
 ): Promise<RawConfig> {
   if (!configPath || !doesYamlFileExist(configPath)) return {};
   try {
     // const rawConfig =
     //   (await loadYaml<RawConfig & DeprecatedInRawConfig & FlatRawConfig>(configPath)) || {};
-    const {parsed: rawConfig, resolvedRefMap} = await bundleConfig({ref: configPath, config: {} as any});
+    const { document, resolvedRefMap } = await resolveConfigFile({ ref: configPath, config: {} as any });
     if (typeof processRawConfig === 'function') {
-      await processRawConfig(rawConfig, resolvedRefMap);
+      await processRawConfig(document, resolvedRefMap);
     }
-    return transformConfig(rawConfig);
+    const bundledConfig = await bundleConfig(document, resolvedRefMap);
+    return transformConfig(bundledConfig);
+
   } catch (e) {
     if (e instanceof ConfigValidationError) {
       throw e;