Download the PHP package zero-to-prod/docblock-annotator-cli without Composer
On this page you can find all versions of the php package zero-to-prod/docblock-annotator-cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zero-to-prod/docblock-annotator-cli
More information about zero-to-prod/docblock-annotator-cli
Files in zero-to-prod/docblock-annotator-cli
Package docblock-annotator-cli
Short Description A cli for annotating Docblocks.
License MIT
Homepage https://github.com/zero-to-prod/docblock-annotator-cli
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package docblock-annotator-cli
Zerotoprod\DocblockAnnotatorCli
Contents
- Introduction
- Requirements
- Installation
- Documentation Publishing
- Automatic Documentation Publishing
- Usage
- Available Commands
docblock-annotator-cli:srcdocblock-annotator-cli:update-filedocblock-annotator-cli:update-directory
- Available Commands
- Docker Image
- Local Development
- Image Development
- Contributing
Introduction
A cli for annotating Docblocks.
Requirements
- PHP 8.1 or higher.
Installation
Install Zerotoprod\DocblockAnnotatorCli via Composer:
This will add the package to your project's dependencies and create an autoloader entry for it.
Documentation Publishing
You can publish this README to your local documentation directory.
This can be useful for providing documentation for AI agents.
This can be done using the included script:
Automatic Documentation Publishing
You can automatically publish documentation by adding the following to your composer.json:
Usage
Run this command to see the available commands:
Available Commands
docblock-annotator-cli:src
Displays the project's GitHub repository URL.
Usage:
Example:
docblock-annotator-cli:update-file
Adds lines to a PHP docblock in a specific file.
Usage:
Arguments:
file(required) - The PHP file to updatecomments(optional) - The comments to add to the docblock
Options:
--modifiers- The modifier of the member: public, private, protected (default: public)--statements- The statements to annotate: class_method, const, class, class_const, enum_case, enum, function, trait, property, interface (default: all)
Examples:
docblock-annotator-cli:update-directory
Adds lines to PHP docblocks in all files within a directory.
Usage:
Alias: docblock-annotator-cli:update
Arguments:
directory(required) - The directory to update PHP files incomments(optional) - The comments to add to the docblock
Options:
--modifiers- The modifier of the member: public, private, protected (default: public)--statements- The statements to annotate: class_method, const, class, class_const, enum_case, enum, function, trait, property, interface (default: all)--recursive/--no-recursive- Recursively search for files (default: recursive)
Examples:
Docker Image
You can also run the cli using the docker image:
Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Commit changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature-branch). - Create a new Pull Request.
All versions of docblock-annotator-cli with dependencies
ext-json Version *
symfony/console Version ^7.2
zero-to-prod/data-model Version ^81.9
zero-to-prod/docblock-annotator Version ^4.0
zero-to-prod/package-helper Version ^1.1.3