Download the PHP package ajcastro/scribe-tdd without Composer
On this page you can find all versions of the php package ajcastro/scribe-tdd. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ajcastro/scribe-tdd
More information about ajcastro/scribe-tdd
Files in ajcastro/scribe-tdd
Package scribe-tdd
Short Description Scribe's test-driven documentation approach.
License MIT
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 scribe-tdd
Scribe TDD (Test-driven Documentation)
Scribe's test-driven documentation approach.
Benefits
- Better workflow, instead of writing docblock annotations for parameters in controller, you can auto-generate documentation from the tests performed.
- Less comments cluttering in controllers. Some annotations are still needed (like @group) but annotations can be put in the test classes instead.
- Easy to document controllers which methods are inherited from base controllers or traits by putting docblocks in the test methods.
- Follows the principle "If it is not tested, it does not exist.". This makes sure your docs and tests are in sync.
- It is easy to document responses because it is from the performed tests and does not rely on response calls which sometimes result to errors due to inconsistent database state.
Installation and Setup
Step 1: Composer Require
Step 2: Use ScribeTddSetup trait in TestCase
Step 3: Set the necessary strategies
It is up to you if you want to disable existing default strategies or just add these strategies so you can enjoy both worlds.
Usage
Step 1: Create and run tests
Just create your usual phpunit tests and run them. This will generate the necessary files that will be used for generating scribe documentation later.
Step 2: Run scribe:generate
Make sure to use --force to remove cached output.
Step 3: Gitignore auto-generated json files
Add the following to your .gitignore to ignore auto-generated json files.
You should commit your created files, those which are ending in [email protected], so that it will always be applied when generating api documentation.
Step 4: Delete auto-generated files (Optional)
When you run the phpunit tests, it creates a lot of files. You can delete these files when you already generated the api documentation by
running the command below. This will not delete your created files.
Sample Usage
Here is a sample project where it uses the tdd approach: https://github.com/ajcastro/TheSideProjectAPI/pull/1
Acknowledgement
This package is inspired from Enlighten.
