EchoCli

Cli for creating and building Echo Modules.

Echo module configuration

For information on how to configure your echo module, refer to this wiki.

echo-cli versions table

Each echo-cli release works properly together with given versions of the essential echo packages. These versions are relevant when you run your Echo Module as a standalone app, with the command npm start.

An application shell (echo-client) will be fired up, which will contain your Echo Module. This application shell will depend on the main echo packages described below.

Find which versions to use of the echo packages for the given echo-cli version.

In general it's safe to differ in an echo package patch version. For example if the table states that you should use an echo package version of 0.4.0, using 0.4.3 should be also fine. Unless it's tied to another Cli version.

(older versions can be found at the bottom of this page)

| Cli | Base | Core | Search | Framework | Components | EDS Core | EDS Icons | EDS Utils | Notes |--------|-------|-------|--------|-----------|--------|----------|---------|-----|------| | 0.13.14 | 0.7.0 | 0.9.8 | 0.15.4 | 0.18.11 | 0.11.6 | 0.34.0 | 0.19.0 | 0.8.3 | Fixed an issue where the echo-framework v0.18.10 crashed echo-cli / client | 0.13.13 | 0.7.0 | 0.9.8 | 0.15.4 | 0.18.10 | 0.11.6 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.12 | 0.7.0 | 0.9.8 | 0.15.4 | 0.18.9 | 0.11.5 | 0.34.0 | 0.19.0 | 0.8.3 | Fixed an issue where echo-cli removed echo manifest files when building echo apps | 0.13.11 | 0.7.0 | 0.9.8 | 0.15.4 | 0.18.9 | 0.11.5 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.10 | 0.7.0 | 0.9.8 | 0.15.4 | 0.18.8 | 0.11.5 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.8 | 0.7.0 | 0.9.8 | 0.15.4 | 0.18.7 | 0.11.1 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.6 | 0.7.0 | 0.9.8 | 0.15.4 | 0.18.4 | 0.11.1 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.5 | 0.7.0 | 0.9.7 | 0.15.4 | 0.18.2 | 0.11.1 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.4 | 0.7.0 | 0.9.5 | 0.15.4 | 0.18.1 | 0.11.1 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.3 | 0.7.0 | 0.9.5 | 0.15.2 | 0.18.1 | 0.11.1 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.2 | 0.7.0 | 0.9.5 | 0.15.1 | 0.18.1 | 0.11.1 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.13.0 | 0.7.0 | 0.9.4 | 0.15.0 | 0.18.0 | 0.11.0 | 0.34.0 | 0.19.0 | 0.8.3 | Now depends on echo-utils 0.4.0 | 0.12.2 | 0.7.0 | 0.9.4 | 0.15.0 | 0.17.3 | 0.10.2 | 0.34.0 | 0.19.0 | 0.8.3 | Fixed a bug where echo-maps failed to build / start | 0.12.1 | 0.7.0 | 0.9.4 | 0.15.0 | 0.17.3 | 0.10.2 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.12.0 | 0.7.0 | 0.9.4 | 0.15.0 | 0.17.2 | 0.10.1 | 0.34.0 | 0.19.0 | 0.8.3 | EchoCli is an ESM module now | 0.11.2 | 0.7.0 | 0.9.4 | 0.15.0 | 0.17.2 | 0.10.1 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.11.1 | 0.7.0 | 0.9.4 | 0.15.0 | 0.17.2 | 0.10.0 | 0.34.0 | 0.19.0 | 0.8.3 | | 0.11.0 | 0.7.0 | 0.9.4 | 0.15.0 | 0.17.0 | 0.10.0 | 0.34.0 | 0.19.0 | 0.8.3 |

Change log

For our change log, refer to this file

How to make a new release

To be able to publish any echo lib to npm, you need to be part of the Echo team on npmjs.com. Here's how to get access:

• create an npmjs account with 2 factor authentication
• add your full name to your profile
• ask Victor Nystad (@vnys on slack) to add you to the Echo team on npmjs.com

Steps for making echo-cli release:

• if needed, update the echo package versions in echo-client
  • for example: you would like to have latest echo-framework version in echo-cli, then you need to version bump that package in echo-client
