Version 15.2.0 (#33)

Version 15.2.0.
See below the CHANGELOG.

Changed:
- Various little cleanings ([#28](#28))

Fixed:
- Some failings commands (parameter issues, failures in `sed`) ([#28](#28))

Removed:
- Useless CSV option ([#28](#28))

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>

CHANGELOG.md

@@ -1,9 +1,24 @@
 # Tips'n'tools library changelog
 
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/pylapp/Tips-tools/compare/15.1.1...dev)
+## [Unreleased](https://github.com/pylapp/Tips-tools/compare/15.2.0...dev)
+
+## [15.2.0](https://github.com/pylapp/Tips-tools/compare/15.1.1...15.2.0) - 2024-11-22
+
+### Changed
+
+- Various little cleanings ([#28](https://github.com/pylapp/Tips-tools/issues/28))
+
+### Fixed
+
+- Some failings commands (parameter issues, failures in `sed`) ([#28](https://github.com/pylapp/Tips-tools/issues/28))
+
+### Removed
+
+- Useless CSV option ([#28](https://github.com/pylapp/Tips-tools/issues/28))
 
 ## [15.1.1](https://github.com/pylapp/Tips-tools/compare/15.1.0...15.1.1) - 2024-08-10
 
@@ -30,13 +45,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- [#7](https://github.com/pylapp/Tips-tools/issues/7) Pick hard-coded fixes and improve versions
+- Pick hard-coded fixes and improve versions ([#7](https://github.com/pylapp/Tips-tools/issues/7))
 
 ### Changed
 
-- [#15](https://github.com/pylapp/Tips-tools/issues/15) Add dry-run script 
-- [#10](https://github.com/pylapp/Tips-tools/issues/10) Deal with GNU/Linux and macOS primitives
-- [#14](https://github.com/pylapp/Tips-tools/issues/14) Add CC-BY license for generated and ODS file
+- Add dry-run script ([#15](https://github.com/pylapp/Tips-tools/issues/15))
+- Deal with GNU/Linux and macOS primitives ([#10](https://github.com/pylapp/Tips-tools/issues/10))
+- Add CC-BY license for generated and ODS file ([#14](https://github.com/pylapp/Tips-tools/issues/14))
 - Improve check of URL in CSV files
 - Update sources headers
 - Refactor file tree
@@ -76,7 +91,7 @@ _This version is dedicated to macOS users, and is based on v14.3.0_
 
 ## [14.3.0] - 2023-08-28
 
-_This version id dedicated to GNU/Linux users_
+_This version is dedicated to GNU/Linux users_
 
 ### Changed
 

CITATION.cff

@@ -14,7 +14,7 @@ repository-code: 'https://github.com/pylapp/Tips-tools'
 url: 'https://github.com/pylapp/Tips-tools'
 abstract: >-
   Tips'n'tools is a project which has the aim of making searches faster and improving technical watch.
-  Indeed, sometimes you need to share usefull web links and cool libraries to your colleagues, 
+  Indeed, sometimes you need to share useful web links and cool libraries to your colleagues, 
   but which platform to use?
 
   Your company's inner social network? Lost time if you move from your job. 
@@ -40,5 +40,5 @@ keywords:
   - Ruby
   - PWA
 license: MIT
-version: 15.0.0
-date-released: '2023-09-25'
+version: 15.2.0
+date-released: '2024-11-22'

README.md

@@ -1,7 +1,7 @@
 [![Opened issues](https://img.shields.io/github/issues-raw/pylapp/Tips-tools?style=for-the-badge)](https://github.com/pylapp/Tips-tools/issues)
 [![MIT license](https://img.shields.io/github/license/pylapp/Tips-tools?style=for-the-badge)](https://github.com/pylapp/Tips-tools/blob/master/LICENSE.txt)
 [![Versions](https://img.shields.io/github/v/release/pylapp/Tips-tools?label=Last%20version&style=for-the-badge)](https://github.com/pylapp/Tips-tools/releases)
-[![Still maintained](https://img.shields.io/maintenance/yes/2023?style=for-the-badge)](https://github.com/pylapp/Tips-tools/issues?q=is%3Aissue+is%3Aclosed)
+[![Still maintained](https://img.shields.io/maintenance/yes/2024?style=for-the-badge)](https://github.com/pylapp/Tips-tools/issues?q=is%3Aissue+is%3Aclosed)
 
 [![Code size](https://img.shields.io/github/languages/code-size/pylapp/Tips-Tools?style=for-the-badge)](https://github.com/pylapp/Tips-tools/tree/content)
 
@@ -32,8 +32,8 @@ width="500"/>
 
 <em>Keep time and be faster with your own cache of references, tools and specifications useful for developers!</em>
 
-_Tips'n'tools_ is a project which has the aim of making searches a bit more fast and improving technical watch.  
-Indeed sometimes you need to share usefull web links and cool libraries to your colleagues, but which platform to use?
+_Tips'n'tools_ is a project which has the aim of making searches a bit faster and improving technical watch.  
+Indeed sometimes you need to share useful web links and cool libraries to your colleagues, but which platform to use?
 Your company's inner social network? Lost time if you move from your job.
 A public social media? Lost time if this medium is closed.
 Fill your web browser's bookmarks? Yeah, got stolen or reinitialized your computer and you are done.  
@@ -49,7 +49,7 @@ Then you can:
 **_Tips'n'tools_ may be useful if you want to compile, in one place, plenty of references and data interesting for your projects.
 Never rely on social networks or corporate heavy tools, make your own cache and bring it everywhere!**
 
-You can get more detials [in the wiki](https://github.com/pylapp/Tips-tools/wiki).
+You can get more details [in the wiki](https://github.com/pylapp/Tips-tools/wiki).
 
 ## The doctor
 
@@ -61,33 +61,37 @@ bash doctor.sh
 
 ## The main script
 
- Run
+### Get help about commands
+
 ```shell
 bash tipsntools.sh --help
 ```
- to get some help about the commands ;-)
 
- Run
+### Make queries using regexp
+
 ```shell
-bash tipsntools.sh {--findAll | --findWeb | --findDevices | --findTools | --findSocs} yourRegex {--json | --csv}
+bash tipsntools.sh {--findAll | --findWeb | --findDevices | --findTools | --findSocs} yourRegex {--json}
 ```
- to make some searches in files with a regular expression as a filter. The _--json_ flag after the regex makes the script produce JSON-based data.
 
- Run
+It makes some searches in files with a regular expression as a filter. The _--json_ flag after the regex makes the script produce JSON-based data.
+
+### Update corpora
+
 ```shell
 bash tipsntools.sh --update
 ```
- to build HTML and JSON files from your CSV files, and build a global web page and the little web app (to see as a Progressive Web App or Single Page Application if you like buzzwords)
+It builds HTML and JSON files from your CSV files, and build a global web page and the little web app (to see as a Progressive Web App or Single Page Application if you like buzzwords).
 
 ## Add new elements in spreadsheets and other files
 
 You can fill the _.ods_ spreadsheet file with new data you want to save.
 You should keep the columns order.
-Then run
+Then export the spreadsheet tabs in CSV format (UTF8 encoded) in the suitable folders.
+And run the command bellow to update the _.html_ and _.json_ files.
+
 ```shell
 bash tipsntools.sh --update
 ```
-to update the _.html_ and _.json_ files.
 
 ## Who's who
 
@@ -99,14 +103,14 @@ Finally, the CSV files you should export from ODS (preserving UTF8), and the gen
 
 ## Customize the project
 
-In most of case nothing is hard-coded. Feel free to customize the Shell scripts, the HTML assets, etc.
+In most of case nothing is hard-coded, I hope. Feel free to customize the Shell scripts, the HTML assets, etc.
 The thing is, if you want to add a column in one of the spreadsheet's sheets, do not forget to update the dedicated Shell scripts and the HTML elements (CSS style sheets, HTML tables, etc.).
 
 ## Run the web app
 
 The web app here is a kind of "Progressive Web App" as a "Single App Application" (one page, offline, installable, with a cache, responsive, etc), BUT it remains web before all and it's a bit crapy.
-So because web browsers world is fu****g missy (and also coz' I enjoy native apps <3), it remains web browsers which do not support Service Workers, Web Workers, IndexedDB, Promises, ES6 or common and nowadays tools blablabla. 
-Thus you should use an up-to-date web browser. And sometimes it still won't work. "Web is universal and cool" they said (U_U))
+So because web browsers world is fu****g missy (and also coz' I enjoy native apps), it remains web browsers which do not support Service Workers, Web Workers, IndexedDB, Promises, ES6 or common and nowadays tools blablabla. 
+Thus you should use an up-to-date web browser. And sometimes it still won't work. "Web is universal and cool" they said (U_U)
 Because Service Workers are used, you should reach the web app through HTTPS or a local web server (_localhost_).
 
 _If you saw newbie things I did, feel free to submit a pull request!_
@@ -144,7 +148,8 @@ Here is the file tree for this version:
 ## Note
 
 It seems some web browsers (Firefox 58 for Android and Ubuntu) have bugs with IndexedDB. So you won't use the web app with them.  
-You ask why Shell and Ruby are used instead of full cross-platforms languages? Power, effectiveness, and free and open-source OS ;-)  
+You ask why Shell and Ruby are used instead of full cross-platforms languages? Power, effectiveness, and free and open-source OS.
+This project was, and in fact still is, a side project without too much ambitions with naive implementations. Feel free to subit pull requests to improve it.
 
 ## Must-read note
 
@@ -156,7 +161,7 @@ If you get errors like _sed: RE error: illegal byte sequence_, please refer to t
 It seems some files (like CSV files) you produce contain special characters '�' making `sed` fail.
 https://stackoverflow.com/questions/19242275/re-error-illegal-byte-sequence-on-mac-os-x
 
-You may also have in the wepp app error like _"An error occured with the JSON data gotten from the feed Web API. The degraded mode is still available"_. By looking in the developer console, you may find there is unexpected error in the JSON data returned by the script.
+You may also have in the web app error like _"An error occured with the JSON data gotten from the feed Web API. The degraded mode is still available"_. By looking in the developer console, you may find there is unexpected error in the JSON data returned by the script.
 In this case you should have a look on the CSV files you exported ; maybe there are not well formatted and make the produced JSON bad.
 
 In addition, if you install the web app on your computer, you may have different behaviors if you choose Brave, Chrome or Firefox :-/

project/build/manifest.json

@@ -0,0 +1,32 @@
+{
+  "short_name": "Tips'n'tools",
+  "name": "Tips'n'tools (v15.2.0)",
+  "description": "Your own cache of references and tools",
+  "icons": [
+    {
+      "src": "webapp/pictures/logo-96.png",
+      "sizes": "96x96",
+      "type": "image/png"
+    },
+    {
+      "src": "webapp/pictures/logo-144.png",
+      "sizes": "144x144",
+      "type": "image/png"
+    },
+    {
+      "src": "webapp/pictures/logo-192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    }
+  ],
+  "serviceworker": {
+    "src": "./serviceworker.js",
+    "scope": "/",
+    "update_via_cache": "none"
+  },
+  "start_url": "./webapp.html",
+  "display": "standalone",
+  "orientation": "portrait",
+  "dir": "auto",
+  "lang": "en"
+}

project/doctor.sh

@@ -132,7 +132,7 @@ if [ -d "/proc" ]; then
         warningPointsCount=$(($warningPointsCount + 1))
     fi
 else # Maybe on macOS
-    echo "Supposing you are in macOS operating system (don(t say you are on Windows)"
+    echo "Supposing you are in macOS operating system (don't say you are on Window$)"
     if ! grep -q "bash" "$SHELL" ; then
         echo "This script should be run with bash shell (zsh is fine too)"
     	warningPointsCount=$(($warningPointsCount + 1))