Download the PHP package alister/todotxt-parser without Composer
On this page you can find all versions of the php package alister/todotxt-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 todotxt-parser
alister/todotxt-parser
parser for the TodoTxt format
Installation
Install this package as a dependency using Composer.
Contributing
Contributions are welcome! Before contributing to this project, familiarize yourself with CONTRIBUTING.md.
To develop this project, you will need PHP 7.4 or greater, Composer, Node.js, and Yarn.
After cloning this repository locally, execute the following commands:
Now, you are ready to develop!
Tooling
This project uses Husky and lint-staged to validate all staged changes prior to commit.
Composer Commands
To see all the commands available in the project td namespace for
Composer, type:
Composer Command Autocompletion
If you'd like to have Composer command auto-completion, you may use bamarni/symfony-console-autocomplete. Install it globally with Composer:
Then, in your shell configuration file — usually ~/.bash_profile or ~/.zshrc,
but it could be different depending on your settings — ensure that your global
Composer bin directory is in your PATH, and evaluate the
symfony-autocomplete command. This will look like this:
Now, you can use the tab key to auto-complete Composer commands:
Coding Standards
This project follows a superset of PSR-12
coding standards, enforced by PHP_CodeSniffer.
The project PHP_CodeSniffer configuration may be found in phpcs.xml.dist.
lint-staged will run PHP_CodeSniffer before committing. It will attempt to fix any errors it can, and it will reject the commit if there are any un-fixable issues. Many issues can be fixed automatically and will be done so pre-commit.
You may lint the entire codebase using PHP_CodeSniffer with the following commands:
Static Analysis
This project uses a combination of PHPStan
and Psalm to provide static analysis of PHP
code. Configurations for these are in phpstan.neon.dist and psalm.xml,
respectively.
lint-staged will run PHPStan and Psalm before committing. The pre-commit hook does not attempt to fix any static analysis errors. Instead, the commit will fail, and you must fix the errors manually.
You may run static analysis manually across the whole codebase with the following command:
Project Structure
This project uses pds/skeleton as its base folder structure and layout.
| Name | Description |
|---|---|
| bin/ | Commands and scripts for this project |
| build/ | Cache, logs, reports, etc. for project builds |
| docs/ | Project-specific documentation |
| resources/ | Additional resources for this project |
| src/ | Project library and application source code |
| tests/ | Tests for this project |
Copyright and License
The alister/todotxt-parser library is copyright © Alister Bulman and licensed for use under the terms of the MIT License (MIT). Please see LICENSE for more information.
