@jsverse/transloco-optimize 7.0.0

package/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+# [7.0.0](https://github.com/jsverse/transloco/compare/transloco-optimize-6.0.0...transloco-optimize-7.0.0) (2024-03-23)
+
+
+### chore
+
+* **optimize:** 🤖 update package scope ([65645ee](https://github.com/jsverse/transloco/commit/65645ee0a79413c74be64ede5bf33174f06465f7))
+
+
+### BREAKING CHANGES
+
+* **optimize:** 🧨 The package is now published under the jsverse scope
+
+
+
+# [6.0.0](https://github.com/jsverse/transloco/compare/transloco-optimize-5.0.3...transloco-optimize-6.0.0) (2024-03-23)
+
+
+
+## [5.0.3](https://github.com/jsverse/transloco/compare/transloco-optimize-5.0.2...transloco-optimize-5.0.3) (2023-08-13)
+
+### Bug Fixes
+
+- **optimize:** 🐛 fixed file resolution on windows ([#687](https://github.com/jsverse/transloco/issues/687)) ([5260127](https://github.com/jsverse/transloco/commit/52601277edfe5ef3502a822fc6129e28723bc16c))
+
+## [5.0.2](https://github.com/jsverse/transloco/compare/transloco-optimize-5.0.1...transloco-optimize-5.0.2) (2023-08-04)
+
+## [5.0.1](https://github.com/jsverse/transloco/compare/transloco-optimize-5.0.0...transloco-optimize-5.0.1) (2023-08-01)
+
+### Bug Fixes
+
+- **optimize:** 🐛 remove redundant peerDependencies ([7a3def8](https://github.com/jsverse/transloco/commit/7a3def8de36f9238c10bfce739fd9f3e83513e72)), closes [#677](https://github.com/jsverse/transloco/issues/677)
+
+# [5.0.0](https://github.com/jsverse/transloco/compare/transloco-optimize-4.0.0...transloco-optimize-5.0.0) (2023-07-30)
+
+# [4.0.0](https://github.com/jsverse/transloco/compare/transloco-optimize-3.0.2...transloco-optimize-4.0.0) (2023-06-17)
+
+### chore
+
+- 🤖 upgrade to angular v16 ([#661](https://github.com/jsverse/transloco/issues/661)) ([08db7e7](https://github.com/jsverse/transloco/commit/08db7e7d1f64846fa0b07123dee8ff5bff20b4f0))
+- **optimize:** 🤖 min node version is 16 ([ee1bc0b](https://github.com/jsverse/transloco/commit/ee1bc0b88555c808482a9f6b60061f15ea4ddaf7))
+
+### BREAKING CHANGES
+
+- **optimize:** 🧨 min node version is 16
+- 🧨 Angular 16
+
+## [3.0.2](https://github.com/jsverse/transloco/compare/transloco-optimize-3.0.1...transloco-optimize-3.0.2) (2021-10-25)
+
+### Bug Fixes
+
+- **optimize:** 🐛 wrong path resolution ([974b169](https://github.com/jsverse/transloco/commit/974b1698083913b99992e4994b77d4c2b6a5489e))
+
+## [3.0.1](https://github.com/jsverse/transloco/compare/transloco-optimize-3.0.0...transloco-optimize-3.0.1) (2021-10-25)
+
+### Bug Fixes
+
+- **optimize:** 🐛 bad import crash ([34ee25b](https://github.com/jsverse/transloco/commit/34ee25b0ffc811e5d0234190ec4f1a56ff873d63))

package/README.md

@@ -0,0 +1,3 @@
+# Transloco Optimize
+
+Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/tools/optimize).

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@jsverse/transloco-optimize",
+  "version": "7.0.0",
+  "description": "Transloco optimization process for production environments",
+  "main": "./src/index.js",
+  "engines": {
+    "node": ">=16"
+  },
+  "bin": {
+    "transloco-optimize": "src/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/jsverse/transloco/issues"
+  },
+  "homepage": "https://jsverse.github.io/transloco/docs/tools/optimize/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jsverse/transloco"
+  },
+  "keywords": [
+    "angular",
+    "angular 2",
+    "i18n",
+    "translate",
+    "angular translate",
+    "angular i18n",
+    "transloco",
+    "comments",
+    "build",
+    "optimize"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "flat": "^5.0.2",
+    "command-line-args": "^5.2.0",
+    "glob": "^10.0.0"
+  },
+  "type": "commonjs"
+}

package/src/index.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const command_line_args_1 = tslib_1.__importDefault(require("command-line-args"));
+const transloco_optimize_1 = require("./lib/transloco-optimize");
+const optionDefinitions = [
+    { name: 'commentsKey', alias: 'k', type: String, defaultValue: 'comment' },
+    { name: 'dist', alias: 'd', type: String, defaultOption: true },
+];
+const { dist, commentsKey } = (0, command_line_args_1.default)(optionDefinitions);
+(0, transloco_optimize_1.getTranslationFiles)(dist)
+    .then((filesPaths) => {
+    if (filesPaths.length === 0) {
+        return Promise.reject(`Transloco Optimize: No Translation path found under: ${(0, transloco_optimize_1.getTranslationsFolder)(dist)}`);
+    }
+    console.log(`Transloco Optimize: found ${filesPaths.length} translation files, optimizing...`);
+    return (0, transloco_optimize_1.optimizeFiles)(filesPaths, commentsKey);
+})
+    .then(() => {
+    console.log('Transloco Optimize: Done! 🎊 ');
+})
+    .catch((err) => {
+    console.warn(err);
+});

package/src/lib/transloco-optimize.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optimizeFiles = exports.getTranslationFiles = exports.getTranslationsFolder = void 0;
+const tslib_1 = require("tslib");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const glob_1 = require("glob");
+const flat_1 = require("flat");
+const isWindows = process.platform === "win32";
+function removeComments(translation, commentsKey = 'comment') {
+    return Object.keys(translation).reduce((acc, key) => {
+        const lastKey = key.split('.').pop();
+        if (lastKey !== commentsKey) {
+            acc[key] = translation[key];
+        }
+        return acc;
+    }, {});
+}
+function getTranslationsFolder(dist) {
+    return node_path_1.default.resolve(process.cwd(), dist);
+}
+exports.getTranslationsFolder = getTranslationsFolder;
+function getTranslationFiles(dist) {
+    const filesMatcher = node_path_1.default.resolve(getTranslationsFolder(dist), '**/*.json');
+    return (0, glob_1.glob)(filesMatcher, { windowsPathsNoEscape: isWindows });
+}
+exports.getTranslationFiles = getTranslationFiles;
+function optimizeFiles(translationPaths, commentsKey) {
+    return new Promise((resolve, reject) => {
+        let error;
+        for (const path of translationPaths) {
+            try {
+                const translation = node_fs_1.default.readFileSync(path, { encoding: 'utf8' });
+                const asObject = JSON.parse(translation);
+                const flatObject = (0, flat_1.flatten)(asObject, { safe: true });
+                const optimized = JSON.stringify(removeComments(flatObject, commentsKey));
+                node_fs_1.default.writeFileSync(path, optimized, { encoding: 'utf8' });
+            }
+            catch (err) {
+                error = err;
+                break;
+            }
+        }
+        if (error) {
+            reject(error);
+        }
+        else {
+            resolve();
+        }
+    });
+}
+exports.optimizeFiles = optimizeFiles;

package/src/test-setup.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file is required by karma.conf.js and loads recursively all the .spec and framework files
+Object.defineProperty(exports, "__esModule", { value: true });
+require("zone.js");
+require("zone.js/testing");
+const testing_1 = require("@angular/core/testing");
+const testing_2 = require("@angular/platform-browser-dynamic/testing");
+// First, initialize the Angular testing environment.
+(0, testing_1.getTestBed)().initTestEnvironment(testing_2.BrowserDynamicTestingModule, (0, testing_2.platformBrowserDynamicTesting)(), {
+    teardown: { destroyAfterEach: false },
+});