• remember to update CHANGELOG.md with the latest updates
• run npm i --legacy-peer-deps in the root folder
• echo-client dependencies are partially linked to the main app, echopediaWeb, to make sure that echo-client uses the same dependencies
• version bump echo-cli to the next version
  • patch, or minor: depending on if the given release has a braking change or not. Major version not yet released!
• run npm install in the following folders
  • echo-client
  • echo-cli
• Consider beta release if the new echo-cli ships more complex solutions, consider to do a beta release before the final one
  • Change echo-cli version to a beta one
    • like: 0.14.5-beta-X (where X is a positive integer)
    • in the root folder of echo-cli
      • run npm build-cli - this will build and copy echo-client into echo-cli and also build echo-cli
      • run npm echo-publish-beta to publish with beta flag to npm
• Regular release execute npm run cli-publish in echo-cli, which will,
  1. build EchoClient
  2. build EchoCli, bundling the freshly built EchoClient into it
  3. publish EchoCli to npm

History

Originally this repo was not part of EchoFramework monorepo, and was moved from it's own repo on the 30th of September, 2021:

https://github.com/equinor/EchoCli

If you want to check for changes before the mentioned date, check the link above.

EchoCli legacy versions table

Older version of Echo Cli, keeping it for historical reasons and for reference.

Pre EDS v0.34.0

| Cli | Base | Core | Search | Framework | Components | EDS Core | EDS Icons |--------|-------|-------|--------|-----------|--------|----------|---------| | 0.10.10 | 0.7.0 | 0.9.4 | 0.15.0 | 0.16.7 | 0.9.9 | 0.25.0 | 0.17.0 | | 0.10.9 | 0.7.0 | 0.9.4 | 0.15.0 | 0.16.7 | 0.9.8 | 0.25.0 | 0.17.0 | | 0.10.8 | 0.7.0 | 0.9.4 | 0.15.0 | 0.16.7 | 0.9.6 | 0.25.0 | 0.17.0 | | 0.10.7 | 0.7.0 | 0.9.3 | 0.15.0 | 0.16.6 | 0.9.6 | 0.25.0 | 0.17.0 | | 0.10.6 | 0.7.0 | 0.9.3 | 0.15.0 | 0.16.5 | 0.9.5 | 0.25.0 | 0.17.0 | | 0.10.5 | 0.7.0 | 0.9.2 | 0.15.0 | 0.16.4 | 0.9.4 | 0.25.0 | 0.17.0 | | 0.10.3 | 0.7.0 | 0.9.2 | 0.15.0 | 0.16.3 | 0.9.3 | 0.25.0 | 0.17.0 | | 0.10.2 | 0.7.0 | 0.9.2 | 0.15.0 | 0.16.2 | 0.9.2 | 0.25.0 | 0.17.0 | | 0.10.1 | 0.7.0 | 0.9.1 | 0.15.0 | 0.16.2 | 0.9.2 | 0.25.0 | 0.17.0 | | 0.10.0 | 0.7.0 | 0.9.1 | 0.15.0 | 0.16.1 | 0.9.0 | 0.25.0 | 0.17.0 | | 0.9.5 | 0.7.0 | 0.9.0 | 0.15.0 | 0.15.4 | 0.8.6 | 0.25.0 | 0.17.0 | | 0.9.4 | 0.7.0 | 0.9.0 | 0.15.0 | 0.15.4 | 0.8.5 | 0.25.0 | 0.17.0 | | 0.9.3 | 0.6.22 | 0.8.3 | 0.14.0 | 0.15.3 | 0.8.3 | 0.25.0 | 0.17.0 | | 0.9.2 | 0.6.22 | 0.8.3 | 0.14.0 | 0.15.2 | 0.8.3 | 0.25.0 | 0.17.0 | | 0.9.1 | 0.6.22 | 0.8.3 | 0.14.0 | 0.15.1 | 0.8.3 | 0.25.0 | 0.17.0 | | 0.9.0 | 0.6.22 | 0.8.3 | 0.14.0 | 0.15.0 | 0.8.0 | 0.25.0 | 0.17.0 | | 0.8.5 | 0.6.22 | 0.8.3 | 0.14.0 | 0.14.3 | 0.7.21 | 0.25.0 | 0.17.0 | | 0.8.4 | 0.6.22 | 0.8.3 | 0.14.0 | 0.14.1 | 0.7.13 | 0.25.0 | 0.17.0 | | 0.8.3 | 0.6.22 | 0.8.3 | 0.14.0 | 0.14.1 | 0.7.13 | 0.25.0 | 0.17.0 | | 0.8.1 | 0.6.22 | 0.8.3 | 0.14.0 | 0.14.1 | 0.7.13 | 0.25.0 | 0.17.0 | | 0.7.14 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.10 | 0.7.11 | 0.25.0 | 0.17.0 | | 0.7.13 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.10 | 0.7.7 | 0.25.0 | 0.17.0 | | 0.7.10 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.5 | 0.7.2 | 0.25.0 | 0.17.0 | | 0.7.8 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.4 | 0.7.0 | 0.25.0 | 0.17.0 | | 0.7.6 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.3 | 0.6.4 | 0.25.0 | 0.17.0 | | 0.7.5 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.3 | 0.6.3 | 0.25.0 | 0.17.0 | | 0.7.4 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.3 | 0.6.2 | 0.25.0 | 0.17.0 | | 0.7.3 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.3 | 0.6.0 | 0.25.0 | 0.17.0 | | 0.7.2 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.2 | 0.6.0 | 0.25.0 | 0.17.0 | | 0.7.0, 0.7.1 | 0.6.22 | 0.8.0 | 0.14.0 | 0.12.0 | 0.6.0 | 0.25.0 | 0.17.0 |

