Fix formatting - prettier

benoit74 · benoit74 · commit 17c8ec8f7bdc · 2024-10-21T09:44:14.000Z
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-zimscraperlib
-=============
+# zimscraperlib
 
 [![Build Status](https://github.com/openzim/python-scraperlib/workflows/CI/badge.svg?query=branch%3Amain)](https://github.com/openzim/python-scraperlib/actions?query=branch%3Amain)
 [![CodeFactor](https://www.codefactor.io/repository/github/openzim/python-scraperlib/badge)](https://www.codefactor.io/repository/github/openzim/python-scraperlib)
@@ -12,26 +11,26 @@ Collection of python code to re-use across python-based scrapers
 
 # Usage
 
-* This library is meant to be installed via PyPI ([`zimscraperlib`](https://pypi.org/project/zimscraperlib/)).
-* Make sure to reference it using a version code as the API is subject to frequent changes.
-* API should remain the same only within the same *minor* version.
+- This library is meant to be installed via PyPI ([`zimscraperlib`](https://pypi.org/project/zimscraperlib/)).
+- Make sure to reference it using a version code as the API is subject to frequent changes.
+- API should remain the same only within the same _minor_ version.
 
 Example usage:
 
-``` pip
+```pip
 zimscraperlib>=1.1,<1.2
 ```
 
 See [functional architecture](docs/functional_architecture.md), [software architecture](docs/software_architecture.md) and [technical architecture](docs/technical_architecture.md) for more details on scraperlib (not all aspects are covered yet, this is a WIP).
 
 # Dependencies
 
-* libmagic
-* wget
-* libzim (auto-installed, not available on Windows)
-* Pillow
-* FFmpeg
-* gifsicle (>=1.92)
+- libmagic
+- wget
+- libzim (auto-installed, not available on Windows)
+- Pillow
+- FFmpeg
+- gifsicle (>=1.92)
 
 ## macOS
 
@@ -49,6 +48,7 @@ sudo apt install libmagic1 wget ffmpeg \
 ```
 
 ## Alpine
+
 ```
 apk add ffmpeg gifsicle libmagic wget libjpeg
 ```
@@ -71,15 +71,15 @@ invoke coverage
 
 Non-exhaustive list of scrapers using it (check status when updating API):
 
-* [openzim/freecodecamp](https://github.com/openzim/freecodecamp)
-* [openzim/gutenberg](https://github.com/openzim/gutenberg)
-* [openzim/ifixit](https://github.com/openzim/ifixit)
-* [openzim/kolibri](https://github.com/openzim/kolibri)
-* [openzim/nautilus](https://github.com/openzim/nautilus)
-* [openzim/nautilus](https://github.com/openzim/nautilus)
-* [openzim/openedx](https://github.com/openzim/openedx)
-* [openzim/sotoki](https://github.com/openzim/sotoki)
-* [openzim/ted](https://github.com/openzim/ted)
-* [openzim/warc2zim](https://github.com/openzim/warc2zim)
-* [openzim/wikihow](https://github.com/openzim/wikihow)
-* [openzim/youtube](https://github.com/openzim/youtube)
+- [openzim/freecodecamp](https://github.com/openzim/freecodecamp)
+- [openzim/gutenberg](https://github.com/openzim/gutenberg)
+- [openzim/ifixit](https://github.com/openzim/ifixit)
+- [openzim/kolibri](https://github.com/openzim/kolibri)
+- [openzim/nautilus](https://github.com/openzim/nautilus)
+- [openzim/nautilus](https://github.com/openzim/nautilus)
+- [openzim/openedx](https://github.com/openzim/openedx)
+- [openzim/sotoki](https://github.com/openzim/sotoki)
+- [openzim/ted](https://github.com/openzim/ted)
+- [openzim/warc2zim](https://github.com/openzim/warc2zim)
+- [openzim/wikihow](https://github.com/openzim/wikihow)
+- [openzim/youtube](https://github.com/openzim/youtube)
diff --git a/docs/functional_architecture.md b/docs/functional_architecture.md
@@ -54,11 +54,11 @@ For proper reader operation, openZIM prohibits using absolute URLs, so this has
 
 The table below gives some examples of what the rewritten URL is going to be, depending on the URL of the rewritten document.
 
-| HTML document URL | image URL rewritten for usage inside the ZIM |
-|--|--|
-| `https://en.wikipedia.org/wiki/Kiwix` | `./File:Kiwix_logo_v3.svg` |
-| `https://en.wikipedia.org/wiki` | `./wiki/File:Kiwix_logo_v3.svg` |
-| `https://en.wikipedia.org/waka/Kiwix` | `../wiki/File:Kiwix_logo_v3.svg` |
+| HTML document URL                     | image URL rewritten for usage inside the ZIM         |
+| ------------------------------------- | ---------------------------------------------------- |
+| `https://en.wikipedia.org/wiki/Kiwix` | `./File:Kiwix_logo_v3.svg`                           |
+| `https://en.wikipedia.org/wiki`       | `./wiki/File:Kiwix_logo_v3.svg`                      |
+| `https://en.wikipedia.org/waka/Kiwix` | `../wiki/File:Kiwix_logo_v3.svg`                     |
 | `https://fr.wikipedia.org/wiki/Kiwix` | `../../en.wikipedia.org/wiki/File:Kiwix_logo_v3.svg` |
 
 As can be seen on the last line (but this is true for all URLs), this rewriting has to take into account the convention saying at which ZIM path a given web resource will be stored.
diff --git a/docs/software_architecture.md b/docs/software_architecture.md
@@ -22,4 +22,4 @@ Static JS rewriting is simply a matter of pure textual manipulation with regular
 
 Dynamic JS rewriting is done with [wombat JS library](https://github.com/webrecorder/wombat). The same fuzzy rules that are used for static rewritting are injected into wombat configuration. Code to rewrite URLs is an adapted version of the code used to compute ZIM paths.
 
-For wombat setup, including the URL rewriting part, we need to pass wombat configuration info. This code is developed in the `javascript` folder. For URL parsing, it relies on the [uri-js library](https://www.npmjs.com/package/uri-js). This javascript code is bundled into a single `wombatSetup.js` file with [rollup bundler](https://rollupjs.org), the same bundler used by webrecorder team to bundle wombat.
+For wombat setup, including the URL rewriting part, we need to pass wombat configuration info. This code is developed in the `javascript` folder. For URL parsing, it relies on the [uri-js library](https://www.npmjs.com/package/uri-js). This javascript code is bundled into a single `wombatSetup.js` file with [rollup bundler](https://rollupjs.org), the same bundler used by webrecorder team to bundle wombat.
diff --git a/docs/technical_architecture.md b/docs/technical_architecture.md
@@ -5,6 +5,7 @@
 Fuzzy rules are stored in `rules/rules.yaml`. This configuration file is then used by `rules/generateRules.py` to generate Python and JS code.
 
 Should you update these fuzzy rules, you hence have to:
+
 - regenerate Python and JS files by running `python rules/generateRules.py`
 - bundle again Javascript `wombatSetup.js` (see below).
 
@@ -25,6 +26,7 @@ WARC record stores the items URL inside a header named "WARC-Target-URI". The va
 It has been decided (by convention) that we will drop the scheme, the port, the username and password from the URL. Headers are also not considered in this computation.
 
 Computation of the ZIM path is hence mostly straightforward:
+
 - decode the hostname which is puny-encoded
 - decode the path and query parameter which might be url-encoded
 
@@ -49,4 +51,4 @@ JS Rewriting is a bit special because rules to apply are different wether we are
 
 Detection of Javascript modules starts at the HTML level where we have a `<script type="module"  src="...">` tag. This tells us that file at src location is a Javascript module. From there we now that its subresources are also Javascript module.
 
-Currently this detection is done on-the-fly, based on the fact that WARC items are processed in the same order that they have been fetched by the browser, and we hence do not need a multi-pass approach. Meaning that HTML will be processed first, then parent JS, then its dependencies, ... **This is a strong assumption**.
+Currently this detection is done on-the-fly, based on the fact that WARC items are processed in the same order that they have been fetched by the browser, and we hence do not need a multi-pass approach. Meaning that HTML will be processed first, then parent JS, then its dependencies, ... **This is a strong assumption**.
diff --git a/src/zimscraperlib/rewriting/statics/README.md b/src/zimscraperlib/rewriting/statics/README.md
@@ -1,8 +1,9 @@
 This folder must contain two files which are not under Git version control:
+
 - wombat.js, a webrecorder software
 - wombatSetup.js, a custom configuration script for wombat.js, which is built in this
-project from files in the javascript folder
+  project from files in the javascript folder
 
-If you install zimscraperlib from sdist or wheel, we've pre-packaged these files for 
-convenience and also so that your version of wombatSetup.js ais "aligned" (i.e. if you 
-install zimscraperlib x.y.z, we are sure which version wombatSetup.js you have).
+If you install zimscraperlib from sdist or wheel, we've pre-packaged these files for
+convenience and also so that your version of wombatSetup.js ais "aligned" (i.e. if you
+install zimscraperlib x.y.z, we are sure which version wombatSetup.js you have).

Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,4 @@ Static JS rewriting is simply a matter of pure textual manipulation with regular`
`22`	`22`
`23`	`23`	`Dynamic JS rewriting is done with [wombat JS library](https://github.com/webrecorder/wombat). The same fuzzy rules that are used for static rewritting are injected into wombat configuration. Code to rewrite URLs is an adapted version of the code used to compute ZIM paths.`
`24`	`24`
`25`		-For wombat setup, including the URL rewriting part, we need to pass wombat configuration info. This code is developed in the `javascript` folder. For URL parsing, it relies on the [uri-js library](https://www.npmjs.com/package/uri-js). This javascript code is bundled into a single `wombatSetup.js` file with [rollup bundler](https://rollupjs.org), the same bundler used by webrecorder team to bundle wombat.
	`25`	+For wombat setup, including the URL rewriting part, we need to pass wombat configuration info. This code is developed in the `javascript` folder. For URL parsing, it relies on the [uri-js library](https://www.npmjs.com/package/uri-js). This javascript code is bundled into a single `wombatSetup.js` file with [rollup bundler](https://rollupjs.org), the same bundler used by webrecorder team to bundle wombat.