atmos/shellharden
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

--besserwisser → --transform

Browse Source
This commit is contained in:
Andreas Nordal 2018-05-12 03:52:41 +02:00
parent 4011636845
commit 6ea973c20a
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -12,7 +12,7 @@ Because rewriting scripts to adhere to the *always use quotes* principle can be
Above: Selected portions of `xdg-desktop-menu` as highlighted by Naziquote.
The foreground colors are syntax highlighting, whereas the background colors
(green and red) show characters that Naziquote would have added or removed
if let loose with the `--besserwisser` option.
if let loose with the `--transform` option.
Below: An artificial example that shows more tricky cases and special features.
![artificial example](img/ex-artificial.png)
@ -54,7 +54,7 @@ Build
Usage advice
------------
Don't apply `--besserwisser` blindly; code review is still necessary: A script that *relies* on unquoted behavior (implicit word splitting and glob expansion from variables and command substitutions) to work as intended will do none of that after getting the `--besserwisser` treatment!
Don't apply `--transform` blindly; code review is still necessary: A script that *relies* on unquoted behavior (implicit word splitting and glob expansion from variables and command substitutions) to work as intended will do none of that after getting the `--transform` treatment!
In that unlucky case, ask yourself whether the script has any business in doing that. All too often, it's just a product of classical shellscripting, and would be better off rewritten, such as by using arrays. Even in the opposite case, say the business logic involves word splitting; that can still be done without invoking globbing. In short: There is always a better way than the forbidden syntax (if not more explicit), but some times, a human must step in to rewrite. See how, in the accompanying [how to do things safely in bash](how_to_do_things_safely_in_bash.md).

10
naziquote.rs
View File

@ -60,8 +60,8 @@ fn main() {
sett.syntax=true;
None
},
"--besserwisser" => {
sett.osel=OutputSelector::BESSERWISSER;
"--transform" => {
sett.osel=OutputSelector::TRANSFORM;
sett.syntax=false;
None
},
@ -78,7 +78,7 @@ fn main() {
--suggest Output a colored diff suggesting changes.\n\
--syntax Output syntax highlighting with ANSI colors.\n\
--syntax-suggest Diff with syntax highlighting (default mode).\n\
--besserwisser Output suggested changes.\n\
--transform Output suggested changes.\n\
"
);
None
@ -104,7 +104,7 @@ fn main() {
enum OutputSelector {
ORIGINAL,
DIFF,
BESSERWISSER,
TRANSFORM,
}
struct Settings {
@ -361,7 +361,7 @@ fn write_transition(
(Some(replacement), OutputSelector::DIFF) => {
write_diff(out, &mut color_cur, color_transition, replaceable, &replacement)
},
(Some(replacement), OutputSelector::BESSERWISSER) => {
(Some(replacement), OutputSelector::TRANSFORM) => {
write_colored_slice(out, &mut color_cur, color_transition, replacement)
},
(_, _) => {