[src-run] cocoa-var-dumper-library
| Travis-CI |
Codacy Rating |
Code Coverage |
Style-CI |
Release |
API Documentation |
 |
 |
 |
 |
 |
 |
Overview
Welcome!
The src-run/cocoa-var-dumper-library package provides the following, (*1)
A simple variable var-dumper/transformer library wrapping the symfony/var-dumper component., (*2)
Grouping
We use a Willy Wonka-inspired naming schema for our package group names. This package is part of the
cocoa group, which is a collection of packages with a focus
on "transforming, producing, or generating new outputs from given inputs" and related functionality., (*3)
You are welcome to research some useless details
about this specific group if you have too much time on your hands., (*4)
JTT
This package represents a single project within a large collection of open-source code
released under the "SR" namespace, comprised of many framework-agnostic libraries, a collection of Symfony bundles, as
well as some one-off releases. This project is authored and maintained by:, (*5)
Quick Start
Installation
Get the code by requiring it explicitly via the Composer CLI, or by editing your
composer.json to reflect the dependency and updating your project requirements. For example, to explicitly require
this project using the CLI, use the following command., (*6)
$ composer require src-run/cocoa-var-dumper-library
Alternatively, to add this project to your "composer.json" file, add the following to the "require" section., (*7)
require: {
"src-run/cocoa-var-dumper-library": "dev-master"
}
Note: Is is not recommended to use the "dev-master" constraint. Realize that doing so could allow a release with
backwards-incompatable, breaking changes to be pulled in. Instead, it is good practive to use semantic versioning and
enter an explicit requirement. For example, to require version 1.0 you would use ^1.0., (*8)
Reference
API Docs
This package's API reference is available on our documentation website (see the "Reference" row of the table found in
the "Additional Links" section below). All API documentation is automatically compiled against the master branch
whenever a git push event occurs., (*9)
Static API reference for specific releases is planned and will be posted once this package has matured and reached
the version 1 milestone., (*10)
The API reference websites detailed above are auto-generated using a reliable and well-developed CLI tool called
Sami. It is rigorously and regularly tested and is used for some large-scale projects, such
as the Symfony Full-Stack Framework , as well some
smaller projects, such as Twig . Refer to Sami's
repository page to research usage in your own project., (*11)
Examples/Tutorials
Currently, there is no "human-written" documentation, outside of this README (which is itself generated from a
template). Pending package stability, available man-hours, and an actual demand from external users, we may publish
a Read the Docs page with official documentation, tutorials, and additional resources., (*12)
Contributing
Discussion
For general inquiries or to discuss a broad topic or idea, find "robfrawley" on Freenode. He is always happy to
discuss language-level ideas, possible new directions for a project, emerging technologies, as well as the weather., (*13)
Issues
To report issues or request a new feature, use the project issue tracker.
Include as much information as possible in any bug reports. Feel free to "ping" the topic if you don't get a response
within a few days (sometimes Github notification e-mails fall through the cracks)., (*14)
Code
You created additional functionality while utilizing this package? Wonderful: send it back upstream! Don't hesitate to
submit a pull request! Your imagination and the requirements outlined within
our CONTRIBUTING.md file are the only limitations., (*15)
License
This project is licensed under the MIT License, an FSF- and
OSI-approved, GPL-compatible, permissive free software license.
Review the LICENSE file distributed with this source code for additional
information., (*16)
Additional Links
| Item |
Result/Status |
| Stable Release |
|
| Dev Release |
 |
| License |
 |
Wallogit.com
