DEV Community

Jitendra
Jitendra

Posted on • Edited on

PHP project scaffolding (kickstarting) tool

Introducing my ambitious project phint. Already can do tons of things but more contributions would make it perfect. And new features are underway to please any prolific developer.

GitHub logo adhocore / phint

Interactively scaffolds and init new (or fixup old) PHP project/library with sane defaults using templates in no time

adhocore/phint

Initializes new PHP project with sane defaults using templates It scaffolds PHP library &/or project to boost your productivity and save time.

For already existing project, run with --sync flag to add missing stuffs, see phint init.

Once you have files in your src/ or lib/ you can run phint docs to generate API like documentation in .md format and phint test to generate basic test stubs with all the structures already maintained.

It helps you be even more lazier! phint is continuously evolving and the plan is to make it big.

Latest Version Travis Build Scrutinizer CI Codecov branch StyleCI Software License Tweet Support

Phint Preview

Installation · Features · Autocompletion · Usage · phint init · phint update · phint docs · phint test · Templating

Phint is powered by adhocore/cli

Installation

Requires PHP7.

Manual

Download phint.phar from latest release. And use it like so php /path/to/phint.phar [opts] [args]. Hmm not cool. See Command section below.

Command

#
Enter fullscreen mode Exit fullscreen mode

Phint is a productivity tool for console that Interactively scaffolds and initializes new PHP project with sane defaults using twig templates in no time. Flexible, extensible, customizable and many options to choose from.

Saves you plenty of time and effort doing mundane repetitive tasks.

Features:

  • generate dot files the likes of .gitignore, .travis.yml, . editorconfig etc
  • generate license, readme.md, composer.json with all deps
  • generate changelog stub, contributing guide, issue and PR template
  • generate binaries if any
  • git init
  • interactively ask and install all the dev and prod deps
  • generate phpunit.xml, test bootstrap.php
  • generate test stubs for all classes/methods corresponding to src (phint test)
  • generate docs (.md) from docblocks :) (phint docs)
  • update its own self (phint update)
  • support custom templates from a path user chooses :)

Thanks for reading. Please try it out and leave feedbacks. 😊

Top comments (5)

Collapse
 
adhocore profile image
Jitendra • Edited

Features:

  • generate dot files the likes of .gitignore, .travis.yml, . editorconfig etc
  • generate license, readme.md, composer.json with all deps
  • generate binaries if any
  • git init
  • interactively ask and install all the dev and prod deps
  • generate phpunit.xml, test bootstrap.php and stubs for all classes/methods corresponding to src
Collapse
 
david_j_eddy profile image
David J Eddy • Edited

Love it! I find it a pain to setup a new test project when developing composer libraries.

(I think you can edit the article to add the feature list.)

Collapse
 
adhocore profile image
Jitendra

could you maybe give it a try again? some cool features released (please run phint u if you have already installed) :)

Collapse
 
adhocore profile image
Jitendra

Done, thanks :)
As a early stage project it needs some refinement. And feedbacks would really help. Hope you would try it out and leave some notes.

Collapse
 
adhocore profile image
Jitendra

new releases available with some small but good features and improvements.
github.com/adhocore/phint/releases

if you installed already please run phint u
if not, please check docs

thanks 👏