secrez 1.1.3 → 1.1.5

package/README.md

@@ -371,6 +371,15 @@ Secrez is not intended to compete with password managers, so do not expect it to
 
 ## History
 
+**1.1.5**
+
+- fix touch's help showing wrong, temporary options, changed during the development :-(
+
+**1.1.4**
+
+- add clear screen after 180 seconds to avoid that the user forgot its terminal open and accidentally shares it while sharing the screen during meetings — it happened to me :-(
+- add option `--timeout, -t` to customize the timeout when launching secrez
+
 **1.1.3**
 
 - add new option `--keystore, -k` to `export`. If a file contains a private key field (i.e., a field with a name containing `private_key`), it can be exported in the keystore format. The file will have the same name with the extension replaced with `.keystore.json`.
@@ -819,16 +828,16 @@ Thank you for any contributions! 😉
 ## Test coverage
 
 ```
-  166 passing (25s)
+  166 passing (24s)
   1 pending
 
 -----------------------|---------|----------|---------|---------|-----------------------------------
 File                   | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                 
 -----------------------|---------|----------|---------|---------|-----------------------------------
-All files              |   71.47 |    58.49 |   71.98 |   71.36 |                                   
+All files              |   71.22 |    58.41 |   71.25 |   71.11 |                                   
  src                   |   59.63 |    54.79 |      55 |   60.19 |                                   
   Command.js           |   79.66 |    78.72 |   76.92 |   81.03 | 32,55-62,73,80,119                
-  PreCommand.js        |   21.95 |    11.54 |   14.29 |   21.95 | 8-98,115                          
+  PreCommand.js        |   21.95 |    11.54 |   14.29 |   21.95 | 8-99,116                          
   cliConfig.js         |     100 |      100 |     100 |     100 |                                   
  src/commands          |   81.53 |       67 |   89.95 |    81.4 |                                   
   Alias.js             |   90.54 |    77.36 |     100 |   90.41 | 101,112,139,169,173,180,190       
@@ -876,10 +885,10 @@ All files              |   71.47 |    58.49 |   71.98 |   71.36 |
   Send.js              |   67.65 |    46.67 |     100 |   67.65 | 37,41,44,77,86-95                 
   Show.js              |   68.75 |    70.59 |     100 |   68.75 | 74-78,87,102-108                  
   Whoami.js            |   42.86 |        0 |      60 |   42.86 | 22,30-39                          
- src/prompts           |   15.14 |        0 |   14.29 |   15.27 |                                   
-  ChatPrompt.js        |    6.17 |        0 |       0 |    6.17 | 8-163                             
+ src/prompts           |   14.72 |        0 |   13.43 |   14.85 |                                   
+  ChatPrompt.js        |     6.1 |        0 |       0 |     6.1 | 8-164                             
   ChatPromptMock.js    |     100 |      100 |   66.67 |     100 |                                   
-  CommandPrompt.js     |   10.42 |        0 |       0 |   10.56 | 24-296                            
+  CommandPrompt.js     |     9.8 |        0 |       0 |    9.93 | 24-318                            
   Completion.js        |    4.41 |        0 |       0 |    4.48 | 6-103                             
   MainPromptMock.js    |     100 |      100 |   66.67 |     100 |                                   
   MultiEditorPrompt.js |      25 |        0 |       0 |      25 | 7-36                              

package/bin/secrez.js

@@ -31,6 +31,11 @@ const optionDefinitions = [
     alias: "s",
     type: Boolean,
   },
+  {
+    name: "timeout",
+    alias: "t",
+    type: Number,
+  },
   {
     name: "localDir",
     alias: "l",
@@ -100,12 +105,13 @@ Options:
   -s, --save-iterations   Saves the number of iterations in env.json (which 
                           is git-ignored). Do it only if you computer is very safe.               
   -l, --localDir          The local (out of the enctrypted fs) working dir. "~" by default.
-                      
+  -t, --timeout           The timeout in seconds before the screen is cleared. By default it is 180 seconds.
+                        
 Examples:
   $ secrez
   $ secrez -c /var/my-secrets -i 787099 -l ~/Desktop
   $ secrez -si 1213672
-  $ secrez -c ~/.secrez-archive
+  $ secrez -c ~/.secrez-archive -t 60
      
 `
   );

