bamos / girl

Check your GitHub READMEs for broken links.
http://bamos.github.io/girl
MIT License
70 stars 17 forks source link

Consider a command line tool as well #36

Open seagreen opened 8 years ago

seagreen commented 8 years ago

I'm looking for a tool to check a repository on my file system for broken links. Would it be easy for girl to include a command line tool as well as the main remote repository-checking function? If this is a bad idea feel free to close this.

bamos commented 8 years ago

Hi @seagreen - I wrote a small Python script for another project you might be interested in:

It does a regex search for URLs in the repo and checks them. I'll leave this issue open for now if anybody's interested in modifying girl to be a command line tool. I'd be interested in it, but the Python script works well for me now.

-Brandon.

seagreen commented 8 years ago

Thanks! That solves my immediate problem of needing a script.

Philosophically, I've been wondering whether it's a sign of good practices for the core of a server and its web UI to be decoupled (with a test of that being that you could build a CLI program and interact with the server from there instead of the web API). In many cases decoupling UI and core logic is a good idea, in practice it may be tricky with server programs.

PS girl is a neat project, I've enjoyed looking over the design and the running site.