fix: migrate to js-yaml v5

.changeset/lazy-trees-cheer.md

@@ -0,0 +1,11 @@
+---
+'@redocly/openapi-core': patch
+'@redocly/cli': patch
+---
+
+Updated js-yaml from `4.2.0` to `5.2.1`.
+Fixed an issue where strings that look like numbers with underscores (for example `'12_34'`) had quotation marks removed by the `bundle` command.
+These strings stay quoted in the output.
+
+**Note**: YAML parsing is stricter: a multi-line flow collection whose closing bracket is not indented deeper than its parent key is now a parse error.
+Parse errors are reported at the offending token instead of the end of the document.

packages/core/package.json

@@ -59,14 +59,13 @@
     "colorette": "^1.2.0",
     "graphql": "^16.14.1",
     "js-levenshtein": "^1.1.6",
-    "js-yaml": "^4.2.0",
+    "js-yaml": "^5.2.1",
     "picomatch": "^4.0.4",
     "pluralize": "^8.0.0",
     "yaml-ast-parser": "0.0.43"
   },
   "devDependencies": {
     "@types/js-levenshtein": "^1.1.0",
-    "@types/js-yaml": "^4.0.3",
     "@types/picomatch": "^4.0.2",
     "@types/pluralize": "^0.0.29",
     "json-schema-to-ts": "^3.1.0",

packages/core/src/__tests__/js-yaml.test.ts

@@ -71,4 +71,16 @@ describe('js-yaml', () => {
       'unacceptable kind of an object to dump [object Function]'
     );
   });
+
+  it('should return a nullish value instead of throwing for empty or comment-only input', () => {
+    expect(parseYaml('')).toBeUndefined();
+    expect(parseYaml('   \n  ')).toBeUndefined();
+    expect(parseYaml('# just a comment\n')).toBeNull();
+  });
+
+  it('throws when the stream contains more than one document', () => {
+    expect(() => parseYaml('a: 1\n---\nb: 2\n')).toThrow(
+      'expected a single document in the stream, but found more'
+    );
+  });
 });

packages/core/src/js-yaml/index.ts

@@ -1,14 +1,34 @@
-// TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import { JSON_SCHEMA, types, load, dump, type LoadOptions, type DumpOptions } from 'js-yaml';
+import {
+  CORE_SCHEMA,
+  mergeTag,
+  binaryTag,
+  omapTag,
+  pairsTag,
+  setTag,
+  loadAll,
+  dump,
+  YAMLException,
+  type LoadOptions,
+  type DumpOptions,
+} from 'js-yaml';
 
-const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = JSON_SCHEMA.extend({
-  implicit: [types.merge],
-  explicit: [types.binary, types.omap, types.pairs, types.set],
-});
+const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = CORE_SCHEMA.withTags(
+  mergeTag,
+  binaryTag,
+  omapTag,
+  pairsTag,
+  setTag
+);
 
-export const parseYaml = (str: string, opts?: LoadOptions): unknown =>
-  load(str, { schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts });
+export const parseYaml = (str: string, opts?: LoadOptions): unknown => {
+  const documents = loadAll(str, { schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts });
+  if (documents.length === 0) {
+    return str.trim() === '' ? undefined : null;
+  }
+  if (documents.length > 1) {
+    throw new YAMLException('expected a single document in the stream, but found more');
+  }
+  return documents[0];
+};
 
 export const stringifyYaml = (obj: any, opts?: DumpOptions): string => dump(obj, opts);

packages/core/src/rules/common/__tests__/no-unresolved-refs.test.ts

@@ -85,12 +85,12 @@ describe('oas3 boolean-parameter-prefixes', () => {
               "reportOnKey": false,
               "source": "fixtures/invalid-yaml.yaml",
               "start": {
-                "col": 1,
-                "line": 2,
+                "col": 8,
+                "line": 1,
               },
             },
           ],
-          "message": "Failed to parse: unexpected end of the stream within a single quoted scalar in "fixtures/invalid-yaml.yaml" (2:1)",
+          "message": "Failed to parse: unexpected end of the stream within a single quoted scalar in "fixtures/invalid-yaml.yaml" (1:8)",
           "ruleId": "no-unresolved-refs",
           "severity": "error",
           "suggest": [],
@@ -103,7 +103,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               "source": "foobar.yaml",
             },
           ],
-          "message": "Can't resolve $ref: unexpected end of the stream within a single quoted scalar in "fixtures/invalid-yaml.yaml" (2:1)",
+          "message": "Can't resolve $ref: unexpected end of the stream within a single quoted scalar in "fixtures/invalid-yaml.yaml" (1:8)",
           "reference": "https://redocly.com/docs/cli/rules/oas/no-unresolved-refs",
           "ruleId": "no-unresolved-refs",
           "severity": "error",

packages/core/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts

@@ -635,7 +635,7 @@ describe('no-invalid-media-type-examples', () => {
                       example: {
                         "a": "test",
                         "b": "test"
-                      }
+                        }
                       schema:
                         $ref: '#/components/schemas/C'
 

tests/e2e/bundle/primitive-types/openapi.yaml

@@ -37,3 +37,5 @@ paths:
                   object:
                     key1: 1
                     key2: 2
+                  underscoreNumberTransformedToString: 12_34
+                  underscoreNumberString: '12_34'

tests/e2e/bundle/primitive-types/snapshot.txt

@@ -35,6 +35,8 @@ paths:
                   object:
                     key1: 1
                     key2: 2
+                  underscoreNumberTransformedToString: '12_34'
+                  underscoreNumberString: '12_34'
 components: {}
 
 bundling openapi.yaml using configuration for api 'main'...