wp-dev-lib icon indicating copy to clipboard operation
wp-dev-lib copied to clipboard

Organize files into directories

Open JDGrimes opened this issue 10 years ago • 4 comments

Any thoughts on organizing the files into directories?

  1. This makes things more organized, which may be useful as more stuff is added.
  2. Having some files in the main directory is a pain. For example, we can't have Travis run syntax checks on the files for us, because the example .travis.yml is in the main directory.

I'm thinking of something like this:

travis/
 - .travis.yml
 - before_script.sh
 - after_script.sh
 - script.sh
readme/
 - class-wordpress-readme-parser.php
 - generate-markdown
phpunit/
 - plugin-bootstrap.php
 - plugin.xml
etc.

The only issue is that this isn't backward compatible, which might be a deal-breaker. :frowning:

JDGrimes avatar Feb 23 '15 20:02 JDGrimes

You're right. It does need directory organization.

Not concerned so much with backwards-compat. If plugin repos are using the submodule, then they'll not break since they'll reference a commit hash anyway, a point where the old directory structure was in place. It's just that updating the submodule after this change may require some symlink updates in the contained plugin/theme repo as well.

westonruter avatar Feb 23 '15 20:02 westonruter

It's just that updating the submodule after this change may require some symlink updates in the contained plugin/theme repo as well.

Right. I just wanted to make sure that it wasn't overlooked.


So, basically, I think all files (except readme.md and contributing.md, etc.) should be moved to supdirectories.

JDGrimes avatar Feb 23 '15 21:02 JDGrimes

Would you like me to submit a PR, or should I work on #82 first? I think things will get tangled if this happens in the middle of work on something else.

JDGrimes avatar Feb 23 '15 21:02 JDGrimes

Let's hold off on the re-org until later, yeah.

westonruter avatar Feb 23 '15 21:02 westonruter