chore: update/resolve v2-related fixmes

Author: tatomyr

.github/workflows/tests.yaml

@@ -56,7 +56,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      # FIXME: add vitest coverage report
+      # FIXME: add vitest coverage report (2.0)
 
   code-style-check:
     runs-on: ubuntu-latest

packages/cli/src/commands/build-docs/utils.ts

@@ -41,7 +41,7 @@ export function getObjectOrJSON(
       if (config) {
         logger.info(`Found ${config.configFile} and using theme.openapi options\n`);
 
-        return config.theme.openapi ? config.theme.openapi : {}; // FIXME: ? theme is deprecated
+        return config.theme.openapi ? config.theme.openapi : {}; // FIXME: theme is deprecated (2.0)
       }
       return {};
     }

packages/cli/src/commands/join.ts

@@ -90,7 +90,7 @@ export async function handleJoin({
     );
   }
 
-  // FIXME: decide on the behaviour. Can we join by aliases? If yes, then I'd expect decorators to be applied
+  // FIXME: decide on the behaviour. Can we join by aliases? If yes, then I'd expect decorators to be applied (2.0)
   const apis = await getFallbackApisOrExit(argv.apis, config);
   if (apis.length < 2) {
     return exitWithError(`At least 2 APIs should be provided.`);

packages/cli/src/commands/lint.ts

@@ -36,7 +36,7 @@ export type LintOptions = {
   format: OutputFormat;
   'generate-ignore-file'?: boolean;
   'skip-rule'?: string[];
-  'skip-preprocessor'?: string[]; // FIXME: do we need this?
+  'skip-preprocessor'?: string[]; // FIXME: do we need this? (2.0)
 } & VerifyConfigOptions;
 
 export async function handleLint({

packages/cli/src/types.ts

@@ -23,8 +23,8 @@ export type Entrypoint = {
   alias?: string;
   output?: string;
 };
-export const outputExtensions = ['json', 'yaml', 'yml'] as ReadonlyArray<BundleOutputFormat>; // FIXME: use one source of truth
-export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined; // FIXME: use one source of truth
+export const outputExtensions = ['json', 'yaml', 'yml'] as ReadonlyArray<BundleOutputFormat>; // FIXME: use one source of truth (2.0)
+export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined; // FIXME: use one source of truth (2.0)
 export type CommandOptions =
   | StatsOptions
   | SplitOptions

packages/cli/src/utils/js-utils.ts

@@ -1,10 +1,10 @@
-// FIXME: remove?
+// FIXME: investigate if it can be removed (2.0)
 export function isObject(obj: unknown): obj is Record<string, unknown> {
   const type = typeof obj;
   return type === 'function' || (type === 'object' && !!obj);
 }
 
-// FIXME: remove?
+// FIXME: investigate if it can be removed (2.0)
 export function isEmptyObject(obj: any) {
   return !!obj && Object.keys(obj).length === 0;
 }

packages/cli/src/utils/miscellaneous.ts

@@ -289,7 +289,7 @@ export function getAndValidateFileExtension(fileName: string): NonNullable<Outpu
   const ext = fileName.split('.').pop();
 
   if (['yaml', 'yml', 'json'].includes(ext!)) {
-    // FIXME: ^ use one source of truth
+    // FIXME: ^ use one source of truth (2.0)
     return ext as NonNullable<OutputExtensions>;
   }
   logger.warn(`Unsupported file extension: ${ext}. Using yaml.\n`);

packages/core/src/config/config-resolvers.ts

@@ -151,10 +151,10 @@ export async function resolvePlugins(
           let requiredPlugin: ImportedPlugin | undefined;
 
           // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-ignore FIXME: remove?
+          // @ts-ignore FIXME: investigate if we still need this (2.0)
           if (typeof __webpack_require__ === 'function') {
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore FIXME: remove?
+            // @ts-ignore FIXME: investigate if we still need this (2.0)
             requiredPlugin = __non_webpack_require__(absolutePluginPath);
           } else {
             const mod = await import(url.pathToFileURL(absolutePluginPath).pathname);

packages/core/src/config/config.ts

@@ -129,7 +129,7 @@ export class StyleguideConfig {
         Record<string, Set<string>>
       >) || {};
 
-    replaceSpecWithStruct(Object.keys(this.ignore), this.ignore); // FIXME: remove this
+    replaceSpecWithStruct(Object.keys(this.ignore), this.ignore); // FIXME: remove this (2.0)
 
     // resolve ignore paths
     for (const fileName of Object.keys(this.ignore)) {
@@ -409,12 +409,12 @@ export class Config {
   styleguide: StyleguideConfig;
   resolve: ResolveConfig;
   licenseKey?: string;
-  theme: ThemeRawConfig; // FIXME: theme is deprecated
+  theme: ThemeRawConfig; // FIXME: theme is deprecated (2.0)
   telemetry?: Telemetry;
   constructor(public rawConfig: ResolvedConfig, public configFile?: string) {
     this.apis = rawConfig.apis || {};
     this.styleguide = new StyleguideConfig(rawConfig.styleguide || {}, configFile);
-    this.theme = rawConfig.theme || {}; // FIXME: theme is deprecated
+    this.theme = rawConfig.theme || {}; // FIXME: theme is deprecated (2.0)
     this.resolve = getResolveConfig(rawConfig?.resolve);
     this.telemetry = rawConfig.telemetry;
   }

packages/core/src/config/utils.ts

@@ -290,7 +290,7 @@ export function getMergedConfig(config: Config, apiName?: string): Config {
             extendPaths,
             pluginPaths,
           },
-          // FIXME: theme is deprecated
+          // FIXME: theme is deprecated (2.0)
           theme: {
             ...config.rawConfig.theme,
             ...config.apis[apiName]?.theme,
@@ -368,7 +368,7 @@ export function transformConfig(
   const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
 
   const transformedConfig: RawConfig = {
-    // FIXME: ? theme is deprecated
+    // FIXME: theme is deprecated (2.0)
     theme: {
       openapi: {
         ...referenceDocs,