@speclynx/apidom-parser-adapter-yaml-1-2 1.12.2 → 2.0.1

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.1](https://github.com/speclynx/apidom/compare/v2.0.0...v2.0.1) (2026-01-14)
+
+**Note:** Version bump only for package @speclynx/apidom-parser-adapter-yaml-1-2
+
+# [2.0.0](https://github.com/speclynx/apidom/compare/v1.12.2...v2.0.0) (2026-01-14)
+
+### Bug Fixes
+
+- limit source maps memory consuption ([#20](https://github.com/speclynx/apidom/issues/20)) ([4a0574f](https://github.com/speclynx/apidom/commit/4a0574fd6d466be7c33c8a5871baacd384918d22))
+
+### Features
+
+- add support for strict mode in JSON/YAML parser adapters ([#22](https://github.com/speclynx/apidom/issues/22)) ([a9c5f11](https://github.com/speclynx/apidom/commit/a9c5f11e8748135e7ba578b61d2f1807e11d34aa))
+- apply innovations learned during last 3 years ([#11](https://github.com/speclynx/apidom/issues/11)) ([cfdbbfc](https://github.com/speclynx/apidom/commit/cfdbbfc2721b0dadc77eeba31dd4e8768c078d22))
+
+### BREAKING CHANGES
+
+- source maps have been completely rewritten
+- breaking changes introduced to every package public API
+
 ## [1.12.2](https://github.com/speclynx/apidom/compare/v1.12.1...v1.12.2) (2025-12-23)
 
 **Note:** Version bump only for package @speclynx/apidom-parser-adapter-yaml-1-2

package/NOTICE

@@ -5,11 +5,6 @@ This distribution includes modifications by SpecLynx.
 All such modifications are licensed under the Apache License, Version 2.0.
 A copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt`.
 
-ApiDOM
-Copyright 2020 SmartBear Software Inc.
-ApiDOM is licensed under Apache 2.0 license.
-Copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt` file.
-
 json-schema-ref-parser
 Copyright (c) 2015 James Messinger
 File packages/apidom-reference/src/util/url.ts (the file) was originally created under MIT license in https://github.com/APIDevTools/json-schema-ref-parser repository.
@@ -18,8 +13,8 @@ Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 
 graphql-js
 Copyright (c) GraphQL Contributors
-File packages/apidom-ast/src/traversal/visitor.ts (the file) was originally created under MIT license in https://github.com/graphql/graphql-js repository.
-The file has been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+File packages/apidom-traverse/src/traversal.ts (the file) was originally inspired by https://github.com/graphql/graphql-js repository.
+All modifications are licensed under Apache 2.0 License.
 Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 
 babel-plugin-add-import-extension
@@ -54,6 +49,20 @@ Copyright (c) 2012 James Halliday, Josh Duff, and other contributors
 Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 All modifications are licensed under Apache 2.0 License.
 
+ApiDOM
+Copyright 2020 SmartBear Software Inc.
+ApiDOM is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt` file.
+
+minim
+Copyright (c) 2014 Stephen Mizell
+The apidom-datamodel package contains code originally created under the MIT
+License as part of the Minim project (https://github.com/refractproject/minim).
+This code has been copied into this project and modified.
+The original portions remain licensed under the MIT License. Our modifications
+to that code are licensed under the Apache License 2.0.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+
 ---
 
 If the SPDX-FileCopyrightText and SPDX-License-Identifier tags are not present in the file,

package/README.md

@@ -44,9 +44,14 @@ Defines list of media types that this parser adapter recognizes.
 
 ### detect
 
-[Detection](https://github.com/speclynx/apidom/blob/main/packages/apidom-parser-adapter-yaml-1-2/src/adapter.ts#L3) of this parser adapter
-always returns `false`. The reason is that it's almost impossible to detect if a source string is YAML without actually parsing it.
-Don't rely on this function, rather use `mediaType` instead and please read [Word on detect vs mediaTypes](https://github.com/speclynx/apidom/tree/main/packages/apidom-parser#word-on-detect-vs-mediatypes).
+Detection indicates whether the provided source string is valid YAML.
+
+Option | Type | Default | Description
+--- | --- | --- | ---
+<a name="detect-strict"></a>`strict` | `Boolean` | `false` | Use strict detection mode ([yaml](https://www.npmjs.com/package/yaml) library).
+
+In default mode, detection uses tree-sitter for parsing with error recovery.
+In strict mode, detection uses the [yaml](https://www.npmjs.com/package/yaml) library which is faster.
 
 ### namespace
 
@@ -59,9 +64,25 @@ This adapter exposes an instance of [base ApiDOM namespace](https://github.com/s
 Option | Type | Default | Description
 --- | --- | --- | ---
 <a name="sourceMap"></a>`sourceMap` | `Boolean` | `false` | Indicate whether to generate source maps.
+<a name="strict"></a>`strict` | `Boolean` | `false` | Use strict parsing mode ([yaml](https://www.npmjs.com/package/yaml) library). When `true`, parsing is faster but doesn't support source maps.
 
 All unrecognized arbitrary options will be ignored.
 
+#### Parsing modes
+
+This adapter supports two parsing modes:
+
+**Tree-sitter mode** (default, `strict: false`):
+- Uses [web-tree-sitter](https://www.npmjs.com/package/web-tree-sitter) for parsing
+- Provides error recovery for malformed YAML
+- Supports source map generation
+- Full YAML 1.2 spec compliance with custom AST
+
+**Strict mode** (`strict: true`):
+- Uses [yaml](https://www.npmjs.com/package/yaml) library for parsing
+- Faster performance
+- Does not support source maps (throws error if both `strict` and `sourceMap` are `true`)
+
 ## Usage
 
 This parser adapter can be used directly or indirectly via [@speclynx/apidom-parser](https://github.com/speclynx/apidom/tree/main/packages/apidom-parser).
@@ -74,12 +95,18 @@ with [supported media types](#mediatypes).
 ```js
 import { parse, detect } from '@speclynx/apidom-parser-adapter-yaml-1-2';
 
-// always detecting false in this parser adapter
-await detect('prop: value'); // => false
-await detect('test'); // => false
+// detecting (tree-sitter mode - default)
+await detect('prop: value'); // => true
+await detect('{invalid:'); // => false
 
-// parsing
+// detecting (strict mode)
+await detect('prop: value', { strict: true }); // => true
+
+// parsing (tree-sitter mode - default, with source maps)
 const parseResult = await parse('prop: value', { sourceMap: true });
+
+// parsing (strict mode - faster, no source maps)
+const parseResultStrict = await parse('prop: value', { strict: true });
 ```
 
 ### Indirect usage

package/dist/167.apidom-parser-adapter-yaml-1-2.browser.min.js

@@ -1 +1 @@
-(self.webpackChunkapidomParserAdapterYaml1_2=self.webpackChunkapidomParserAdapterYaml1_2||[]).push([[167],{9167:()=>{}}]);
+(self.webpackChunkapidomParserAdapterYaml1_2=self.webpackChunkapidomParserAdapterYaml1_2||[]).push([[167],{167:()=>{}}]);

package/dist/451.apidom-parser-adapter-yaml-1-2.browser.min.js

@@ -1 +1 @@
-(self.webpackChunkapidomParserAdapterYaml1_2=self.webpackChunkapidomParserAdapterYaml1_2||[]).push([[451],{9451:()=>{}}]);
+(self.webpackChunkapidomParserAdapterYaml1_2=self.webpackChunkapidomParserAdapterYaml1_2||[]).push([[451],{451:()=>{}}]);