Library and example circular dependency in git

Question

I'm making a js library and using git for version control. Say it's located at mylib/lib.js. Inside my library directory, I have a submodule for an example program that I'm developing alongside that library, say mylib/example/example.js. Now, the question is: how should the example program access the library?

If I use a relative path to go up and grab the js file (like ../lib.js), that means that the example isn't standalone; the only way to run it would be to clone the library. Then there's really no point to have it be a submodule at all.

If I copy lib.js into the example directory, then I'm violating DRY and I'd have to copy it every time it gets updated (which is going to be a lot).

Is there a better solution to this problem?

chelmertz · Accepted Answer · 2011-09-18 06:55:31Z

4

I think you should have the library as a submodule of the example instead, or a plain exported version. That's what it will look like for your users as well.

If it's to annoying to update all of the time, write a local* build/makefile/git hook that makes sure (all of) your example program(s) receive the latest version of your lib.js.

*Local as inside .gitignore because that exact setup is only interesting to you as a developer, on your machine

answered Sep 18, 2011 at 6:55

chelmertz

20.6k5 gold badges42 silver badges46 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Library and example circular dependency in git

1 Answer 1

Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Related