Skip update when page not found (#364)

* New configuration option "skipUpdateWhenPageNotFound".

* Mentioning config variable "skipUpdateWhenPageNotFound" in README.

* README.md: fixed two JSON fragments.

* README: improved one sentence.

* Update README.md

Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>

* README.md: removed blank in front of ":" in JSON fragment.

* Removed log message "Skipping update of cache because option skipUpdateWhenPageNotFound is set".

* Update README.md: changes description for `skipUpdateWhenPageNotFound`

Co-authored-by: Matthew Peveler <matt.peveler@gmail.com>

* Update lib/tldr.js: extended comment

Co-authored-by: Matthew Peveler <matt.peveler@gmail.com>

* Update tldr.js

Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>
Co-authored-by: Matthew Peveler <matt.peveler@gmail.com>

Author: 3 people

README.md

@@ -98,7 +98,16 @@ As a contributor, you can also point to your own fork containing the `tldr.zip`
 
 ```js
 {
-  "repository" : "http://myrepo/assets/tldr.zip",
+  "repository": "http://myrepo/assets/tldr.zip"
+}
+```
+
+By default, a cache update is performed anytime a page is not found for a command. To prevent this behavior,
+you can set the configuration variable `skipUpdateWhenPageNotFound` to `true` (defaults to `false`):
+
+```js
+{
+  "skipUpdateWhenPageNotFound": true
 }
 ```
 

config.json

@@ -1,6 +1,7 @@
 {
   "pagesRepository": "https://github.com/tldr-pages/tldr",
   "repository": "https://tldr.sh/assets/tldr.zip",
+  "skipUpdateWhenPageNotFound": false,
   "themes": {
     "simple": {
       "commandName": "bold, underline",

lib/tldr.js

@@ -129,7 +129,10 @@ class Tldr {
       .then((content) => {
         // If found in first try, render it
         if (!content) {
-          // If not found, try to update
+          // If not found, try to update cache unless user explicitly wants to skip
+          if (this.config.skipUpdateWhenPageNotFound === true) {
+            return '';
+          }
           return spinningPromise('Page not found. Updating cache...', () => {
             return this.cache.update();
           })