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

Make proselint . run over entire directory, possibly with a recursive option #292

Closed
suchow opened this issue Feb 23, 2016 · 5 comments
Closed
Assignees

Comments

@suchow
Copy link
Member

suchow commented Feb 23, 2016

No description provided.

@mpacer
Copy link
Member

mpacer commented Mar 7, 2016

Possibly including a recursive flag? It would seem that doing one would make the other fairly easy. I may be able to get to this next week.

@mpacer mpacer changed the title Make proselint . run over entire directory Make proselint . run over entire directory, possibly with a recursive option Mar 7, 2016
@mpacer mpacer self-assigned this Mar 7, 2016
@suchow
Copy link
Member Author

suchow commented Mar 10, 2016

Okay, what I'd like to do here is to match the convention of jshint, pep8, and others, where you run:

proselint .

and it runs over the whole directory. I tried implementing this by interpreting the file input arguments as Click Paths, but that didn't seem to work because I then had trouble opening the files.

@jstewmon, as our resident Click expert, would you be willing to take a look at this?

@jstewmon
Copy link

jshint and pep8 operate on files with a particular extension - js and py, respectively. Does that constraint apply to proselint?

It seems to me that proselint may work on any type of text file that contains sentences, so would you expect that proselint . finds and checks all non-binary files?

You could defer the responsibility of answering the above questions to the user by updating the docs with examples of how to use find | xargs to supply the list of files to check. If you went that route, we would only need to change the printer to not strip the file path.

@suchow
Copy link
Member Author

suchow commented Mar 13, 2016

Okay, I created a first draft of this in PR #388. For now, it defines some limited set of file extensions (.txt, .md, .rtf, .html, .tex, .markdown) that get checked when you run .proselint. This will eventually be beefed up when proselint can detect the markup and turn off rules that false alarm on markup.

The find | xargs idea sounds good for now, though I'm unfamiliar with it, so I won't be able to update the docs myself until I learn more.

@suchow
Copy link
Member Author

suchow commented Apr 4, 2016

Closed by #388.

@suchow suchow closed this as completed Apr 4, 2016
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

3 participants