React 17

These versions are using React 17.

| Cli | Base | Core | Search | Framework | Components | EDS Core | EDS Icons | |--------|-------|-------|--------|-----------|--------|----------|---------| | 0.6.7 | 0.6.22 | 0.7.5 | 0.13.13 | 0.11.8 | 0.5.31 | 0.25.0 | 0.17.0 | | 0.6.6 | 0.6.22 | 0.7.5 | 0.13.13 | 0.11.7 | 0.5.31 | 0.25.0 | 0.17.0 | | 0.6.5 | 0.6.22 | 0.7.5 | 0.13.13 | 0.11.6 | 0.5.31 | 0.25.0 | 0.17.0 | | 0.6.4 | 0.6.22 | 0.7.5 | 0.13.13 | 0.11.5 | 0.5.26 | 0.25.0 | 0.17.0 | | 0.6.3 | 0.6.22 | 0.7.5 | 0.13.13 | 0.11.3 | 0.5.26 | 0.25.0 | 0.17.0 | | 0.6.2 | 0.6.22 | 0.7.5 | 0.13.13 | 0.11.2 | 0.5.24 | 0.25.0 | 0.17.0 | | 0.6.1 | 0.6.22 | 0.7.5 | 0.13.13 | 0.11.1 | 0.5.24 | 0.25.0 | 0.17.0 | | 0.5.32 | 0.6.22 | 0.7.5 | 0.13.11 | 0.10.26 | 0.5.19 | 0.25.0 | 0.17.0 | | 0.5.31 | 0.6.22 | 0.7.3 | 0.13.11 | 0.10.25 | 0.5.19 | 0.25.0 | 0.17.0 | | 0.5.30 | 0.6.22 | 0.7.3 | 0.13.11 | 0.10.24 | 0.5.19 | 0.25.0 | 0.17.0 | | 0.5.29 | 0.6.22 | 0.7.3 | 0.13.11 | 0.10.23 | 0.5.19 | 0.25.0 | 0.17.0 | | 0.5.28 | 0.6.22 | 0.7.3 | 0.13.11 | 0.10.22 | 0.5.19 | 0.25.0 | 0.17.0 | | 0.5.27 | 0.6.22 | 0.7.3 | 0.13.11 | 0.10.20 | 0.5.17 | 0.25.0 | 0.17.0 | | 0.5.26 | 0.6.22 | 0.7.3 | 0.13.11 | 0.10.19 | 0.5.14 | 0.25.0 | 0.17.0 | | 0.5.25 | 0.6.21 | 0.7.2 | 0.13.11 | 0.10.18 | 0.5.14 | 0.25.0 | 0.17.0 | | 0.5.24 | 0.6.21 | 0.7.2 | 0.13.11 | 0.10.16 | 0.5.13 | 0.25.0 | 0.17.0 | | 0.5.23 | 0.6.21 | 0.7.0 | 0.13.11 | 0.10.14 | 0.5.12 | 0.25.0 | 0.17.0 | | 0.5.20 | 0.6.21 | 0.7.0 | 0.13.11 | 0.10.12 | 0.5.12 | 0.25.0 | 0.17.0 | | 0.5.15 | 0.6.12 | 0.7.0 | 0.13.11 | 0.10.12 | 0.5.5 | 0.25.0 | 0.15.0 | | 0.5.15 | 0.6.12 | 0.7.0 | 0.13.11 | 0.10.11 | 0.5.5 | 0.25.0 | 0.15.0 | | 0.5.15 | 0.6.12 | 0.7.0 | 0.13.11| 0.10.7 | 0.5.3 | 0.25.0 | 0.15.0 | | 0.5.14 | 0.6.12 | 0.6.20 | 0.13.3| 0.10.6 | 0.5.3 | 0.25.0 | 0.15.0 | | 0.5.13 | 0.6.12 | 0.6.20 | 0.13.3| 0.10.6 | 0.5.3 | 0.25.0 | 0.10.0 | | 0.5.12 | 0.6.12 | 0.6.20 | 0.13.3| 0.10.3 | 0.5.2 | 0.21.0 | 0.10.0 | | 0.5.11 | 0.6.12 | 0.6.20 | 0.13.3| 0.9.21 | 0.5.2 | 0.21.0 | 0.10.0 | | 0.5.10 | 0.6.12 | 0.6.20 | 0.13.3| 0.9.15 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.5.9 | 0.6.12 | 0.6.19 | 0.13.2| 0.9.12 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.5.8 | 0.6.12 | 0.6.19 | 0.13.1| 0.9.12 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.5.7 | 0.6.8 | 0.6.16 | 0.12.4| 0.9.6 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.5.3 | 0.6.8 | 0.6.11 | 0.12.4| 0.9.1 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.5.2 | 0.6.8 | 0.6.11 | 0.12.4| 0.9.0 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.5.1 | 0.6.8 | 0.6.11 | 0.12.1| 0.8.1 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.5.0 | 0.6.8 | 0.6.11 | 0.12.1| 0.8.0 | 0.4.0 | 0.19.0 | 0.10.0 | | 0.4.5 | 0.6.4 | 0.6.9 | 0.11.15| 0.7.9 | 0.3.2 | 0.17.0 | 0.10.0 | | 0.4.4 | 0.6.4 | 0.6.9 | 0.11.15| 0.7.8 | 0.3.2 | 0.17.0 | 0.10.0 | | 0.4.2 | 0.6.4 | 0.6.9 | 0.11.15| 0.7.6 | 0.3.0 | 0.17.0 | 0.10.0 | | 0.3.1 | 0.6.2 | 0.6.6 | 0.11.15| 0.7.4 | 0.3.0 | 0.17.0 | 0.10.0 | | 0.2.1 | 0.6.2 | 0.6.6 | 0.11.11| 0.7.2 | 0.3.0 | 0.17.0 | 0.10.0 | | 0.2.1 | 0.6.2 | 0.6.6 | 0.11.11| 0.7.1 | 0.3.0 | 0.17.0 | 0.10.0 | | 0.2.1 | 0.6.2 | 0.6.6 | 0.11.11| 0.7.0 | 0.3.0 | 0.17.0 | 0.10.0 | | 0.1.77 | 0.6.2 | 0.6.5 | 0.11.11| 0.6.3 | 0.2.5 | 0.14.3 | 0.8.0 | | 0.1.76 | 0.6.1 | 0.6.1 | 0.11.10| 0.6.0 | 0.2.3 | 0.14.3 | 0.8.0 | | 0.1.75 | 0.5.1 | 0.5.3 | 0.11.9 | 0.5.5 | 0.2.3 | 0.14.3 | 0.8.0 | | 0.1.71 | 0.4.0 | 0.4.0 | 0.11.6 | 0.5.1 | 0.2.3 | 0.14.3 | 0.8.0 |