@cas-smartdesign/messages-generator 1.6.1 → 1.6.3

package/dist/docs/doc.js

@@ -1,140 +1,33 @@
-var n=(r,o)=>()=>(o||r((o={exports:{}}).exports,o),o.exports);var e=n((m,t)=>{t.exports={}});var a=n((s,d)=>{d.exports={html:`<h1>SmartDesign - Elements</h1>
-<p>A shared library of Web Components used by both the SmartDesign Web Client and SmartDesign Integrated Web Applications.</p>
-<h1>Prerequisites</h1>
-<p>The project setup and build configuration requires the followings to be installed.</p>
+var n=(r,o)=>()=>(o||r((o={exports:{}}).exports,o),o.exports);var a=n((m,t)=>{t.exports={}});var d=n((b,e)=>{e.exports={html:`<h1>@cas-smartdesign/messages-generator</h1>
+<p>A CLI tool to convert usual SmartDesign translations into JSON based Messages.</p>
+<p>The expected naming of the input translation files is <code>[name]_[ISO 639-1].properties</code> (for example <i>translations_de.properties</i>).</p>
+<h2>The following files are generated:</h2>
 <ul>
-<li>node 16.x <a href="https://nodejs.org/en/download/">download</a></li>
-<li>pnpm 7.x <a href="https://pnpm.io/installation/">download</a></li>
-</ul>
-<h1>Install project dependencies</h1>
-<ul>
-<li>configure nexus credentials for nexus.cas.de</li>
-<li>step into project root</li>
-<li>execute pnpm <code>$&gt; pnpm i</code><ul>
-<li>this installs dependencies across the workspace</li>
-</ul>
-</li>
-</ul>
-<h1>Linters / formatters</h1>
-<p>The project has certain linting / formatting rules defined via stylelint and eslint and prettier.</p>
-<p>The linters can be executed via <code>pnpm lint:check</code>, the formatter can be executed via <code>pnpm format:check</code>.
-Both of these have a <code>fix</code> variant as well (<code>pnpm lint:fix</code> and <code>pnpm format:fix</code>), which also tries to automatically fix the linting/formatting errors.</p>
-<p>It is advised to configure the necessary extensions for the IDE for automatic linting and formatting.</p>
-<p>Note that the CI build is configured to fail if there are linting or formatting errors.</p>
-<p>For a faster feedback, the linting / formatting can be executed automatically in a pre-commit hook.
-This can be installed via <code>pnpm prepare-hooks</code>.</p>
-<h2>Building individual packages</h2>
-<p><strong>There is no project wide build configuration at the moment</strong></p>
-<ul>
-<li>open terminal in the desired package</li>
-<li>execute the build script via <code>$&gt; pnpm build</code></li>
-<li>during development time one can (and should) use <code>$&gt; pnpm dev</code> which starts a webpack-dev-server instance<ul>
-<li>the es5 can be set as a target environment with --env es5 like <code>$&gt; pnpm dev --env es5=true</code> which makes it possible to test the elements for example also in IE 11</li>
-</ul>
-</li>
-</ul>
-<h2>Cross project dependencies</h2>
-<ul>
-<li>one may configure a dependency from within the workspace without any additional configuration<ul>
-<li>e.g. sd-z-layout -&gt; sd-custom-element-loader</li>
+<li><code>messages.ts</code><ul>
+<li>Contains a util which if initialized with a language the corresponding texts are provided from the dictionary.</li>
 </ul>
 </li>
-</ul>
-<h2>Publishing</h2>
-<p><strong>Publishing is handled automatically by the build pipeline, do not manually publish unless absolutely necessary</strong></p>
-<p>The .npmrc contains an auth token for the @cas-smartdesign scope, thus <code>pnpm publish</code> works by default.</p>
-<p>Note that pnpm checks if the current branch is your publish branch (<code>main</code>), clean, and up-to-date.</p>
-<p>If you don&#39;t have the <code>main</code> branch tracked, do it via <code>$&gt; git checkout -t origin/main</code>, otherwise
-use <code>$&gt; git checkout main &amp;&amp; git pull</code> to check out and update your local branch.</p>
-<h2>Releasing versions</h2>
-<p>Release versions should be prepared using the <code>npm version major|minor|patch --no-git-tag-version</code> command.
-If a change affects all packages one might run <code>pnpm --recursive exec npm --no-git-tag-version version patch</code> to prepare a new version for all packages.</p>
-<p>Releases are done by CI when the build pipeline succeeds on the main branch for all packages in the monorepo.</p>
-<h2>Testing</h2>
-<ul>
-<li><p>Cypress</p>
-<ul>
-<li>For UI testing we recommend Cypress, for an example on how to setup for a package, see the radio-button package.</li>
-<li>Note that if you want to use TypeScript and add a custom command, currently you have to add your command into the global cypress config (located inside the cypress folder in the root directory) and type it manually in the types.ts file.</li>
-</ul>
-</li>
-<li><p>Jest</p>
-<ul>
-<li>For unit testing we recommend Jest, visit the web-api package to see an example how to use it.</li>
+<li><code>dictionary.ts</code><ul>
+<li>Contains the generated JSON object from all the translations and the types based on the found translation files.</li>
 </ul>
 </li>
 </ul>
-`,raw:`# SmartDesign - Elements\r
-\r
-A shared library of Web Components used by both the SmartDesign Web Client and SmartDesign Integrated Web Applications.\r
-\r
-# Prerequisites\r
-\r
-The project setup and build configuration requires the followings to be installed.\r
-\r
-- node 16.x [download](https://nodejs.org/en/download/)\r
-- pnpm 7.x [download](https://pnpm.io/installation/)\r
-\r
-# Install project dependencies\r
-\r
-- configure nexus credentials for nexus.cas.de\r
-- step into project root\r
-- execute pnpm \`$> pnpm i\`\r
-  - this installs dependencies across the workspace\r
-\r
-# Linters / formatters\r
-\r
-The project has certain linting / formatting rules defined via stylelint and eslint and prettier.\r
-\r
-The linters can be executed via \`pnpm lint:check\`, the formatter can be executed via \`pnpm format:check\`.\r
-Both of these have a \`fix\` variant as well (\`pnpm lint:fix\` and \`pnpm format:fix\`), which also tries to automatically fix the linting/formatting errors.\r
-\r
-It is advised to configure the necessary extensions for the IDE for automatic linting and formatting.\r
-\r
-Note that the CI build is configured to fail if there are linting or formatting errors.\r
-\r
-For a faster feedback, the linting / formatting can be executed automatically in a pre-commit hook.\r
-This can be installed via \`pnpm prepare-hooks\`.\r
-\r
-## Building individual packages\r
-\r
-**There is no project wide build configuration at the moment**\r
-\r
-- open terminal in the desired package\r
-- execute the build script via \`$> pnpm build\`\r
-- during development time one can (and should) use \`$> pnpm dev\` which starts a webpack-dev-server instance\r
-  - the es5 can be set as a target environment with --env es5 like \`$> pnpm dev --env es5=true\` which makes it possible to test the elements for example also in IE 11\r
-\r
-## Cross project dependencies\r
-\r
-- one may configure a dependency from within the workspace without any additional configuration\r
-  - e.g. sd-z-layout -> sd-custom-element-loader\r
-\r
-## Publishing\r
-\r
-**Publishing is handled automatically by the build pipeline, do not manually publish unless absolutely necessary**\r
-\r
-The .npmrc contains an auth token for the @cas-smartdesign scope, thus \`pnpm publish\` works by default.\r
-\r
-Note that pnpm checks if the current branch is your publish branch (\`main\`), clean, and up-to-date.\r
-\r
-If you don't have the \`main\` branch tracked, do it via \`$> git checkout -t origin/main\`, otherwise\r
-use \`$> git checkout main && git pull\` to check out and update your local branch.\r
-\r
-## Releasing versions\r
+<h2>Options:</h2>
+<p>Start with <code>-h</code> or <code>--help</code> to list the possible options.</p>
+`,raw:`# @cas-smartdesign/messages-generator\r
 \r
-Release versions should be prepared using the \`npm version major|minor|patch --no-git-tag-version\` command.\r
-If a change affects all packages one might run \`pnpm --recursive exec npm --no-git-tag-version version patch\` to prepare a new version for all packages.\r
+A CLI tool to convert usual SmartDesign translations into JSON based Messages.\r
 \r
-Releases are done by CI when the build pipeline succeeds on the main branch for all packages in the monorepo.\r
+The expected naming of the input translation files is \`[name]_[ISO 639-1].properties\` (for example <i>translations_de.properties</i>).\r
 \r
-## Testing\r
+## The following files are generated:\r
 \r
-- Cypress\r
+- \`messages.ts\`\r
+  - Contains a util which if initialized with a language the corresponding texts are provided from the dictionary.\r
+- \`dictionary.ts\`\r
+  - Contains the generated JSON object from all the translations and the types based on the found translation files.\r
 \r
-  - For UI testing we recommend Cypress, for an example on how to setup for a package, see the radio-button package.\r
-  - Note that if you want to use TypeScript and add a custom command, currently you have to add your command into the global cypress config (located inside the cypress folder in the root directory) and type it manually in the types.ts file.\r
+## Options:\r
 \r
-- Jest\r
-  - For unit testing we recommend Jest, visit the web-api package to see an example how to use it.\r
-`,filename:"readme.md"}});e();var i=a().html;document.querySelector("#markdown-container").innerHTML=i;
+Start with \`-h\` or \`--help\` to list the possible options.\r
+`,filename:"readme.md"}});a();var i=d().html;document.querySelector("#markdown-container").innerHTML=i;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cas-smartdesign/messages-generator",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "A CLI tool to convert usual SmartDesign translations into JSON based Messages",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {
@@ -23,7 +23,7 @@
   },
   "devDependencies": {
     "tsup": "^8.0.1",
-    "@cas-smartdesign/license-generator": "^1.6.1"
+    "@cas-smartdesign/license-generator": "^1.6.3"
   },
   "scripts": {
     "version": "pnpm version",