@redocly/cli 1.10.6 → 1.12.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @redocly/cli
 
+## 1.12.0
+
+### Minor Changes
+
+- Added return values for the `push` and `push-status` commands.
+
+### Patch Changes
+
+- Fixed handling of wildcards on Windows ([#1521](https://github.com/Redocly/redocly-cli/issues/1521)).
+- Updated @redocly/openapi-core to v1.12.0.
+
+## 1.11.0
+
+### Minor Changes
+
+- Removed additional operations from the `join` command; use `lint` and/or `bundle` for operations such as `lint` and `decorate`.
+- Removed lint support from the bundle command to support a wider range of use cases. Users should update to [run lint and bundle separately](https://redocly.com/docs/cli/guides/lint-and-bundle/).
+- Added support for a `github-actions` output format for the `lint` command to annotate reported problems on files when used in a GitHub Actions workflow.
+
+### Patch Changes
+
+- Fixed [`no-invalid-media-type-examples`](https://redocly.com/docs/cli/rules/no-invalid-media-type-examples/) rule `externalValue` example validation.
+- Updated @redocly/openapi-core to v1.11.0.
+
 ## 1.10.6
 
 ### Patch Changes

package/lib/__tests__/commands/bundle.test.js

@@ -28,18 +28,15 @@ describe('bundle', () => {
         jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
     });
     afterEach(() => {
-        openapi_core_1.lint.mockClear();
         openapi_core_1.bundle.mockClear();
         openapi_core_1.getTotals.mockReset();
     });
-    it('bundles definitions w/o linting', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('bundles definitions', () => __awaiter(void 0, void 0, void 0, function* () {
         const apis = ['foo.yaml', 'bar.yaml'];
         yield (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)({
             apis,
             ext: 'yaml',
-            format: 'codeframe',
         });
-        expect(openapi_core_1.lint).toBeCalledTimes(0);
         expect(openapi_core_1.bundle).toBeCalledTimes(apis.length);
     }));
     it('exits with code 0 when bundles definitions', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -47,39 +44,20 @@ describe('bundle', () => {
         yield (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)({
             apis,
             ext: 'yaml',
-            format: 'codeframe',
         });
         yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
         expect(processExitMock).toHaveBeenCalledWith(0);
     }));
-    it('bundles definitions w/ linting', () => __awaiter(void 0, void 0, void 0, function* () {
-        const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-        openapi_core_1.getTotals.mockReturnValue({
-            errors: 0,
-            warnings: 0,
-            ignored: 0,
-        });
-        yield (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)({
-            apis,
-            ext: 'yaml',
-            format: 'codeframe',
-            lint: true,
-        });
-        expect(openapi_core_1.lint).toBeCalledTimes(apis.length);
-        expect(openapi_core_1.bundle).toBeCalledTimes(apis.length);
-    }));
-    it('exits with code 0 when bundles definitions w/linting w/o errors', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('exits with code 0 when bundles definitions w/o errors', () => __awaiter(void 0, void 0, void 0, function* () {
         const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
         yield (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)({
             apis,
             ext: 'yaml',
-            format: 'codeframe',
-            lint: true,
         });
         yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
         expect(processExitMock).toHaveBeenCalledWith(0);
     }));
-    it('exits with code 1 when bundles definitions w/linting w/errors', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('exits with code 1 when bundles definitions w/errors', () => __awaiter(void 0, void 0, void 0, function* () {
         const apis = ['foo.yaml'];
         openapi_core_1.getTotals.mockReturnValue({
             errors: 1,
@@ -89,10 +67,7 @@ describe('bundle', () => {
         yield (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)({
             apis,
             ext: 'yaml',
-            format: 'codeframe',
-            lint: true,
         });
-        expect(openapi_core_1.lint).toBeCalledTimes(apis.length);
         yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
         expect(processExitMock).toHaveBeenCalledWith(1);
     }));
@@ -104,8 +79,6 @@ describe('bundle', () => {
         yield (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)({
             apis,
             ext: 'json',
-            format: 'codeframe',
-            lint: false,
         });
         expect(miscellaneous_1.handleError).toHaveBeenCalledTimes(1);
         expect(miscellaneous_1.handleError).toHaveBeenCalledWith(new Error('Invalid definition'), 'invalid.json');
@@ -120,8 +93,6 @@ describe('bundle', () => {
         yield (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)({
             apis,
             ext: 'yaml',
-            format: 'codeframe',
-            lint: false,
         });
         expect(miscellaneous_1.handleError).toHaveBeenCalledTimes(0);
     }));

package/lib/__tests__/commands/join.test.js

@@ -94,17 +94,6 @@ describe('handleJoin', () => {
         expect(config.styleguide.skipDecorators).toHaveBeenCalled();
         expect(config.styleguide.skipPreprocessors).toHaveBeenCalled();
     }));
-    it('should not call skipDecorators and skipPreprocessors', () => __awaiter(void 0, void 0, void 0, function* () {
-        openapi_core_1.detectSpec.mockReturnValue('oas3_0');
-        yield (0, join_1.handleJoin)({
-            apis: ['first.yaml', 'second.yaml'],
-            decorate: true,
-            preprocess: true,
-        }, config_1.ConfigFixture, 'cli-version');
-        const config = (0, openapi_core_2.loadConfig)();
-        expect(config.styleguide.skipDecorators).not.toHaveBeenCalled();
-        expect(config.styleguide.skipPreprocessors).not.toHaveBeenCalled();
-    }));
     it('should handle join with prefix-components-with-info-prop and null values', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec.mockReturnValue('oas3_0');
         yield (0, join_1.handleJoin)({

package/lib/__tests__/utils.test.js

@@ -348,13 +348,13 @@ describe('handleErrors', () => {
         jest.clearAllMocks();
     });
     it('should handle ResolveError', () => {
-        const resolveError = new openapi_core_1.ResolveError(new Error('File not found'));
+        const resolveError = new openapi_core_1.ResolveError(new Error('File not found.'));
         expect(() => (0, miscellaneous_1.handleError)(resolveError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(redColoretteMocks).toHaveBeenCalledTimes(1);
         expect(process.stderr.write).toHaveBeenCalledWith(`Failed to resolve API description at openapi/test.yaml:\n\n  - File not found.\n\n`);
     });
     it('should handle YamlParseError', () => {
-        const yamlParseError = new openapi_core_1.YamlParseError(new Error('Invalid yaml'), {});
+        const yamlParseError = new openapi_core_1.YamlParseError(new Error('Invalid yaml.'), {});
         expect(() => (0, miscellaneous_1.handleError)(yamlParseError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(redColoretteMocks).toHaveBeenCalledTimes(1);
         expect(process.stderr.write).toHaveBeenCalledWith(`Failed to parse API description at openapi/test.yaml:\n\n  - Invalid yaml.\n\n`);
@@ -372,7 +372,7 @@ describe('handleErrors', () => {
         expect(process.stderr.write).toHaveBeenCalledWith('Syntax error: Unexpected identifier test stack\n\n');
     });
     it('should throw unknown error', () => {
-        const testError = new Error('Test error');
+        const testError = new Error('Test error.');
         expect(() => (0, miscellaneous_1.handleError)(testError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(process.stderr.write).toHaveBeenCalledWith(`Something went wrong when processing openapi/test.yaml:\n\n  - Test error.\n\n`);
     });

package/lib/cms/api/types.d.ts

@@ -44,32 +44,44 @@ export type Remote = {
 export type PushResponse = {
     id: string;
     remoteId: string;
+    isMainBranch: boolean;
+    isOutdated: boolean;
+    hasChanges: boolean;
+    replace: boolean;
+    scoutJobId: string | null;
+    uploadedFiles: Array<{
+        path: string;
+        mimeType: string;
+    }>;
     commit: {
-        message: string;
         branchName: string;
-        sha: string | null;
-        url: string | null;
+        message: string;
         createdAt: string | null;
-        namespace: string | null;
-        repository: string | null;
+        namespaceId: string | null;
+        repositoryId: string | null;
+        url: string | null;
+        sha: string | null;
         author: {
             name: string;
             email: string;
             image: string | null;
         };
+        statuses: Array<{
+            name: string;
+            description: string;
+            status: 'pending' | 'running' | 'success' | 'failed';
+            url: string | null;
+        }>;
     };
     remote: {
         commits: {
-            branchName: string;
             sha: string;
+            branchName: string;
         }[];
     };
-    hasChanges: boolean;
-    isOutdated: boolean;
-    isMainBranch: boolean;
     status: PushStatusResponse;
 };
-type DeploymentStatusResponse = {
+export type DeploymentStatusResponse = {
     deploy: {
         url: string | null;
         status: DeploymentStatus;
@@ -88,4 +100,3 @@ export type ScorecardItem = {
 };
 export type PushStatusBase = 'pending' | 'success' | 'running' | 'failed';
 export type DeploymentStatus = 'skipped' | PushStatusBase;
-export {};