Skip to content

Commit a3f7ac0

Browse files
committed
Upgrade devDependencies
1 parent b1392b9 commit a3f7ac0

4 files changed

Lines changed: 3260 additions & 4066 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,46 @@ There is no external implementation of Readium CSS so far.
4646

4747
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.).
4848

49+
## Development
50+
51+
Active development is pulled in branch `develop` first, and then made available in the main branch when sufficiently tested and deemed stable.
52+
53+
### Init
54+
55+
Building and testing are relying on npm packages and scripts. To initialize your clone/fork, first install dev dependencies:
56+
57+
```
58+
npm install
59+
```
60+
61+
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.
62+
63+
Then create reference bitmaps for visual regression testing:
64+
65+
```
66+
npm run test:ref
67+
```
68+
69+
### Build
70+
71+
To transpile all stylesheets using PostCSS:
72+
73+
```
74+
npm run build
75+
```
76+
77+
To test the updated styles and catch visual regression bugs:
78+
79+
```
80+
npm run test
81+
```
82+
83+
To update reference bitmaps after a bugfix:
84+
85+
```
86+
npm run test:approve
87+
```
88+
4989
## Docs
5090

5191
Documentation [can be accessed in docs](docs).

css/postcss.config.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -234,10 +234,6 @@ module.exports = (ctx) => ({
234234
],
235235
"unspecified-properties-position": "bottomAlphabetical"
236236
}),
237-
require("postcss-clean")({
238-
advanced: false,
239-
roundingPrecision: 3
240-
}),
241237
require("postcss-header")({
242238
header: `/*\n * Readium CSS (v. ${version})\n * Developers: Jiminy Panoz \n * Copyright (c) 2017. Readium Foundation. All rights reserved.\n * Use of this source code is governed by a BSD-style license which is detailed in the\n * LICENSE file present in the project repository where this source code is maintained.\n*/`
243239
})

0 commit comments

Comments
 (0)