# @talend/scripts-cmf > @talend/react-cmf scripts to manage CMF settings Latest version **1.5.0** (published 2025-09-09) · 0 weekly downloads ## Install ```sh npm install @talend/scripts-cmf pnpm add @talend/scripts-cmf yarn add @talend/scripts-cmf bun add @talend/scripts-cmf ``` Provides the command `cmf-settings`. ## Health **Score 40/100 (D)** — status: stable. Positive: no vulnerabilities; high maintenance score. Warnings: low downloads; no types; no esm support. Negative: stale. ## Facts | | | |---|---| | Version | 1.5.0 | | Published | 2025-09-09 | | First published | 2022-06-10 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 32.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 159 | | Maintainers | talend-frontend | ## Links - npm: https://www.npmjs.com/package/@talend/scripts-cmf - Repository: https://github.com/Talend/ui - Homepage: https://github.com/Talend/ui#readme - Issues: https://github.com/Talend/ui/issues - npm.io page: https://npm.io/package/@talend/scripts-cmf ## Dependencies (6) - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4 - [i18next](https://npm.io/package/i18next.md) ^23.16.8 - [jsonpath](https://npm.io/package/jsonpath.md) ^1.1.1 - [commander](https://npm.io/package/commander.md) ^6.2.1 - [deepmerge](https://npm.io/package/deepmerge.md) ^1.5.2 ## Recent versions - 1.5.0 (latest) — 2025-09-09 - 1.4.0 — 2025-07-09 - 1.3.2 — 2025-06-27 - 1.3.1 — 2025-06-19 - 1.3.0 — 2024-06-13 - 1.2.4 — 2024-02-29 - 1.2.3 — 2023-12-04 - 1.2.2 — 2023-12-01 - 1.2.1 — 2023-11-23 - 1.2.0 — 2023-11-15 - 1.1.0 — 2023-01-20 - 1.0.2 — 2022-07-21 - 1.0.1 — 2022-06-22 - 1.0.0 — 2022-06-21 - 0.0.0 — 2022-06-10 ## README # CMF scripts ## Usage ``` npx @talend/scripts-cmf ``` You can also launch the command below to build your webapp. you can add it into `prepublish` npm script. ``` yarn cmf-settings ``` This script merge a set of settings `sources` into a `destination` file. Each sources is a path to eiter a folder or a file. The destination is minified. It require a `cmf.json` file with this format in your webapp's project root: After the install of `@talend/react-cmf`, the script `cmf-settings` is installed on your _node_modules/.bin_ folder. ### Options Options for this script: - -d to use sources-dev instead of sources - -q to run the script in quiet mode - -r to run the json search recursive ### Configuration in cmf.json file Create in your project folder a file `cmf.json` at the same level as the _package.json_. Here is an example of configuration ```json { "settings": { "sources": [ "src/settings", "node_modules/@talend/dataset/lib/settings", "node_modules/@talend/myOtherDep/lib/file.json" ], "sources-dev": [ "src/settings", "../../dataset/webapp/src/settings", "../../myOtherDep/lib/file.json" ], "destination": "src/assets/cmf-settings.json" } } ``` | property | description | type | | ----------- | ---------------------------------------- | ------ | | sources | defines all path to merge | array | | sources-dev | defines all path to merge with -d option | array | | destination | destination for the merged settings | string | ### i18next The configuration support translations using [i18next](https://www.i18next.com/). It will extract all object with a i18n attribute ```json { "settings": { //...usual + "i18n": { "languages": ["en", "fr", "ja"], "namespace-paths": [ { "name": "app-cmf", "path": "src/assets/locales/{{namespace}}/{{locale}}.json" }, { "name": "package1-cmf", "path": "node_modules/package1/locales/{{namespace}}/{{locale}}.json" }, { "name": "package2-cmf", "path": "node_modules/package2/locales/{{namespace}}/{{locale}}.json" } ], "extract-namespaces": ["app-cmf"], "extract-from": ["src/settings"], "extract-sort": true }, "destination": "src/assets/settings.json" } } ``` The i18n settings are merged to the destination property with the language. e.g. For the destination "src/assets/settings.json", each translated settings will be created like "src/assets/settings.{{language}}.json" | property | description | type | | ------------------ | --------------------------------------------------------- | ---------------- | | languages | languages handle by your application | array | | namespace-paths | path of the namespace used to build the i18next ressource | array | | extract-namespaces | set the namespace to extract the keys/values | array | | extract-from | indicate the folder to extract the keys/values | array | | extract-sort | indicate if the keys are sorted (default: true) | boolean | **Namespace definition** | property | description | type | | -------- | -------------------------- | ------ | | name | name of the namepace | name | | path | pattern to find the locale | string | ### Exemple of settings with translation ``` { label: { i18n: { key: 'myNamespace:KEY1', options: { defaultValue: 'foo', }, }, }, message: { i18n: { key: 'otherNamespace:KEY2', options: { defaultValue: 'bar', }, }, } } ``` Warning : if the namespace is not define in the settings files or if it is not define in the config file the key will not be extracted ### Multiple settings If you need to use multiple settings in one project you can do so with an environment variable `CMF_ENV`. `$ cross-env CMF_ENV=withoutMyOtherDep cmf-settings` ```jsonc { // will not be used "settings": { "sources": [ "src/settings", "node_modules/@talend/dataset/lib/settings", "node_modules/@talend/myOtherDep/lib/file.json" ], "sources-dev": [ "src/settings", "../../dataset/webapp/src/settings", "../../myOtherDep/lib/file.json" ], "destination": "src/assets/cmf-settings.json" }, "withoutMyOtherDep": { // will be used "settings": { "sources": ["src/settings", "node_modules/@talend/dataset/lib/settings"], "sources-dev": ["src/settings", "../../dataset/webapp/src/settings"], "destination": "src/assets/cmf-settings.json" } } } ``` --- _Source: https://npm.io/package/@talend/scripts-cmf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._