xlf-translate-auto 1.1.0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,50 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Publish NPM Package
+
+on:
+  release:
+    types: [created]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm version
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  # publish-gpr:
+  #   needs: build
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - uses: actions/setup-node@v1
+  #       with:
+  #         node-version: 12
+  #         registry-url: https://npm.pkg.github.com/
+  #     - run: npm ci
+  #     - run: npm publish
+  #       env:
+  #         NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.github/workflows/test-on-push.yml

@@ -0,0 +1,20 @@
+name: Test On Push
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm test

package/.prettierrc.json

@@ -0,0 +1,4 @@
+{
+    "singleQuote": true,
+    "tabWidth": 4
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Nathan Friend
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# xlf-translate-auto (ex. xlf2xlf)
+
+A command-line utility to automatically translate .xlf translation files v1.2 or v2 using Google Translate
+
+**DISCLAIMER**
+
+> This library was forked from https://github.com/nfriend/xlf-translate-auto
+
+> Some additions to package dependecies were made according to https://www.npmjs.com/package/xlf-translate-auto-updated
+
+The main goal to fork and edit original tool was to preserve word and interpolation blocks order while translating original _.xlf_ file, as base library copied this interpolation blocks to the end of _target_ element.
+
+While making this improvements, the original _translate.js_ file eas fully rewritten starting from library we are using to read and build object model of _.xlf_ to ending with how we are parsing object model tree itself and creating queue to translate.
+
+Also most of redundant dependecies were removed, file and folder structure were redefined.
+
+## Installation
+
+This is a command-line utility.  To install this utility, run:
+
+```bash
+npm install -g xlf-translate-auto
+```
+
+This will install the utility globally so that it can be run from any location. The executable installed by this module is `xlf-translate-auto`.
+___
+
+You also could run library using **npx** utility.
+
+
+```bash
+npx xlf-translate-auto [options]
+```
+
+## Usage
+
+Before you begin, you will need an `.xlf` file to translate!
+
+If you are using [Angular 2+](https://angular.io/) and the [Angular CLI](https://cli.angular.io/), you will probably extract an `.xlf` file from your app by [running `ng xi18n` inside your Angular project](https://angular.io/guide/i18n#create-a-translation-source-file-with-ng-xi18n).  This produces a file named `messages.xlf` inside your project folder.
+
+Say we have an `.xlf` file named `messages.xlf`.  Let's translate this file from English ("en") to Hindi ("hi") and save the translated file as `messages.hi.xlf`:
+
+```bash
+xlf-translate-auto --in messages.xlf --out messages.hi.xlf --from en --to hi
+```
+
+Or, if you don't like typing too much, you can use the abbreviated versions of the arguments:
+
+```bash
+xlf-translate-auto -i messages.xlf -o messages.hi.xlf -f en -t nl
+```
+
+For more usage help, run:
+
+```bash
+xlf-translate-auto help
+```
+
+> If the utility not installed globally, just use it via npx, e.g. `npx xlf-translate-auto --in messages.xlf --out messages.hi.xlf --from en --to hi`
+
+## Messages
+
+Tool adds 2 kind of extra messages to final xlf file according to certain criterias:
+
+1. If we are using `skip` option, there will be information messages inside target tags to ease spot of where translation should be placed.
+
+Message:
+```
+[INFO] Add your translation here
+```
+
+2. If there is any errors during quering the translation, there will be warning messages inside problematic target tags to ease spot where things went wrong.
+
+Message:
+```
+[WARN] Failed to translate
+```
+
+## Parameters
+
+| Option          | Default   | Mandatory   | Description                       |
+|-----------------|-----------|-------------|-----------------------------------|
+| i / in          | -         | true        | The input .xlf file to translate  |
+| o / out         | -         | true        | The name of the translated output file  |
+| f / from        | -         | true        | The language code of the input file  |
+| t / to          | -         | true        | The language code to translate to  |
+| r / rate        | 500       | false       | How long to wait after launching a job before launching another one in ms. For more information see [https://github.com/SGrondin/bottleneck#docs](https://github.com/SGrondin/bottleneck)  |
+| c / concurrent  | 4         | false       | How many jobs can be executing at the same time. For more information see [https://github.com/SGrondin/bottleneck#docs](https://github.com/SGrondin/bottleneck)   |
+| s / skip        | false     | false       | Skips translating and adds only target tag with boilerplate text `[INFO] Add your translation here`  |
+| p / proxy       | false     | false       | Use custom proxy  |
+| ap / autoProxy  | -         | false       | Use default proxy   |
+| cs / clearState | false     | false       | Clear state once translated   |
+
+
+## 🤒 Known issues
+
+- The speed of quering / getting response is depends on network quality.
+
+- Sometimes translation could end up with tons of errors like  `{"name":"HTTPError","statusCode":429,"statusMessage":"Too Many Requests"}`, in this case better to wait for some time before next iteration.
+
+In case you are starting to get `{"name":"HTTPError","statusCode":429,"statusMessage":"Too Many Requests"}` you could do the following:
+
+- Wait a bit before Google Translate will stop blocking your IP
+- Try to set bigger rate `npx xlf-translate-auto --in messages.xlf --out messages.hi.xlf --from en --to hi --rate 5000`, where rate is ms between queries. For more information on that property see [https://github.com/SGrondin/bottleneck](https://github.com/SGrondin/bottleneck#docs)
+- Try to limit rate and amount of concurrent requests `npx xlf-translate-auto --in messages.xlf --out messages.hi.xlf --from en --to hi --rate 10000 --concurrent 1`
+
+## Developing
+
+The easiest way to develop on this module is to use test-driven development.
+
+Unit tests can be run with `npm test`.  To automatically re-run the tests when you make changes to the files, run `npm run test:watch`.
+
+## Translation
+
+This utility uses Google Translate's online API for its translations using this NPM package: https://www.npmjs.com/package/@k3rn31p4nic/google-translate-api
+
+## XLIF 1.2 Specification
+
+[http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html](http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html)