haxelib.json

Haxelib manifest

Type object
File match haxelib.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/haxelib-json/latest.json
Source https://raw.githubusercontent.com/HaxeFoundation/haxelib/master/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A haxelib project

Properties

name string required

The name of a haxelib project

minLength=3pattern=^[A-Za-z0-9_.-]{3,}$
license enum required

Open source license under which the project is licensed

Values: "GPL" "LGPL" "BSD" "Public" "MIT" "Apache"
version string required

Project's version

pattern=^(\d|[1-9]\d*)\.(\d|[1-9]\d*)\.(\d|[1-9]\d*)(-(alpha|beta|rc)(\.(\d|[1-9]\d*))?)?$
contributors userName[] required

List of project contributors that are allowed to upload to haxelib

minItems=1uniqueItems=true
releasenote string required

Short description of changes made in this version

url string

Project's website

format=uri
description string

Short description of the project

classPath string

Folder in the package which contains the source files for this project

main string

A class to run on haxelib run libraryname command. Relative to library root. E.g. to run tools/Main.hx the value should be tools.Main. Default value since Haxe 4: Run

tags haxelibTag[]

List of tags for easier finding the project on haxelib

uniqueItems=true
dependencies object

Project's dependencies

documentation object

Project's documentation resources

2 nested properties
defines string

Relative path to json file describing this project's custom defines

metadata string

Relative path to json file describing this project's custom metadata

Definitions

userName string

The name of a user

projectName string

The name of a haxelib project

haxelibTag string

A keyword or term associated with a haxelib project

semver string

Project's version

dependencyVersion semver | string