2011-08-20 12:55:01 +00:00
{
"name" : "Package" ,
"type" : "object" ,
"additionalProperties" : false ,
"properties" : {
"name" : {
"type" : "string" ,
2011-11-20 15:23:22 +00:00
"description" : "Package name, including 'vendor-name/' prefix." ,
2011-08-20 12:55:01 +00:00
"required" : true
} ,
"type" : {
2011-11-20 15:23:22 +00:00
"description" : "Package type, either 'library' for common packages, 'composer-installer' for custom installers, or a custom type defined by whatever project this package applies to." ,
"type" : "string"
2011-08-20 12:55:01 +00:00
} ,
2011-10-16 16:52:08 +00:00
"target-dir" : {
2011-11-20 15:23:22 +00:00
"description" : "Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility." ,
2011-10-09 14:43:16 +00:00
"type" : "string"
} ,
2011-08-20 12:55:01 +00:00
"description" : {
"type" : "string" ,
2011-11-20 15:23:22 +00:00
"description" : "Short package description." ,
2011-08-20 12:55:01 +00:00
"required" : true
} ,
"keywords" : {
"type" : "array" ,
"items" : {
2011-11-20 15:23:22 +00:00
"type" : "string" ,
"description" : "A tag/keyword that this package relates to."
}
2011-08-20 12:55:01 +00:00
} ,
"homepage" : {
"type" : "string" ,
2011-11-20 15:23:22 +00:00
"description" : "Homepage URL for the project." ,
"format" : "uri"
2011-08-20 12:55:01 +00:00
} ,
"version" : {
"type" : "string" ,
2011-11-20 15:23:22 +00:00
"description" : "Package version, see http://packagist.org/about for more info on valid schemes." ,
2011-08-20 12:55:01 +00:00
"required" : true
} ,
2011-11-20 15:23:22 +00:00
"time" : {
"type" : "string" ,
"description" : "Package release date, in 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS' format."
} ,
2011-08-20 12:55:01 +00:00
"license" : {
2011-09-26 23:09:48 +00:00
"type" : [ "string" , "array" ] ,
2011-11-20 15:23:22 +00:00
"description" : "License name. Or an array of license names."
2011-08-20 12:55:01 +00:00
} ,
"authors" : {
"type" : "array" ,
2011-11-20 15:23:22 +00:00
"description" : "List of authors that contributed to the package. This is typically the main maintainers, not the full list." ,
2011-08-20 12:55:01 +00:00
"items" : {
"type" : "object" ,
"additionalProperties" : false ,
"properties" : {
"name" : {
"type" : "string" ,
2011-11-20 15:23:22 +00:00
"description" : "Full name of the author." ,
2011-08-20 12:55:01 +00:00
"required" : true
} ,
"email" : {
"type" : "string" ,
2011-11-20 15:23:22 +00:00
"description" : "Email address of the author." ,
"format" : "email"
2011-08-20 12:55:01 +00:00
} ,
"homepage" : {
"type" : "string" ,
2011-11-20 15:23:22 +00:00
"description" : "Homepage URL for the author." ,
"format" : "uri"
2011-08-20 12:55:01 +00:00
}
}
2011-11-20 15:23:22 +00:00
}
2011-08-20 12:55:01 +00:00
} ,
"require" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "This is a hash of package name (keys) and version constraints (values) that are required to run this package." ,
"additionalProperties" : true
2011-08-20 12:55:01 +00:00
} ,
2011-09-26 23:09:48 +00:00
"replace" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package." ,
"additionalProperties" : true
2011-09-26 23:09:48 +00:00
} ,
"conflict" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "This is a hash of package name (keys) and version constraints (values) that conflict with this package." ,
"additionalProperties" : true
2011-09-26 23:09:48 +00:00
} ,
"provide" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name." ,
"additionalProperties" : true
2011-09-26 23:09:48 +00:00
} ,
"recommend" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "This is a hash of package name (keys) and version constraints (values) that this package recommends to be installed (typically this will be installed as well)." ,
"additionalProperties" : true
2011-09-26 23:09:48 +00:00
} ,
"suggest" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "This is a hash of package name (keys) and version constraints (values) that this package suggests work well with it (typically this will only be suggested to the user)." ,
"additionalProperties" : true
2011-09-26 23:09:48 +00:00
} ,
2012-02-19 17:24:27 +00:00
"config" : {
"type" : [ "object" ] ,
"description" : "Composer options." ,
"properties" : {
"vendor-dir" : {
"type" : "string" ,
"description" : "The location where all packages are installed, defaults to \"vendor\"."
} ,
"bin-dir" : {
"type" : "string" ,
"description" : "The location where all binaries are linked, defaults to \"vendor/bin\"."
}
}
} ,
2011-08-20 12:55:01 +00:00
"extra" : {
"type" : [ "object" , "array" ] ,
2011-11-20 15:23:22 +00:00
"description" : "Arbitrary extra data that can be used by custom installers, for example, package of type composer-installer must have a 'class' key defining the installer class name." ,
"additionalProperties" : true
2011-10-09 14:43:16 +00:00
} ,
"autoload" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "Description of how the package can be autoloaded." ,
2011-10-22 19:44:19 +00:00
"properties" : {
"psr-0" : {
"type" : "object" ,
2011-11-20 15:23:22 +00:00
"description" : "This is a hash of namespaces (keys) and the directories they can be found into (values) by the autoloader." ,
2011-10-22 19:44:19 +00:00
"additionalProperties" : true
}
}
} ,
"repositories" : {
"type" : [ "object" , "array" ] ,
2011-11-20 15:23:22 +00:00
"description" : "A set of additional repositories where packages can be found." ,
2011-10-09 14:43:16 +00:00
"additionalProperties" : true
2012-02-19 17:11:21 +00:00
} ,
"scripts" : {
"type" : [ "object" ] ,
"description" : "Scripts listeners that will be executed before/after some events." ,
"properties" : {
"pre-install-cmd" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs before the install command is executed, contains one or more Class::method callables." ,
} ,
"post-install-cmd" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs after the install command is executed, contains one or more Class::method callables." ,
} ,
"pre-update-cmd" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs before the update command is executed, contains one or more Class::method callables." ,
} ,
"post-update-cmd" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs after the update command is executed, contains one or more Class::method callables." ,
} ,
"pre-package-install" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs before a package is installed, contains one or more Class::method callables." ,
} ,
"post-package-install" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs after a package is installed, contains one or more Class::method callables." ,
} ,
"pre-package-update" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs before a package is updated, contains one or more Class::method callables." ,
} ,
"post-package-update" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs after a package is updated, contains one or more Class::method callables." ,
} ,
"pre-package-uninstall" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs before a package has been uninstalled, contains one or more Class::method callables." ,
} ,
"post-package-uninstall" : {
"type" : [ "array" , "string" ] ,
"description" : "Occurs after a package has been uninstalled, contains one or more Class::method callables." ,
}
}
2011-08-20 12:55:01 +00:00
}
}
}