yata-fetch 2.0.1 → 2.0.2

package/.eslintrc.json

@@ -1,7 +1,8 @@
 {
   "env": {
     "browser": true,
-    "es2021": true
+    "es2021": true,
+    "node": true
   },
   "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
   "parser": "@typescript-eslint/parser",

package/.github/workflows/test.yaml

@@ -4,6 +4,9 @@ on:
   pull_request:
     branches:
       - master
+  push:
+    branches:
+      - master
 
 env:
   cache_version: v1

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "${1}"

package/README.md

@@ -1,6 +1,8 @@
 # yata-fetch
 
-Welcome to Yata integration package, this package will allow you to easy get your translations from http://yatapp.net service.
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/dzbo/yata-fetch/Test) [![NPM](https://img.shields.io/npm/v/yata-fetch)](https://www.npmjs.com/package/yata-fetch) ![NPM](https://img.shields.io/npm/l/yata-fetch) ![npms.io (maintenance)](https://img.shields.io/npms-io/quality-score/yata-fetch) ![npms.io (maintenance)](https://img.shields.io/npms-io/maintenance-score/yata-fetch)
+
+Welcome to Yata integration package, this package will allow you to easy get your translations from [Yata](https://run.yatapp.net/) service.
 
 ## Installation
 
@@ -23,7 +25,7 @@ You can check token in your organization settings.
 
 Example `.yata.json` file:
 
-```
+```json
 {
   "token": "MY_YATA_API_TOKEN",
   "project": "XXX",
@@ -68,7 +70,7 @@ Hint:
 
 It's best to create scripts for generating translations in `package.json` file. For example:
 
-```
+```json
 "scripts": {
   "yata-fetch": "yata-fetch --config .yata.json"
   "yata-fetch:en": "yata-fetch --config .yata.json --locale en_US"
@@ -79,25 +81,44 @@ and simply call with `npm run yata-fetch`
 
 ## Problems?
 
-- Open an Issue
+If you find some problems or bug in the package please open an Issue.
 
-## Contributing
+## Collaboration
 
-This project uses `yarn` as a package manager and `gulp` as task runner.
+Want help to develop this package? Please open a Pull Request.
 
 ## Package Maintenance
 
 ### Installation
 
-- `git clone` this repository
-- `npm install`
+```
+git clone <this repository>
+npm install
+```
 
-#### Running Tests
+### Running Tests
 
-- `npm run test`
+```
+npm run test
+```
 
 ### Building
 
-- `npm run build`
+```
+npm run build
+```
+
+### Release
+
+```
+npm version <major|minor|patch>
+git push origin --tags
+```
+Optionally create new release entry in Github Releases.
+When Github Action detect new version there will be automatic release to NPM.
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT)
 
-Build files are stored in `dist` folder.
+Copyright (c) 2017-present, Dominik Zborowski

package/commitlint.config.cjs

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']}