chore!: refactor config loading and usage (#2131)

* remove benchmark from the openapi-core package

* remove getMergedApiConfig

* chore: update redocly/config to v0.26.2

* remove redundant layers when resolving config

* merge StyleguideConfig into Config 

* remove internal usage of processRawConfig

Author: tatomyr

.changeset/young-trains-brush.md

@@ -0,0 +1,7 @@
+---
+"@redocly/openapi-core": major
+---
+
+Streamlined Redocly configuration interfaces for improved developer experience.
+Removed `StyleguideConfig` class in favor of the unified `Config` class.
+Removed `getMergedConfig` function - use `Config.forAlias()` method instead to retrieve API-specific configurations.

.github/workflows/pr-title.yml

@@ -12,13 +12,14 @@ jobs:
         env:
           PR_TITLE: ${{ github.event.pull_request.title }}
         run: |
-          if ! echo "$PR_TITLE" | grep -E "^(fix|feat|chore|docs)(\([a-z-]+\))?: (🔖 |🧪 )?[a-z].+[^.]$"; then
+          if ! echo "$PR_TITLE" | grep -E "^(fix|feat|chore|docs)(\([a-z-]+\))?(\!)?: (🔖 |🧪 )?[a-z].+[^.]$"; then
             echo "❌ PR title '$PR_TITLE' does not match the required format"
             echo "Required format: type(scope): subject"
             echo "Examples:"
             echo "  feat: add new feature"
             echo "  fix(core): fix bug"
             echo "  docs: update README"
+            echo "  chore!: breaking change"
             exit 1
           fi
           echo "✅ PR title format is valid"

__tests__/build-docs/simple-build-docs/snapshot.txt

@@ -1,5 +1,4 @@
 
-Found undefined and using theme.openapi options
 Prerendering docs
 
 🎉 bundled successfully in: redoc-static.html (332 KiB) [⏱ <test>ms].

__tests__/check-config/invalid-config--lint-config-error/snapshot.txt

@@ -14,3 +14,4 @@ Error was generated by the configuration struct rule.
 
 ❌ Your config has 1 error.
 
+

__tests__/check-config/invalid-config--no-option/snapshot.txt

@@ -14,3 +14,4 @@ Error was generated by the configuration struct rule.
 
 ❌ Your config has 1 error.
 
+

__tests__/check-config/wrong-config-type-extensions-in-assertions/snapshot.txt

@@ -16,3 +16,4 @@ Error was generated by the configuration struct rule.
 Deprecated plugin format detected: type-extension
 ❌ Your config has 1 error.
 
+

__tests__/commands.test.ts

@@ -82,24 +82,81 @@ describe('E2E', () => {
       const result = getCommandOutput(args, {}, { testPath });
       await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot.txt'));
     });
+
+    test('lint file by alias using file path (at the config level)', async () => {
+      const dirName = 'assertions-severity-override';
+      const testPath = join(__dirname, `lint/${dirName}`);
+
+      const args = getParams(indexEntryPoint, ['lint', 'openapi.yaml']);
+
+      const result = getCommandOutput(args, {}, { testPath });
+      await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot.txt'));
+    });
+
+    test('lint file by alias using file path (not from the config level)', async () => {
+      const dirName = 'assertions-severity-override';
+      const testPath = join(__dirname, `lint/${dirName}`);
+
+      const args = getParams(indexEntryPoint, [
+        'lint',
+        join(testPath, 'openapi.yaml'),
+        '--config',
+        join(testPath, 'redocly.yaml'),
+      ]);
+
+      const result = getCommandOutput(args, {}, {});
+      await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot_2.txt'));
+    });
+
+    test('lint file by alias using file path (without using extends in config) (at the config level)', async () => {
+      const dirName = 'assertions-severity-override-without-extends';
+      const testPath = join(__dirname, `lint/${dirName}`);
+
+      const args = getParams(indexEntryPoint, ['lint', 'openapi.yaml']);
+
+      const result = getCommandOutput(args, {}, { testPath });
+      await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot.txt'));
+    });
+
+    test('lint file by alias using file path (without using extends in config) (not from the config level)', async () => {
+      const dirName = 'assertions-severity-override-without-extends';
+      const testPath = join(__dirname, `lint/${dirName}`);
+
+      const args = getParams(indexEntryPoint, [
+        'lint',
+        join(testPath, 'openapi.yaml'),
+        '--config',
+        join(testPath, 'redocly.yaml'),
+      ]);
+
+      const result = getCommandOutput(args, {}, {});
+      await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot_2.txt'));
+    });
   });
 
   describe('zero-config', () => {
     const folderPath = join(__dirname, 'zero-config');
 
-    it('default-recommended-fallback', async () => {
+    test('default-recommended-fallback', async () => {
       const testPath = join(folderPath, 'default-recommended-fallback');
       const args = getParams(indexEntryPoint, ['lint', './openapi.yaml']);
       const result = getCommandOutput(args, {}, { testPath });
       await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot.txt'));
     });
 
-    it('no-default-recommended-fallback', async () => {
+    test('no-default-recommended-fallback', async () => {
       const testPath = join(folderPath, 'no-default-recommended-fallback');
       const args = getParams(indexEntryPoint, ['lint', './openapi.yaml']);
       const result = getCommandOutput(args, {}, { testPath });
       await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot.txt'));
     });
+
+    test('no-default-recommended-fallback-with-empty-config', async () => {
+      const testPath = join(folderPath, 'no-default-recommended-fallback-with-empty-config');
+      const args = getParams(indexEntryPoint, ['lint', './openapi.yaml']);
+      const result = getCommandOutput(args, {}, { testPath });
+      await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot.txt'));
+    });
   });
 
   describe('check-config', () => {
@@ -597,6 +654,21 @@ describe('E2E', () => {
       const result = getCommandOutput(args, {}, { testPath });
       await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot_3.txt'));
     });
+
+    test('lint a specific api when alias is: specified (1); not specified (used the file path) (2)', async () => {
+      const testPath = join(folderPath, 'apply-per-api-decorators');
+      const args1 = getParams(indexEntryPoint, ['lint', '--config=nested/redocly.yaml', 'test@fs']);
+      const result1 = getCommandOutput(args1, {}, { testPath });
+      await expect(cleanupOutput(result1)).toMatchFileSnapshot(join(testPath, 'snapshot_4.txt'));
+
+      const args2 = getParams(indexEntryPoint, [
+        'lint',
+        '--config=nested/redocly.yaml',
+        'nested/openapi/main.yaml',
+      ]);
+      const result2 = getCommandOutput(args2, {}, { testPath });
+      await expect(cleanupOutput(result2)).toMatchFileSnapshot(join(testPath, 'snapshot_4.txt'));
+    });
   });
 
   describe('build-docs', () => {

__tests__/lint-config/config-structure/snapshot.txt

@@ -631,3 +631,4 @@ Error was generated by the configuration struct rule.
 
 ❌ Your config has 44 errors.
 
+

__tests__/lint-config/config-with-refs-extended/snapshot.txt

@@ -80,3 +80,4 @@ Error was generated by the configuration struct rule.
 
 ❌ Your config has 6 errors.
 
+

__tests__/lint-config/invalid-config--lint-config-error/snapshot.txt

@@ -14,3 +14,4 @@ Error was generated by the configuration struct rule.
 
 ❌ Your config has 1 error.
 
+