codeforlife 2.6.1 → 2.6.2

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 (3) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +2 -57
  3. package/package.json +1 -40
package/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ ## [2.6.2](https://github.com/ocadotechnology/codeforlife-package-javascript/compare/v2.6.1...v2.6.2) (2024-12-18)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * remove peer dependencies ([#71](https://github.com/ocadotechnology/codeforlife-package-javascript/issues/71)) ([9c3bf54](https://github.com/ocadotechnology/codeforlife-package-javascript/commit/9c3bf544cc53e00b0bb6a50e1a925d9370cf649e))
7
+
1
8
  ## [2.6.1](https://github.com/ocadotechnology/codeforlife-package-javascript/compare/v2.6.0...v2.6.1) (2024-12-17)
2
9
 
3
10
 
package/README.md CHANGED
@@ -5,6 +5,7 @@ reusable frontend code, meant to be installed across CFL's various frontend
5
5
  services.
6
6
 
7
7
  ## LICENCE
8
+
8
9
  In accordance with the [Terms of Use](https://www.codeforlife.education/terms#terms)
9
10
  of the Code for Life website, all copyright, trademarks, and other
10
11
  intellectual property rights in and relating to Code for Life (including all
@@ -21,42 +22,7 @@ All other assets including images, logos, sounds etc., are not covered by
21
22
  this licence and no-one may copy, modify, distribute, show in public or
22
23
  create any derivative work from these assets.
23
24
 
24
- ## Installation
25
-
26
- To install this package, do one of the following options.
27
-
28
- *Remember to replace the version number ("0.0.0") with your
29
- [desired version](https://github.com/ocadotechnology/codeforlife-package-javascript/releases).*
30
-
31
- **Option 1:** Run `yarn install` command:
32
-
33
- ```bash
34
- yarn install git+https://github.com/ocadotechnology/codeforlife-package-javascript.git#v0.0.0
35
- ```
36
-
37
- **Option 2:** add the following to `package.json`:
38
-
39
- ```json
40
- {
41
- "dependencies": {
42
- "codeforlife": "github:ocadotechnology/codeforlife-package-javascript#v0.0.0"
43
- }
44
- }
45
- ```
46
-
47
- ## Making Changes
48
-
49
- To make changes, you must:
50
-
51
- 1. Branch off of main.
52
- 1. Push your changes on your branch.
53
- 1. Ensure the pipeline runs successfully on your branch.
54
- 1. Have your changes reviewed and approved by a peer.
55
- 1. Merge your branch into the `main` branch.
56
- 1. [Manually trigger](https://github.com/ocadotechnology/codeforlife-package-javascript/actions/workflows/main.yml)
57
- the `Main` pipeline for the `main` branch.
58
-
59
- ### Installing your branch
25
+ ## Installing your branch
60
26
 
61
27
  You may wish to install and integrate your changes into a CFL frontend before
62
28
  it's been peer-reviewed.
@@ -71,24 +37,3 @@ it's been peer-reviewed.
71
37
  }
72
38
  }
73
39
  ```
74
-
75
- ## Pipeline
76
-
77
- When pushing to any branch, the pipeline will:
78
-
79
- 1. Check the code for linting errors.
80
- 1. Run tests on the React components.
81
- 1. Build the package.
82
- 1. Save the build to the `lib` directory.
83
-
84
- When merging to the `main` branch, the pipeline will:
85
-
86
- 1. Update the package version in
87
- [package.json](https://github.com/ocadotechnology/codeforlife-package-javascript/blob/main/package.json).
88
- 1. Update
89
- [CHANGELOG.md](https://github.com/ocadotechnology/codeforlife-package-javascript/blob/main/CHANGELOG.md)
90
- with latest commit messages.
91
- 1. Determine the next version number from the commit messages using
92
- [semantic versioning](https://semver.org/).
93
- 1. Release a new version
94
- [on GitHub](https://github.com/ocadotechnology/codeforlife-package-javascript/releases).
package/package.json CHANGED
@@ -1,16 +1,8 @@
1
1
  {
2
- "//": [
3
- "Based off of:",
4
- "https://github.com/vitejs/vite/blob/main/packages/create-vite/template-react-ts/package.json",
5
- "Dependency rules:",
6
- "`peerDependencies` should contain everything required to build and test a",
7
- "service's front end.",
8
- "TODO: make devDependencies the same as peerDependencies"
9
- ],
10
2
  "name": "codeforlife",
11
3
  "description": "Common frontend code",
12
4
  "private": false,
13
- "version": "2.6.1",
5
+ "version": "2.6.2",
14
6
  "type": "module",
15
7
  "scripts": {
16
8
  "dev": "vite",
@@ -83,37 +75,6 @@
83
75
  "vite": "^5.0.11",
84
76
  "vitest": "^1.2.0"
85
77
  },
86
- "peerDependencies": {
87
- "@eslint/js": "^9.9.0",
88
- "@testing-library/dom": "^9.3.4",
89
- "@testing-library/jest-dom": "^6.2.0",
90
- "@testing-library/react": "^14.1.2",
91
- "@testing-library/user-event": "^14.5.2",
92
- "@types/express": "^5.0.0",
93
- "@types/jest": "^29.5.12",
94
- "@types/js-cookie": "^3.0.3",
95
- "@types/node": "^20.14.2",
96
- "@types/qs": "^6.9.7",
97
- "@types/react": "^18.2.47",
98
- "@types/react-dom": "^18.2.18",
99
- "@vitejs/plugin-react": "^4.2.1",
100
- "@vitest/coverage-istanbul": "^1.6.0",
101
- "@vitest/ui": "^1.6.0",
102
- "eslint": "^8.56.0",
103
- "eslint-config-prettier": "^9.1.0",
104
- "eslint-config-react-app": "^7.0.1",
105
- "eslint-plugin-prettier": "^5.1.3",
106
- "eslint-plugin-react": "^7.35.0",
107
- "eslint-plugin-react-hooks": "^4.6.2",
108
- "eslint-plugin-react-refresh": "^0.4.9",
109
- "globals": "^15.9.0",
110
- "jsdom": "^23.2.0",
111
- "prettier": "^3.2.1",
112
- "typescript": "^5.3.3",
113
- "typescript-eslint": "^8.1.0",
114
- "vite": "^5.0.11",
115
- "vitest": "^1.2.0"
116
- },
117
78
  "release": {
118
79
  "branches": [
119
80
  "main"