yata-fetch 1.3.2 → 2.0.0

package/.eslintrc.json

@@ -0,0 +1,16 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/no-var-requires": 0
+  }
+}

package/.github/workflows/publish.yaml

@@ -0,0 +1,23 @@
+name: Publish to NPM
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.16.0'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies and build 🔧
+        run: npm install && npm run build
+      - name: Publish package on NPM 📦
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yaml

@@ -0,0 +1,143 @@
+name: Test
+
+on:
+  pull_request:
+    branches:
+      - master
+
+env:
+  cache_version: v1
+  node-version: 16.16.0
+
+jobs:
+  dependencies:
+    name: Install dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Set lockfile_hash
+        run: echo "lockfile_hash=${{ hashFiles('**/package-lock.json') }}" >> $GITHUB_ENV
+      - name: Restore node_modules cache
+        uses: actions/cache@v2
+        id: node-modules-cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-modules-${{ env.cache_version }}-${{ env.lockfile_hash }}
+      - name: Get npm cache directory path
+        if: steps.node-modules-cache.outputs.cache-hit != 'true'
+        id: npm-cache-dir-path
+        run: echo "::set-output name=dir::~/.npm/_cacache"
+      - name: Restore npm cache
+        if: steps.node-modules-cache.outputs.cache-hit != 'true'
+        uses: actions/cache@v2
+        id: npm-cache
+        with:
+          path: ${{ steps.npm-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-npm-${{ env.cache_version }}-${{ env.lockfile_hash }}
+          restore-keys: ${{ runner.os }}-npm-${{ env.cache_version }}-
+      - name: Install dependencies
+        if: steps.node-modules-cache.outputs.cache-hit != 'true'
+        run: npm ci
+  lint_scripts:
+    name: Lint JavaScript
+    needs: dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Restore node_modules cache
+        uses: actions/cache@v2
+        id: node-modules-cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-modules-${{ env.cache_version }}-${{ hashFiles('**/package-lock.json') }}
+      - name: Lint
+        run: npm run lint:eslint
+  lint_format:
+    name: Lint Formatting
+    needs: dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Restore node_modules cache
+        uses: actions/cache@v2
+        id: node-modules-cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-modules-${{ env.cache_version }}-${{ hashFiles('**/package-lock.json') }}
+      - name: Lint format
+        run: npm run lint:fmt
+  lint_types:
+    name: Lint Typings
+    needs: dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Restore node_modules cache
+        uses: actions/cache@v2
+        id: node-modules-cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-modules-${{ env.cache_version }}-${{ hashFiles('**/package-lock.json') }}
+      - name: Lint
+        run: npm run lint:ts
+  build:
+    name: Build application
+    needs:
+      - dependencies
+      - lint_types
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Restore node_modules cache
+        uses: actions/cache@v2
+        id: node-modules-cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-modules-${{ env.cache_version }}-${{ hashFiles('**/package-lock.json') }}
+      - name: Build app
+        run: npm run build
+  test_unit:
+    name: Unit Tests
+    needs:
+      - build
+      - lint_scripts
+      - lint_format
+      - lint_types
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    outputs:
+      test-results: ${{ steps.status.outputs.test-results }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Restore node_modules cache
+        uses: actions/cache@v2
+        id: node-modules-cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-modules-${{ env.cache_version }}-${{ hashFiles('**/package-lock.json') }}
+      - name: Run tests
+        run: npm run test

package/.prettierignore

@@ -0,0 +1,15 @@
+# compiled output
+/dist/
+
+# dependencies
+/node_modules/
+
+# misc
+!.*
+.eslintcache
+/translations/
+eslintrc
+.lintstagedrc.json
+tsconfig.json
+.eslintrc
+package-lock.json

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "arrowParens": "avoid",
+  "printWidth": 80,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "semi": false,
+  "endOfLine": "lf"
+}

package/.tool-versions

@@ -1 +1 @@
-nodejs 12.16.1
+nodejs 16.16.0

package/README.md

@@ -1,21 +1,17 @@
 # yata-fetch
 
-[![CircleCI](https://circleci.com/gh/dzbo/yata-fetch/tree/master.svg?style=svg)](https://circleci.com/gh/dzbo/yata-fetch/tree/master)
-
 Welcome to Yata integration package, this package will allow you to easy get your translations from http://yatapp.net service.
 
 ## Installation
 
-Simply install via [yarn](https://yarnpkg.com) package manager:
-
-`yarn add yata-fetch -D`
+`npm install yata-fetch -D`
 
 ## Usage
 
 ### Setup
 
-* Create config file in project folder (see details below).
-* Add `MY_YATA_API_TOKEN` key to env variables in `.zshrc/.bashrc`:
+- Create config file in project folder (see details below).
+- Add `MY_YATA_API_TOKEN` key to env variables in `.zshrc/.bashrc`:
 
 ```
 export MY_YATA_API_TOKEN=XXXX
@@ -23,15 +19,14 @@ export MY_YATA_API_TOKEN=XXXX
 
 You can check token in your organization settings.
 
-
 ### Configuration file
 
-Example `yata.json` file:
+Example `.yata.json` file:
 
 ```
 {
   "token": "MY_YATA_API_TOKEN",
-  "project": "1",
+  "project": "XXX",
   "locales": [
     "en_US", "de_DE"
   ],
@@ -42,38 +37,49 @@ Example `yata.json` file:
 }
 ```
 
-* `token` (string, required) - name of ENV variable containing API token
-* `project` (string, required) - ID of the project
-* `locales` (array, required) - locales to generate
-* `format` (string, optional, default: yml) - output file format
-* `root` (boolean, optional, default: false) - if set to `true` locale file
+- `token` (string, required) - name of ENV variable containing API token
+- `project` (string, required) - ID of the project, you can get it from your organization settings in Yata
+- `locales` (array, required) - locales to generate
+- `format` (string, optional, default: yml) - output file format
+- `root` (boolean, optional, default: false) - if set to `true` locale file
   will contain locale as root element
-* `outputPath` (string, optional, default: './translations') - path where
+- `outputPath` (string, optional, default: './translations') - path where
   files will be generated
-* `strip_empty` (boolean, optional, default: false) - if set to `true` parser will omnit empty keys from generation and export only those that have text
+- `strip_empty` (boolean, optional, default: false) - if set to `true` parser will omnit empty keys from generation and export only those that have text
 
 ### Fetching translations
 
 ```
-$ node_modules/.bin/yata-fetch [options]
+$ yata-fetch [options]
 ```
 
 Options:
 
-* `config` (string, optional, default: yata.json) - path to json config file.
-* `locale` - if you like you can generate only one locale instead whole
-  stack from config file
-
+- `config` (string, optional, default: yata.json) - path to json config file.
+- `locale` - if you like you can generate only one locale instead whole stack from config file
 
 Example:
 
 ```
-node_modules/.bin/yata-fetch --config config.json --locale en_US
+$ yata-fetch --config .yata.json --locale en_US
 ```
 
+Hint:
+
+It's best to create scripts for generating translations in `package.json` file. For example:
+
+```
+"scripts": {
+  "yata-fetch": "yata-fetch --config .yata.json"
+  "yata-fetch:en": "yata-fetch --config .yata.json --locale en_US"
+}
+```
+
+and simply call with `npm run yata-fetch`
+
 ## Problems?
 
-* Open an Issue
+- Open an Issue
 
 ## Contributing
 
@@ -83,19 +89,15 @@ This project uses `yarn` as a package manager and `gulp` as task runner.
 
 ### Installation
 
-* `git clone` this repository
-* `yarn install`
-
-### Running
-
-* `yarn s`
+- `git clone` this repository
+- `npm install`
 
 #### Running Tests
 
-* `yarn test`
+- `npm run test`
 
 ### Building
 
-* `yarn build`
+- `npm run build`
 
-Build files are storred in `dist` folder.
+Build files are stored in `dist` folder.

package/bin/yata-fetch.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-const cli = require('../dist/cli');
+import cli from '../dist/cli.cjs'
 
-cli();
+cli()

package/dist/cli.cjs

@@ -0,0 +1,2 @@
+"use strict";function c(t,i){let e;switch(t){case"red":e="\x1B[31m";break;case"green":e="\x1B[32m";break;case"yellow":e="\x1B[33m";break;default:e="\x1B[37m"}return console.log(`${e}%s\x1B[0m`,i)}const y=require("https"),m=require("path"),l=require("fs"),f={config:null,defaultConfigPath:"./yata.json",configPath:"",token:"",project:"",locales:[],format:"yml",root:!1,outputPath:"translations",stripEmpty:!1,apiHost:"",getConfigPath(t){return t?this.configPath=t:this.configPath=this.defaultConfigPath,this.configPath},validateConfig(t,i,e,n,h,s,a){if(t)this.token=t;else throw new Error("No `token` in ENV");if(i)this.project=i;else throw new Error("No `project` in config file");if(!Array.isArray(e)||e.length===0)throw new Error("No `locales` in config file");return this.locales=e,n&&typeof n=="string"&&(this.format=n),h&&typeof h=="boolean"&&(this.root=h),s&&typeof s=="string"&&(this.outputPath=s),a&&typeof a=="boolean"&&(this.stripEmpty=a),!0},normalizeLocale(t){if(!t)return;const i=t.replace("-","_").split("_"),e=[];return e.push(i[0].toLowerCase()),i[1]&&e.push(i[1].toUpperCase()),e.join("_")},downloadTranslation(t){const i=this.normalizeLocale(t);if(!i)throw new Error("No locale passed to download function");l.existsSync(this.outputPath)||l.mkdirSync(this.outputPath);const e=`${i}.${this.format}`,n=m.join(process.cwd(),`${this.outputPath}/${e}`),h=`${this.apiHost}/api/v1/project/${this.project}/${t}/${this.format}?apiToken=${this.token}&root=${this.root}&strip_empty=${this.stripEmpty}`;let s;l.existsSync(n)&&(s=l.readFileSync(n));const a=l.createWriteStream(n);return new Promise((g,u)=>{y.get(h,r=>{const{statusCode:p}=r;if(p!==200)return u(`Request Failed.
+Status Code: ${p}`);r.pipe(a),a.on("finish",()=>{const d=l.readFileSync(n);s&&s.equals(d)?c("yellow",`Generating "${t}" translation. Skipped.`):c("green",`Generating "${t}" translation. Done.`),g(!0)})}).on("error",r=>{r instanceof Error?c("red",r.message):typeof r=="string"&&c("red",r)})})}},o=require("nconf");async function w(){o.argv(),o.env(),o.file({file:f.getConfigPath(o.get("config"))}),f.apiHost=o.get("YATA_API_HOST")||"https://api.yatapp.net";try{if(f.validateConfig(o.get(o.get("token")),o.get("project"),o.get("locales"),o.get("format"),o.get("root"),o.get("outputPath"),o.get("strip_empty")))if(o.get("locale"))await f.downloadTranslation(o.get("locale"));else for(const t of f.locales)await f.downloadTranslation(t)}catch(t){t instanceof Error?c("red",t.message):typeof t=="string"&&c("red",t)}}module.exports=w;

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "yata-fetch",
-  "version": "1.3.2",
+  "version": "2.0.0",
+  "type": "module",
   "description": "Adds CLI interface for importing translation files from Yata",
   "license": "MIT",
   "main": "./dist/yata",
@@ -20,28 +21,29 @@
     "yata-fetch": "./bin/yata-fetch.js"
   },
   "scripts": {
-    "test": "gulp test",
-    "start": "gulp",
-    "s": "gulp",
-    "build": "gulp build",
-    "generate": "node bin/yata-fetch.js --config test/fixtures/yata.json"
+    "build": "vite build",
+    "generate": "node bin/yata-fetch.js --config test/fixtures/yata.json",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "lint": "npm-run-all --aggregate-output --continue-on-error --parallel \"lint:*\"",
+    "lint:eslint": "eslint src --ext .js,.ts,.vue",
+    "lint:ts": "tsc --noEmit",
+    "lint:fmt": "prettier --check --loglevel=warn --write ."
   },
   "dependencies": {
-    "dotenv": "10.0.0",
-    "nconf": "^0.11.2"
+    "nconf": "0.12.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.10",
-    "@babel/plugin-transform-runtime": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
-    "@babel/runtime": "^7.12.5",
-    "babel-eslint": "^10.1.0",
-    "chai": "^4.2.0",
-    "gulp": "^4.0.2",
-    "gulp-babel": "^8.0.0",
-    "gulp-eslint": "^6.0.0",
-    "gulp-mocha": "^7.0.2",
-    "gulp-sourcemaps": "^3.0.0",
-    "mock-fs": "^4.13.0"
+    "@types/nconf": "0.10.3",
+    "@types/node": "18.6.4",
+    "@typescript-eslint/eslint-plugin": "5.32.0",
+    "@typescript-eslint/parser": "5.32.0",
+    "c8": "7.12.0",
+    "eslint": "8.21.0",
+    "npm-run-all": "4.1.5",
+    "prettier": "2.7.1",
+    "typescript": "^4.6.4",
+    "vite": "^3.0.0",
+    "vitest": "0.21.0"
   }
 }

package/src/cli.ts

@@ -0,0 +1,48 @@
+import { IFileOptions } from 'nconf'
+import yata from './yata'
+import log from './log'
+
+const nconf = require('nconf')
+
+export default async function () {
+  // read argv for potential custom config path
+  nconf.argv()
+
+  // read ENV for token
+  nconf.env()
+
+  // load config path
+  nconf.file({ file: yata.getConfigPath(nconf.get('config')) } as IFileOptions)
+
+  // setup API host
+  yata.apiHost = nconf.get('YATA_API_HOST') || 'https://api.yatapp.net'
+
+  try {
+    if (
+      yata.validateConfig(
+        nconf.get(nconf.get('token')),
+        nconf.get('project'),
+        nconf.get('locales'),
+        nconf.get('format'),
+        nconf.get('root'),
+        nconf.get('outputPath'),
+        nconf.get('strip_empty')
+      )
+    ) {
+      // if passed locale explicit download just one
+      if (nconf.get('locale')) {
+        await yata.downloadTranslation(nconf.get('locale'))
+      } else {
+        for (const locale of yata.locales) {
+          await yata.downloadTranslation(locale)
+        }
+      }
+    }
+  } catch (error) {
+    if (error instanceof Error) {
+      log('red', error.message)
+    } else if (typeof error === 'string') {
+      log('red', error)
+    }
+  }
+}

package/src/log.ts

@@ -0,0 +1,22 @@
+type Color = 'red' | 'green' | 'yellow'
+
+export default function (color: Color, message: string) {
+  let code
+
+  switch (color) {
+    case 'red':
+      code = '\x1b[31m'
+      break
+    case 'green':
+      code = '\x1b[32m'
+      break
+    case 'yellow':
+      code = '\x1b[33m'
+      break
+
+    default:
+      code = '\x1b[37m' // white
+  }
+
+  return console.log(`${code}%s\x1b[0m`, message)
+}

package/src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/src/yata.ts

@@ -0,0 +1,153 @@
+import log from './log'
+
+import { IncomingMessage } from 'http'
+const https = require('https')
+const path = require('path')
+const fs = require('fs')
+
+type Locale = string
+type Format = 'yml' | 'json'
+
+export default {
+  config: null,
+  defaultConfigPath: './yata.json',
+  configPath: '',
+  token: '',
+  project: '',
+  locales: [] as string[],
+  format: 'yml',
+  root: false,
+  outputPath: 'translations',
+  stripEmpty: false,
+  apiHost: '',
+
+  getConfigPath(configPath: string) {
+    if (configPath) {
+      this.configPath = configPath
+    } else {
+      this.configPath = this.defaultConfigPath
+    }
+
+    return this.configPath
+  },
+
+  validateConfig(
+    token?: string,
+    project?: string,
+    locales?: Locale[],
+    format?: Format,
+    root?: boolean,
+    outputPath?: string,
+    stripEmpty?: boolean
+  ) {
+    if (!token) {
+      throw new Error('No `token` in ENV')
+    } else {
+      this.token = token
+    }
+
+    if (!project) {
+      throw new Error('No `project` in config file')
+    } else {
+      this.project = project
+    }
+
+    if (!Array.isArray(locales) || locales.length === 0) {
+      throw new Error('No `locales` in config file')
+    } else {
+      this.locales = locales
+    }
+
+    if (format && typeof format === 'string') {
+      this.format = format
+    }
+
+    if (root && typeof root === 'boolean') {
+      this.root = root
+    }
+
+    if (outputPath && typeof outputPath === 'string') {
+      this.outputPath = outputPath
+    }
+
+    if (stripEmpty && typeof stripEmpty === 'boolean') {
+      this.stripEmpty = stripEmpty
+    }
+
+    return true
+  },
+
+  normalizeLocale(locale: Locale) {
+    if (!locale) {
+      return
+    }
+
+    const localeSegments = locale.replace('-', '_').split('_')
+    const newLocale = []
+    newLocale.push(localeSegments[0].toLowerCase())
+
+    // two segment locale
+    if (localeSegments[1]) {
+      newLocale.push(localeSegments[1].toUpperCase())
+    }
+
+    return newLocale.join('_')
+  },
+
+  downloadTranslation(locale: Locale) {
+    const normalizedLocale = this.normalizeLocale(locale)
+
+    if (!normalizedLocale) {
+      throw new Error('No locale passed to download function')
+    }
+
+    // if output folder doesn't exist we create it
+    if (!fs.existsSync(this.outputPath)) {
+      fs.mkdirSync(this.outputPath)
+    }
+
+    const fileName = `${normalizedLocale}.${this.format}`
+    const filePath = path.join(process.cwd(), `${this.outputPath}/${fileName}`)
+    const url = `${this.apiHost}/api/v1/project/${this.project}/${locale}/${this.format}?apiToken=${this.token}&root=${this.root}&strip_empty=${this.stripEmpty}`
+
+    let bufferFile: Buffer
+
+    // if file exist we grab it's size
+    if (fs.existsSync(filePath)) {
+      bufferFile = fs.readFileSync(filePath)
+    }
+
+    // we start stream
+    const file = fs.createWriteStream(filePath)
+
+    return new Promise((resolve, reject) => {
+      https
+        .get(url, (response: IncomingMessage) => {
+          const { statusCode } = response
+
+          if (statusCode !== 200) {
+            return reject(`Request Failed.\nStatus Code: ${statusCode}`)
+          }
+
+          response.pipe(file)
+          file.on('finish', () => {
+            const newBufferFile = fs.readFileSync(filePath)
+
+            if (bufferFile && bufferFile.equals(newBufferFile)) {
+              log('yellow', `Generating "${locale}" translation. Skipped.`)
+            } else {
+              log('green', `Generating "${locale}" translation. Done.`)
+            }
+            resolve(true)
+          })
+        })
+        .on('error', (error: Error) => {
+          if (error instanceof Error) {
+            log('red', error.message)
+          } else if (typeof error === 'string') {
+            log('red', error)
+          }
+        })
+    })
+  },
+}

package/test/fixtures/yata.json

@@ -1,9 +1,7 @@
 {
   "token": "YATA_DEV_TOKEN",
-  "project": "1",
-  "locales": [
-    "pl_PL", "de_DE"
-  ],
+  "project": "UVV6Rm1yc2JZbS9NcVBUWW96U2RjTldSREFtbDNKQVhHc2JlT0J3T2ZGVT0=",
+  "locales": ["pl_PL", "en_US"],
   "format": "yml",
   "root": false,
   "outputPath": "./translations",