Skip to content

Commit e40fc29

Browse files
committed
docs(test): add fileoverview headers to core and type-specific test files
Add descriptive @fileoverview headers to core functionality tests: - package-url.test.mts: main PackageURL API, constructor, parsing, encoding - purl-types.test.mts: type-specific normalizations (npm, pub, pypi)
1 parent 0925161 commit e40fc29

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

test/package-url.test.mts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2020
SOFTWARE.
2121
*/
2222

23+
/**
24+
* @fileoverview Core unit tests for PackageURL class.
25+
* Tests the main PackageURL API including constructor validation, toString/fromString parsing,
26+
* encoding/decoding, qualifiers, subpaths, known qualifier names immutability, input validation,
27+
* and support for parsing without the "pkg:" prefix for improved developer ergonomics.
28+
*/
2329
import { describe, expect, it } from 'vitest'
2430

2531
import { PackageURL } from '../src/package-url.js'

test/purl-types.test.mts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2020
SOFTWARE.
2121
*/
2222

23+
/**
24+
* @fileoverview Unit tests for type-specific PackageURL behavior.
25+
* Tests package-type-specific normalizations and validations for npm (legacy names, builtins),
26+
* pub (dash-to-underscore), and pypi (lowercase, underscore-to-dash) package types.
27+
*/
2328
import { describe, expect, it } from 'vitest'
2429

2530
import npmBuiltinNames from '../data/npm/builtin-names.json'

0 commit comments

Comments
 (0)