inclusive-dev-tools / woke

✊ Detect non-inclusive language in your source code.
https://medium.com/@caitlinelfring/woke-437880c3de64
MIT License
0 stars 0 forks source link

Ability to pull in remote configs from N number of URLs #33

Open mkcomer opened 3 years ago

mkcomer commented 3 years ago

Description Once get-woke/woke#122 is merged, woke will be able to set a remote config (ruleset) from a URL. We would like to enhance get-woke/woke#122, by allowing users to apply N number of remote rulesets (N number of URLs as cli arguments).

After get-woke/woke#122 is merged, users can apply 1 URL. For example:

woke -c "https://raw.githubusercontent.com/get-woke/woke/main/example.yaml"

Desired functionality with this enhancement: woke -c https://raw.githubusercontent.com/get-woke/woke/main/example1.yaml https://raw.githubusercontent.com/get-woke/woke/main/example2.yaml https://raw.githubusercontent.com/get-woke/woke/main/example3.yaml

The final applied ruleset from the above example will be a combination of rules defined in the default.yaml, example1.yaml, example2.yaml and example3.yaml.

Useful links/additional context: Feature enhancement referenced here by the maintainer: https://github.com/get-woke/woke/issues/104

Woke currently allows you to set a local ruleset (N=1). For example: woke -c /Documents/example.yaml

With get-woke/woke#122, woke allows you to apply a remote ruleset (N=1).

With this feature enhancement, woke will allow you to set N number of remote ruleset URLs.

Suggestion: It may be worth reaching out to maintainer to ask if the N number of rulesets should also be enabled for local rulesets as well (this is not current functionality).

Acceptance Criteria: