Download the PHP package aeliot/todo-registrar without Composer

On this page you can find all versions of the php package aeliot/todo-registrar. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package todo-registrar

logo

GitHub Release Testing Security Audit

It scans PHP and YAML source files for TODO/FIXME and other configured tags, registers them as issues in trackers such as JIRA or GitHub, and injects issue keys back into comments — with labels, linked issues, assignees, and other metadata as you configure.

Motivation

Developers often leave notes in code so they do not forget to fix something — and then forget anyway. One reason is that such comments are hard to manage centrally.

Why write a comment in code instead of creating an issue? It is convenient: no issue tracker UI, no repeated form filling, and the note sits exactly where the change is needed. Whatever the reason, those comments can stay in the codebase for years.

Someone has to manage them.

This tool registers issues with the parameters you need and injects ticket IDs/keys into the original comments. That prevents duplicate issues and makes it easy to jump from a tracker ticket to the right place in code.

How it works

  1. Detect a TODO (or other configured tag) in a comment.
  2. Create an issue in the issue tracker (list of supported).
  3. Inject the ticket key into the comment and save the source file.

detect_register_inject.png

See latest benchmark here.

According to benchmark TODO Registrar became quicker 20% since version 4.0.0.

Using

Basic usage:

  1. Create a configuration file.
  2. Run the CLI with the needed command line options.
  3. Commit updated files. You can configure a CI job to run the tool and commit changes automatically.

Prepared ways to run:

  1. TODO Registrar Action for GitHub repositories.
  2. Docker container.
  3. PHAR file.
  4. Composer package.

For GitHub-hosted repositories, the GitHub Action is the simplest option.

Docker provides a fully isolated environment — no dependency on your local PHP version or Composer packages.

A single PHAR file also avoids dependency conflicts, but you must match PHP version and extensions on the host.

The Composer package is the most common integration, but less flexible than Docker or PHAR.

Documentation references

  1. Processing flow — what happens on each run
  2. Features — index of all capabilities
  3. Command line options
  4. Configuration:
    1. General config
      1. Config format:
        1. YAML file
        2. PHP file
        3. YAML from STDIN
    2. Inline config
    3. Issue trackers:
      1. GitHub
      2. GitLab
      3. JIRA
      4. Redmine
      5. Yandex Tracker
  5. Supported formats of comments
  6. Integration on CI
  7. Customization

Supported Issue Trackers

Issue Tracker Description
GitHub See description of configuration. Supported via API tokens.
GitLab See description of configuration. Supported via API tokens (HTTP Token or OAuth).
JIRA See description of configuration. Supported via API tokens.
Redmine See description of configuration. Supported via API keys or Basic Auth.
Yandex Tracker See description of configuration. Supported via OAuth tokens.
Other Issue Trackers Request an implementation through the issues section or see customization section to do it yourself.

GitHub Actions based on the project

Articles

RU: https://habr.com/ru/articles/832994/

Contributing

Read contributing instructions.

All versions of todo-registrar with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-ctype Version *
ext-mbstring Version *
ext-simplexml Version *
ext-tokenizer Version *
aeliot/env-resolver Version ^1.0.2
aeliot/todo-registrar-contracts Version ^3.0.0
aeliot/yaml-token Version 0.1.*
bugrov/yandex-tracker Version 0.1.0
guzzlehttp/guzzle Version ^7.9
http-interop/http-factory-guzzle Version ^1.2
kbsali/redmine-api Version ^2.8
knplabs/github-api Version ^3.14
lesstif/php-jira-rest-client Version ^5.8
m4tthumphrey/php-gitlab-api Version ^11.14
netresearch/jsonmapper Version ^4.2
nikic/php-parser Version ^5.7
psr/container Version ^2.0
psr/http-client Version ^1.0
symfony/config Version ^7.4
symfony/console Version ^7.4
symfony/dependency-injection Version ^7.4
symfony/deprecation-contracts Version ^3.6
symfony/finder Version ^5.4|^6.0|^7.0
symfony/validator Version ^7.4
symfony/yaml Version ^3.4|^4.0|^5.0|^6.0|^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package aeliot/todo-registrar contains the following files

Loading the files please wait ...