From a008649ce1a1159dbb47e5e80dbceebb7e35fa1e Mon Sep 17 00:00:00 2001 From: planctus Date: Tue, 1 Oct 2024 16:05:05 +0300 Subject: [PATCH] feat(js): Adding version propery to the ECL object - FRONT-4638 (#3657) * feat(js): Adding version propery to the ECL object - FRONT-4638 * chore(js): Adding docs - FRONT-4638 --------- Co-authored-by: Romain Emery --- docs/javascript.md | 4 ++++ src/tools/builder/scripts/scripts.js | 3 +++ src/website/src/pages/ec/getting-started/index.mdx | 2 ++ 3 files changed, 9 insertions(+) diff --git a/docs/javascript.md b/docs/javascript.md index c3dd6c16d87..d32ac5f5627 100644 --- a/docs/javascript.md +++ b/docs/javascript.md @@ -12,6 +12,10 @@ This means that when you include the `ECL` library in your pages, you will have ![ECL library in your browser's console](./assets/ECLjs.png) +## Version in use + +You can get the ECL version you are using running `ECL.version` in the console of your devtools. + ## Instantiation Each component contains `.init()` and `.destroy()` methods. diff --git a/src/tools/builder/scripts/scripts.js b/src/tools/builder/scripts/scripts.js index 208df729695..1df1cde7bb3 100644 --- a/src/tools/builder/scripts/scripts.js +++ b/src/tools/builder/scripts/scripts.js @@ -7,6 +7,7 @@ const commonjs = require('rollup-plugin-commonjs'); const { uglify } = require('rollup-plugin-uglify'); const svg = require('rollup-plugin-svg'); const getSystem = require('../utils/getSystem'); +const pkg = require('../package.json'); module.exports = (input, dest, options) => { const uglifyCode = @@ -32,6 +33,7 @@ module.exports = (input, dest, options) => { 'getSystem()': JSON.stringify(getSystem()), delimiters: ['', ''], preventAssignment: true, + __VERSION__: JSON.stringify(pkg.version), }), resolve(), commonjs(), @@ -58,6 +60,7 @@ module.exports = (input, dest, options) => { sourcemap: options.sourcemap || options.sourceMap, exports: 'named', globals: options.globals || {}, + footer: `ECL.version = "${pkg.version}";`, }; rollup.rollup(inputOptions).then((bundle) => bundle.write(outputOptions)); diff --git a/src/website/src/pages/ec/getting-started/index.mdx b/src/website/src/pages/ec/getting-started/index.mdx index 9682b9673af..5f0aae94a06 100644 --- a/src/website/src/pages/ec/getting-started/index.mdx +++ b/src/website/src/pages/ec/getting-started/index.mdx @@ -159,6 +159,8 @@ Then, in the footer of the document (or whenever the document is ready), call `E ``` +You can get the ECL version you are using running `ECL.version` in the console of your devtools. + ### Datepicker ECL uses [Pikaday](https://github.com/Pikaday/Pikaday) and this library is not bundled by ECL.