codeforlife 2.10.6 → 2.10.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +10 -6
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -22,18 +22,22 @@ All other assets including images, logos, sounds etc., are not covered by
22
22
  this licence and no-one may copy, modify, distribute, show in public or
23
23
  create any derivative work from these assets.
24
24
 
25
- ## Installing your branch
25
+ ## Installing as a symlink
26
26
 
27
- You may wish to install and integrate your changes into a CFL frontend before
28
- it's been peer-reviewed.
27
+ To install this package into a CFL frontend before it's been peer-reviewed and
28
+ not have to reinstall it every time you make a change, you can install this
29
+ package as a [symlink](https://classic.yarnpkg.com/lang/en/docs/cli/link/) by
30
+ amending the `dependencies` in the `package.json` of a CFL frontend.
29
31
 
30
- *Remember to replace the branch name ("my-branch") with your
31
- [branch](https://github.com/ocadotechnology/codeforlife-package-javascript/branches)*.
32
+ *Remember that the [exports in package.json](package.json#exports) do NOT point
33
+ to the source ([src](src/index.ts)) files but rather the distribution
34
+ ([dist](dist/index.es.js)) files. Therefore, you'll need to rebuild the
35
+ distribution files every time you make a change by running `yarn vite build`.*
32
36
 
33
37
  ```json
34
38
  {
35
39
  "dependencies": {
36
- "codeforlife": "github:ocadotechnology/codeforlife-package-javascript#my-branch"
40
+ "codeforlife": "link:../package"
37
41
  }
38
42
  }
39
43
  ```
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "codeforlife",
3
3
  "description": "Common frontend code",
4
4
  "private": false,
5
- "version": "2.10.6",
5
+ "version": "2.10.7",
6
6
  "type": "module",
7
7
  "types": "dist/index.d.ts",
8
8
  "module": "dist/index.es.js",
@@ -170,7 +170,7 @@
170
170
  "@mui/material": "7.3.2",
171
171
  "@mui/x-date-pickers": "8.11.3",
172
172
  "@reduxjs/toolkit": "2.9.0",
173
- "compression": "^1.7.5",
173
+ "compression": "1.8.1",
174
174
  "dayjs": "^1.11.11",
175
175
  "express": "^4.21.2",
176
176
  "formik": "^2.2.9",