package/coverage.report

@@ -1,5 +1,5 @@
 
-> secrez@1.1.3 test /Users/francescosullo/Projects/Personal/secrez/packages/secrez
+> secrez@1.1.5 test /Users/francescosullo/Projects/Secrez/secrez/packages/secrez
 > cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text mocha test/*.test.js test/**/*.test.js test/**/**/*.js --exit
 
 
@@ -29,10 +29,10 @@
   #Cat
     ✓ should return the help
     ✓ should show the content of a file
-    ✓ should show either one or all the versions of a file (1022ms)
+    ✓ should show either one or all the versions of a file (1021ms)
     ✓ should throw if entry is not a file or file does not exist
     ✓ should throw if trying to cat a binary file
-    ✓ should show the content of a Yaml file (1031ms)
+    ✓ should show the content of a Yaml file (1033ms)
 
   #Cd
     ✓ should return the help
@@ -41,7 +41,7 @@
 
   #Chat
     ✓ should return the help
-    ✓ should run the chat if the courier is ready (247ms)
+    ✓ should run the chat if the courier is ready (168ms)
 
   #Contacts
     ✓ should return the help
@@ -55,9 +55,9 @@
 
   #Copy
     ✓ should return the help
-    ✓ should copy a file to the clipboard (409ms)
-    ✓ should copy a string to the clipboard (239ms)
-    ✓ should copy a card to the clipboard (937ms)
+    ✓ should copy a file to the clipboard (391ms)
+    ✓ should copy a string to the clipboard (246ms)
+    ✓ should copy a card to the clipboard (889ms)
     ✓ should return an error if the file does not exist or is a folder
     ✓ should throw if copying to clipboard a binary files
 
@@ -65,7 +65,7 @@
     ✓ should return the help
     ✓ should check if it is ready
     ✓ should set up the courier (143ms)
-    ✓ should set up the courier and get the default message when is already set up (143ms)
+    ✓ should set up the courier and get the default message when is already set up (145ms)
 
   #Ds
     ✓ should return the help
@@ -79,13 +79,13 @@
     ✓ should export a file to the current local folder
     ✓ should export a binary file to the current local folder
     ✓ should export an encrypted file to the current local folder
-    ✓ should export a file and delete it after 1 second (1204ms)
+    ✓ should export a file and delete it after 1 second (1206ms)
     ✓ should return an error if the file does not exist or is a folder
-    ✓ should export a keystore json file if a private_key exists in the entry (717ms)
+    ✓ should export a keystore json file if a private_key exists in the entry (716ms)
 
   #Find
     ✓ should return the help
-    ✓ should show find a string in the tree (1028ms)
+    ✓ should show find a string in the tree (1034ms)
     ✓ should find no result without parameters
     ✓ should skip binary files from search
 
@@ -150,7 +150,7 @@
 
   #Mv
     ✓ should return the help
-    ✓ should rename a file (1009ms)
+    ✓ should rename a file (1012ms)
     ✓ should move a file to another folder
     ✓ should move many files to another folder
     ✓ should move a file to another subfolder
@@ -159,14 +159,14 @@
     ✓ should move file to another dataset using wildcards
     ✓ should move file managing duplicates
     ✓ should throw if parameters are missed or wrong
-    ✓ should move files from and to other datasets (1031ms)
+    ✓ should move files from and to other datasets (1013ms)
     ✓ should move the results of a find
 
   #Paste
     ✓ should return the help
-    ✓ should paste the clipboard content to a new file (54ms)
-    ✓ should paste the clipboard content to an existent file (77ms)
-    ✓ should paste a single field to a yml card (41ms)
+    ✓ should paste the clipboard content to a new file (82ms)
+    ✓ should paste the clipboard content to an existent file (89ms)
+    ✓ should paste a single field to a yml card (57ms)
 
   #Pwd
     ✓ should return the help
@@ -180,7 +180,7 @@
     ✓ should delete a file with one version
     ✓ should delete many files usign wildcards
     ✓ should return errors if wrong parameters
-    ✓ should delete some versions of a file (1013ms)
+    ✓ should delete some versions of a file (1009ms)
 
   #Shell
     ✓ should return the help
@@ -196,13 +196,13 @@
 
   #Totp
     ✓ should return the help
-    ✓ should totp a file to the clipboard (357ms)
-    ✓ should read a totp secret from an image and add the totp field to the card (48ms)
+    ✓ should totp a file to the clipboard (359ms)
+    ✓ should read a totp secret from an image and add the totp field to the card (49ms)
     ✓ should read a totp secret from an image and return the secret
     ✓ should throw if bad image
     ✓ should throw if missing parameters
     ✓ should throw if the yaml is malformed
-    ✓ should read a totp secret from the clipboard (285ms)
+    ✓ should read a totp secret from the clipboard (110ms)
 
   #Touch
     ✓ should return the help
@@ -244,27 +244,27 @@ New file "/folder2/file1" created.
 
   #Quit
     ✓ should return the help
-    ✓ should quit the chat, even if inside a room (50ms)
+    ✓ should quit the chat, even if inside a room (49ms)
 
   #Send
     ✓ should return the help
-    ✓ should send a message to user0 (120ms)
+    ✓ should send a message to user0 (99ms)
 
   #Show
     ✓ should return the help
-    ✓ should show history messages (395ms)
+    ✓ should show history messages (367ms)
 
 
-  166 passing (25s)
+  166 passing (24s)
   1 pending
 
 -----------------------|---------|----------|---------|---------|-----------------------------------
 File                   | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                 
 -----------------------|---------|----------|---------|---------|-----------------------------------
-All files              |   71.47 |    58.49 |   71.98 |   71.36 |                                   
+All files              |   71.22 |    58.41 |   71.25 |   71.11 |                                   
  src                   |   59.63 |    54.79 |      55 |   60.19 |                                   
   Command.js           |   79.66 |    78.72 |   76.92 |   81.03 | 32,55-62,73,80,119                
-  PreCommand.js        |   21.95 |    11.54 |   14.29 |   21.95 | 8-98,115                          
+  PreCommand.js        |   21.95 |    11.54 |   14.29 |   21.95 | 8-99,116                          
   cliConfig.js         |     100 |      100 |     100 |     100 |                                   
  src/commands          |   81.53 |       67 |   89.95 |    81.4 |                                   
   Alias.js             |   90.54 |    77.36 |     100 |   90.41 | 101,112,139,169,173,180,190       
@@ -312,10 +312,10 @@ All files              |   71.47 |    58.49 |   71.98 |   71.36 |
   Send.js              |   67.65 |    46.67 |     100 |   67.65 | 37,41,44,77,86-95                 
   Show.js              |   68.75 |    70.59 |     100 |   68.75 | 74-78,87,102-108                  
   Whoami.js            |   42.86 |        0 |      60 |   42.86 | 22,30-39                          
- src/prompts           |   15.14 |        0 |   14.29 |   15.27 |                                   
-  ChatPrompt.js        |    6.17 |        0 |       0 |    6.17 | 8-163                             
+ src/prompts           |   14.72 |        0 |   13.43 |   14.85 |                                   
+  ChatPrompt.js        |     6.1 |        0 |       0 |     6.1 | 8-164                             
   ChatPromptMock.js    |     100 |      100 |   66.67 |     100 |                                   
-  CommandPrompt.js     |   10.42 |        0 |       0 |   10.56 | 24-296                            
+  CommandPrompt.js     |     9.8 |        0 |       0 |    9.93 | 24-318                            
   Completion.js        |    4.41 |        0 |       0 |    4.48 | 6-103                             
   MainPromptMock.js    |     100 |      100 |   66.67 |     100 |                                   
   MultiEditorPrompt.js |      25 |        0 |       0 |      25 | 7-36                              

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "secrez",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "license": "MIT",
   "nyc": {
     "include": "src",

package/src/commands/Touch.js

@@ -80,31 +80,31 @@ class Touch extends require("../Command") {
         'touch -p afile --content "Password: 1432874565"',
         'touch ether -c "Private Key: eweiu34y23h4y23ih4uy23hiu4y234i23y4iuh3"',
         [
-          "touch sample.txt -e",
-          "Prompt the user to type the content of the file. The text cannot contain newlines. It will cut at the first one, if so. If '-e' and '-c' are both present, '-c' will be ignored.",
+          "touch sample.txt -w",
+          "Prompt the user to type the content of the file. The text cannot contain newlines. It will cut at the first one, if so. If '-w' and '-c' are both present, '-c' will be ignored.",
         ],
         [
           "touch walletPassword -n",
-          "Prompt the user to type the password without showing it. Notice that '-n' has priority on '-e' and '-c'",
+          "Prompt the user to type the password without showing it. Notice that '-n' has priority on '-w' and '-c'",
         ],
         [
           "touch gilbert -f name -c 'Albert Goose'",
           "If the file does not exists, it creates 'gilbert.yaml' with the field 'name'. If a yaml file exists, it adds the field 'name' to it if the the field does not exist.",
         ],
         [
-          "touch new-wallet -w",
+          "touch new-wallet -g",
           "Creates a new wallet file containing 'private_key' and `address`. Wallet has priority on other creation options.",
         ],
         [
-          "touch new-wallets.yaml -w -n 3",
+          "touch new-wallets.yaml -g --amount 3",
           "Creates 'new-wallets.yaml', containing 3 wallet, calling them 'private_key', `private_key2` and `private_key3`, and relative addresses.",
         ],
         [
-          "touch new-wallet --wallet -x trust0",
+          "touch new-wallet --generate-wallet -x trust0",
           "In combination con '-x', it creates a new wallet file calling the fields 'trust0_private_key' and 'trust0_address'.",
         ],
         [
-          "touch new-wallets.yaml -wi",
+          "touch new-wallets.yaml -gi",
           "Includes the mnemonic. In this case, it will also add the fields 'mnemonic' (mnemonic phrase) and 'derived_path' (path used to generate the keys). ",
         ],
       ],

package/src/prompts/ChatPrompt.js

@@ -42,6 +42,7 @@ class ChatPrompt extends require("./CommandPrompt") {
   }
 
   prePromptMessage(options = {}) {
+    this.resetTimeout();
     if (this.environment.room) {
       let nicks = this.nicks(this.environment.room[0].contact);
       return [

package/src/prompts/CommandPrompt.js

@@ -20,6 +20,28 @@ const sigintManager = require("./SigintManager");
 let thiz;
 
 class CommandPrompt {
+  constructor() {
+    this.timeoutId = null;
+    this.clearScreenTimeout = 180;
+  }
+
+  clearScreen() {
+    process.stdout.write("\u001b[2J\u001b[0;0H");
+    process.stdout.write(
+      `Screen cleared. Press any key to reactivate the terminal`
+    );
+  }
+
+  resetTimeout() {
+    const s = 180000;
+    if (this.timeoutId) {
+      clearTimeout(this.timeoutId);
+    }
+    this.timeoutId = setTimeout(() => {
+      this.clearScreen();
+    }, this.clearScreenTimeout * 1000);
+  }
+
   async getReady(options) {
     thiz = this;
     this.inquirer = inquirer;

package/src/prompts/MainPrompt.js

@@ -27,6 +27,9 @@ class MainPrompt extends require("./CommandPrompt") {
       commands: new Commands(this, cliConfig).getCommands(),
     });
     this.cache = {};
+    if (options.timeout) {
+      this.clearScreenTimeout = options.timeout;
+    }
   }
 
   async preRun(options = {}) {
@@ -73,6 +76,7 @@ class MainPrompt extends require("./CommandPrompt") {
   }
 
   prePromptMessage(options = {}) {
+    this.resetTimeout();
     return chalk.reset(
       `Secrez ${
         this.internalFs.tree.name