Merge pull request #150 from readium/develop

NPM upgrade + Thorium ports

Author: JayPanoz

.github/workflows/node.js.yml

@@ -0,0 +1,33 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, and build the source code into dist stylesheets. If these are different from the existing ones, it will automatically commit them into the current branch on push and PR events.
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{ github.head_ref }}
+    - name: Use Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        file_pattern: "css/dist/**"
+        commit_message: Update dist

README.md

@@ -12,11 +12,8 @@ Readium CSS provides styles for reflowable text:
 - reading modes (day, night, and sepia);
 - themes;
 - user settings;
-- media overlays and user highlights;
 - a set of baselines and recommendations for accessibility, overrides, and internationalization.
 
-**Readium CSS is currently in alpha** (version `1.0.0-beta.1`).
-
 ## License
 
 BSD-3-Clause (http://opensource.org/licenses/BSD-3-Clause)
@@ -47,6 +44,46 @@ There is no external implementation of Readium CSS so far.
 
 Consequently, if you are encountering rendering issues with Readium (iOS apps, Android apps, or the Readium Chrome App), please report them on the [github section dedicated to the proper Readium project](https://github.com/readium) (readium-js, readium-shared-js, readium-sdk, etc.).
 
+## Development
+
+Active development is pulled in branch `develop` first, and then made available in the main branch when sufficiently tested and deemed stable.
+
+### Init
+
+Building and testing are relying on npm packages and scripts. To initialize your clone/fork, first install dev dependencies:
+
+```
+npm install
+```
+
+In case you’re encountering an error with Puppeteer, make sure you’re using at least Node v.20.11.1 – it might work with an earlier version but only the latest LTS as of March 21, 2024 has been tested.
+
+Then create reference bitmaps for visual regression testing:
+
+```
+npm run test:ref
+```
+
+### Build
+
+To transpile all stylesheets using PostCSS:
+
+```
+npm run build
+```
+
+To test the updated styles and catch visual regression bugs:
+
+```
+npm run test
+```
+
+To update reference bitmaps after a bugfix:
+
+```
+npm run test:approve
+```
+
 ## Docs
 
 Documentation [can be accessed in docs](docs).

backstop.json

@@ -160,6 +160,13 @@
       "selectors": ["document"],
       "misMatchThreshold" : 0.1
     },
+    {
+      "label": "Letterspacing CJK pref",
+      "url": "http://localhost:8000/tests/letter-spacing-cjk.html",
+      "delay": 0,
+      "selectors": ["document"],
+      "misMatchThreshold" : 0.1
+    },
     {
       "label": "Ligatures pref",
       "url": "http://localhost:8000/tests/arabic-ligatures.html",
@@ -170,7 +177,7 @@
     {
       "label": "Accessibility font pref",
       "url": "http://localhost:8000/tests/a11y-font.html",
-      "delay": 0,
+      "delay": 200,
       "selectors": ["document"],
       "misMatchThreshold" : 0.1
     },
@@ -184,6 +191,13 @@
     {
       "label": "Accessibility custom pref",
       "url": "http://localhost:8000/tests/a11y-custom.html",
+      "delay": 200,
+      "selectors": ["document"],
+      "misMatchThreshold" : 0.1
+    },
+    {
+      "label": "no Ruby pref",
+      "url": "http://localhost:8000/tests/no-ruby.html",
       "delay": 0,
       "selectors": ["document"],
       "misMatchThreshold" : 0.1

css/ReadMe.md

@@ -7,8 +7,7 @@ Readium CSS is a set of reference stylesheets for EPUB Reading Systems. It provi
 - default styles;
 - reading modes (night, sepia, etc.);
 - themes;
-- user settings;
-- media overlays and user highlights.
+- user settings.
 
 **Note:** Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc.
 

css/ReadiumCSS-config.css

@@ -44,6 +44,9 @@
 @custom-selector :--darken-filter [style*="readium-darken-on"];
 @custom-selector :--invert-filter [style*="readium-invert-on"];
 
+/* Hiding ruby */
+@custom-selector :--no-ruby [style*="readium-noRuby-on"];
+
 /* Accessibility normalization */
 @custom-selector :--a11y-normalize [style*="readium-a11y-on"];
 

css/dist/ReadMe.md

@@ -54,8 +54,11 @@ Disabled user settings:
 - `text-align`;
 - `hyphens`;
 - paragraphs’ indent;
-- `word-spacing`;
-- `letter-spacing`.
+- `word-spacing`.
+
+Added user settings:
+
+- hiding/disabling ruby (mapped to `--USER__noRuby: readium-noRuby-on` flag).
 
 ### Vertical
 
@@ -87,8 +90,11 @@ Disabled user settings:
 - `text-align`;
 - `hyphens`;
 - paragraphs’ indent;
-- `word-spacing`;
-- `letter-spacing`.
+- `word-spacing`.
+
+Added user settings:
+
+- hiding/disabling ruby (mapped to `--USER__noRuby: readium-noRuby-on` flag).
 
 ### EBPAJ Polyfill