Custom checks through command line

[ankita240796]

closes #702

• Added mechanism to specify a custom checks folder.

[rriemann]

Would it be possible to configure the checks folder also in the .proselintrc?

[rriemann]

I have installed proselint as root. However, when I run this command, it fails because of missing rights or because the folder "." exists already.

It must be clear that this command changes the system configuration permanently.

[ankita240796]

@rriemann That was a good suggestion! I have added the feature to configure custom checks to .proselintrc.

[rriemann]

So if I have a checks folder configured in my ~/.proselintrc, on every call of proselint, all (new) files will be copied to the checks directory?

Is there a check in the code if the destination directiory in writeable?

[ankita240796]

When a command line option check is used with an input path, the specified directory gets copied to checks folder and the checks are marked as true in .proselintrc.

[suchow]

Hi @ankita240796, thank you for the PR! :)

Would it be possible to:

1. Split this PR into two smaller PRs, one that adds the custom path feature and another that adds the custom checks feature? I'm ready to accept the former immediately, but need to think more deeply about the latter.

2. Add documentation to the "Checks section" of the README and to the docs showing how to use the custom path feature?

[ankita240796]

Sure @suchow I will make the changes as suggested by you!

[jima80525]

Will this change cover the case where the user wants a custom .proselintrc file in the current directory?

I'm willing to add that feature if not, as I'd like to use this tool in an automated toolchain (on circleci) but I'd rather have the rc file be part of my repo, not requiring it to be in the ~ directory.

[ProselintBot]

Proselint found issues

README.md

Line	Message	Severity
66	Comparison of an uncomparable: 'very unique.' is not comparable.	warning
66	Substitute 'damn' every time you're inclined to write 'very'; your editor will delete it and the writing will be just as it should be. Found 7 times elsewhere.	warning
135	Comparison of an uncomparable: 'very unique"' is not comparable.	warning
212	RAS syndrome. Use 'RAS' instead of 'RAS syndrome'.	warning

Generated by 🚫 Danger

[ankita240796]

Hi @suchow, sorry for delay on this. I was busy with my academics. I have made the changes as suggested by you. Please take a look, Thanks!

Also can you please help me with the failing build.

[ankita240796]

Hi @jima80525, this change intended to add a feature for providing a custom location for .proselintrc but as suggested by @suchow, I have reverted that feature from this PR. I can submit another PR for that if you are not working on that feature, Thanks!

[ankita240796]

Hi @suchow any updates on this?

[ankita240796]

I have also issued a separate PR for adding custom path: #865

[Nytelife26]

Custom checks are something I was thinking about earlier, so this is a nice surprise. I'll triage now and I'm fairly sure we implemented a config path already but I'll triage the other too.

[ankita240796]

Custom checks are something I was thinking about earlier, so this is a nice surprise. I'll triage now and I'm fairly sure we implemented a config path already but I'll triage the other too.

Ok Thanks @Nytelife26, let me know if I can help with something :)

[Nytelife26]

I'm not entirely sure copying the new checks into the checks folder is the best way to go about this. One would assume supplying a custom checks folder via CLI, rather than via configuration, persists solely for that command.

[ankita240796]

I'm not entirely sure copying the new checks into the checks folder is the best way to go about this. One would assume supplying a custom checks folder via CLI, rather than via configuration, persists solely for that command.

Should I take that up and add a fix in this PR?

[Nytelife26]

Should I take that up and add a fix in this PR?

If you so wish! Any help is greatly appreciated. If you need anything or have any questions, do let me know. Glad to have you here.

[ankita240796]

Sure, I am working on this, will update once I finalize the design approach.