Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Retrieving project meta information #17

Open
augustohp opened this issue Sep 5, 2012 · 2 comments
Open

Retrieving project meta information #17

augustohp opened this issue Sep 5, 2012 · 2 comments

Comments

@augustohp
Copy link
Member

As noted by @alganet, Doc is evolving and we need to get some meta information from the project, such as:

  • Project library/src folder
  • Test folder
  • Composer/Pear packages description

We have a lot of ways to do that, a lot of that information is already provided by Foundation so we should use it? Or how should we do it?

Let the discussion flow now =P

PS: Related issues #4, #13 and #16

@alganet
Copy link
Member

alganet commented Sep 5, 2012

We really don't need to do that, we just need to ask for it!

$doc = new Respect\Doc();
$doc->fromSources('src/*.php')
       ->fromTests('/test/*Test.php')
       ->fromPackages('composer.json', 'phpunit.xml')
       ->generate();

Using Respect\Foundation outside the CLI is also possible, so the developer can run this:

$libraryFolder = (string) new Respect\Foundation\InfoProviders\LibraryFolder;

(Which reminds me that we should create a fluent interface for Foundation, like f::libraryFolder()).

This bootstrap is their responsibility, we provide both the documentation generator and information provider, the developer binds them both. We can offer him a sample bootstrap or config.ini for ed, but he must know how to bind the components (it's easy!).

@augustohp
Copy link
Member Author

An ed it is when it is needed. =P

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants