Skip to content

Commit

Permalink
aisingapore#387 - disable logging and generation of .raw .js .log fil…
Browse files Browse the repository at this point in the history
…es after each run

Sending a PR that lets users switch the logging off by default.

The default TagUI behaviour is generating .raw (expansion of modules and subscripts), .js (generated JavaScript code), .log (log of what happened during the automation. This feature would probably be useful by default for developers. For business users, probably they would not be close enough to the nitty gritty of files to bother with these files.

However, there may be a use scenario where such logs are explicitly not wanted. Whether for the minimalist movement, save environment with non-excessive use of non-necessary storage or perhaps for privacy and security reasons.

With this PR, users only need to put a file tagui_no_logging (can be empty or has contents) in the tagui/src folder. When this file exists, TagUI will delete the .js .raw .log files after executing the script. Thus when `tagui flow` is run there won't be flow.js flow.log flow.raw after execution.

This would be good to go with v5.0 release aisingapore#386
  • Loading branch information
kensoh committed Apr 8, 2019
1 parent 6c1d140 commit 0ec0a8f
Show file tree
Hide file tree
Showing 5 changed files with 937 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
# exclude audit report csv file
/src/tagui_report.csv

# exclude tagui_no_logging flag
/src/tagui_no_logging

# exclude translation temp build files
/src/languages/build.js
/src/languages/build.log
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ Package|[unzip and run](https://github.com/tebelorg/Tump/releases/download/v1.0.
- Filename can have no extension, .txt or .js or .tagui extension
- Type tagui without parameters to see its version and options

Log files (.log .raw .js) are created after running. To turn off, put an empty file tagui_no_logging in tagui/src folder.

> If your command prompt or terminal font size is too small, you can set it to much larger font sizes for easier reading.
> Below example will run a script to perform a search on Yahoo website and capture a screenshot of the results.
Expand Down Expand Up @@ -195,7 +197,7 @@ TagUI can also be run from desktop icons, scheduled tasks, or REST API calls.
Click to show info on automation logs, and how to run tagui from any directory
</summary>

After each automation run, a .log file will be created to store output of the execution, a .js file is the generated JavaScript file, a .raw is the expanded flow after reading in any module sub-scripts that are called in that flow. These files are for user reference purpose and can be helpful in debugging or troubleshooting the automation flow.
After each automation run, a .log file will be created to store output of the execution, a .js file is the generated JavaScript file, a .raw is the expanded flow after reading in any module sub-scripts that are called in that flow. These files are for user reference purpose and can be helpful in debugging or troubleshooting the automation flow. To turn off creation of these files, put an empty file tagui_no_logging in tagui/src folder.

**To run tagui from anywhere**
- For MacOS/Linux, use ln -sf /full_path/tagui/src/tagui /usr/local/bin/tagui to create symbolic link
Expand Down
Loading

0 comments on commit 0ec0a8f

Please sign in to comment.