@equinor/echo-framework 0.15.0-beta-2 → 0.15.0-rc-1
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.
- package/README.md +6 -60
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,73 +6,19 @@ Framework provides all the necessary components to put the echo web client toget
|
|
|
6
6
|
|
|
7
7
|
Check the [docs for details](doc/echo-framework.md).
|
|
8
8
|
|
|
9
|
-
## How to develop EchoFramework
|
|
9
|
+
## How to develop and release EchoFramework
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
- Use the dev branch as base branch for your features
|
|
14
|
-
- Development work can be done now together with echopediaWeb, since they're in the same repo!
|
|
15
|
-
- Open PR, ask for review as before
|
|
16
|
-
- Merge feature branch into dev once PR is approved
|
|
17
|
-
- Do not run npm install in `libs/echo-framework`
|
|
18
|
-
- Do that in the root folder: NX uses every dependency from the root for all libraries
|
|
19
|
-
- All dependencies used during development will be taken from the root folder, based on the `package.json` found there
|
|
20
|
-
|
|
21
|
-
### Adding new dependency to EchoFramework
|
|
22
|
-
|
|
23
|
-
Steps
|
|
24
|
-
|
|
25
|
-
1. Setup
|
|
26
|
-
- Install the new dependency on the root folder package.json
|
|
27
|
-
- Copy and paste the same dependency to the `package.json` found in `libs/echo-framework` - do not run npm install there!
|
|
28
|
-
2. Coding - Use it in echo-framework code as normal
|
|
29
|
-
3. Adjusting NX rollup build - In `libs/echo-framework` add the new package as `external` into the `project.json`
|
|
30
|
-
4. Updating EchoClient - in `non-monorepo-libs/echo-client` install the same package. As EchoClient is the dev tool for other teams (they're not developing in echopediaWeb context), it needs to provide the peerDependencies for echoFramework to work.
|
|
31
|
-
|
|
32
|
-
### Maintaining dependencies in EchoFramework
|
|
33
|
-
|
|
34
|
-
As mentioned above:
|
|
35
|
-
|
|
36
|
-
- All dependencies used during development will be taken from the root folder, based on the `package.json` found there
|
|
37
|
-
- But in the same time the package.json in `libs/echo-framework` needs to contain the dependencies actually used in `echo-framework` and their version number needs to match the root's
|
|
38
|
-
- for example: let's say `echo-framework` uses `lodash` v8.8.0
|
|
39
|
-
- then both `package.json` and `libs/echo-framework/package.json` needs to contain this dependency
|
|
40
|
-
- might be hard to maintain, but luckly NX provides a tool for this: simply run `npx nx run echo-framework:lint` to check for matching dependencies and version numbers
|
|
41
|
-
|
|
42
|
-
Example on an error message from lint, when the dependencies does not match:
|
|
43
|
-
|
|
44
|
-
```ps
|
|
45
|
-
15:9 error The version specifier does not contain the installed version of "classnames" package: 2.3.2
|
|
46
|
-
@nx/dependency-checks
|
|
47
|
-
20:9 error The version specifier does not contain the installed version of "zustand" package: 4.4.1
|
|
48
|
-
@nx/dependency-checks
|
|
49
|
-
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
## How to make new release of echoFramework?
|
|
53
|
-
|
|
54
|
-
- Bump version in the package.json for `echoFramework` in libs/echo-framework in your PR
|
|
55
|
-
- Draft new release via the gitHub UI
|
|
56
|
-
- Use the label `echo-framework@X.Y.Z` (where X, Y, Z stands for the latest version number) for the release, so the dedicated github action can publish it for you
|
|
57
|
-
- Once the release is published, a github action will pick it up and publish `echoFramework` for you to npm
|
|
58
|
-
- It knows what to publish based on the release's `echo-framework` label
|
|
11
|
+
Check the [readme](/libs/README.md) in the NX libraries folder.
|
|
59
12
|
|
|
60
13
|
## EchoFramework UI components and tools
|
|
61
14
|
|
|
62
15
|
Framework houses multiple tools for UI bars, panels and menu functionality that can be used in Web and modules. See more in the [related docs](./doc/echo-framework-ui.md).
|
|
63
16
|
|
|
64
|
-
##
|
|
65
|
-
|
|
66
|
-
Run `nx test echo-framework` to execute the unit tests via [Jest](https://jestjs.io).
|
|
67
|
-
|
|
68
|
-
## Create build
|
|
69
|
-
|
|
70
|
-
Run `npx nx run echo-framework:build` to create a build
|
|
71
|
-
|
|
72
|
-
## Monorepo maintenance info
|
|
17
|
+
## Awailable NPM scripts
|
|
73
18
|
|
|
74
|
-
|
|
75
|
-
|
|
19
|
+
- `lint-framework`
|
|
20
|
+
- `build-framework`
|
|
21
|
+
- `test-framework`
|
|
76
22
|
|
|
77
23
|
## Old repository of echoFramework
|
|
78
24
|
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@equinor/echo-framework",
|
|
3
|
-
"version": "0.15.0-
|
|
3
|
+
"version": "0.15.0-rc-1",
|
|
4
4
|
"peerDependencies": {
|
|
5
5
|
"@equinor/echo-base": ">= 0.6.12 < 0.7.0",
|
|
6
|
-
"@equinor/echo-components": "0.8.0-
|
|
6
|
+
"@equinor/echo-components": "0.8.0-rc-0",
|
|
7
7
|
"@equinor/echo-core": ">= 0.8.0 < 0.9.0",
|
|
8
8
|
"@equinor/echo-search": ">= 0.14.0 < 0.15.0",
|
|
9
9
|
"@equinor/echo-utils": ">= 0.3.0 < 0.4.0",
|