docs: updates on workflows

Added information on documentation

Author: ADMSK\AVROGAL1

.env-cmdrc.json

@@ -0,0 +1,11 @@
+{
+    "dev": {
+        "DEBUG": "true"
+    },
+    "prod": {
+        "DEBUG": "false"
+    },
+    "test": {
+        "TZ": "utc"
+    }
+}

.github/workflows/main.yml

@@ -12,20 +12,53 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - run: |
-          npm install
-      - run: |
+          with:
+            ref: ${{ github.head_ref }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+
+      - name: Pull from current branch
+        run: git pull origin ${GITHUB_REF##*/}
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build project
+        run: |
           npm run all
 
+      - name: Run tests
+        run: |
+          npm run test:all
+
   test: # make sure the action works on a clean machine without building
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+          with:
+            ref: ${{ github.head_ref }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+
+      - name: Pull from current branch
+        run: git pull origin ${GITHUB_REF##*/}
+
+      - name: Install Dependencies
+        run: npm install
+
       - uses: ./
         with:
           jsonMode: 'unique'
           sourceFile: ./data/african_proverbs.json
           targetPath: ./data
-          destFile: ./data/african_proverbs_unique.json
+          destFile: african_proverbs_unique.json
           targetProperty: 'african'
           fields: 'text'
+
+      - name: Push changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Add images pulled from headless browser to folder
+          commit_options: '--no-verify --signoff'

.github/workflows/test.yml

@@ -1 +1 @@
-_
+_

.husky/.gitignore

@@ -1,8 +1,8 @@
-# _Json unique fields_
+# _Json fields_
 
-> GitHub Action to generate json with unique fields
+> GitHub Action to process JSON file by provided fields
 
-[![GitHub marketplace](https://img.shields.io/badge/marketplacegithub-json--fields-unique-blue?logo=github)](https://github.com/marketplace/actions/json-fields)
+[![GitHub marketplace](https://img.shields.io/badge/marketplacegithub-json--fields-blue?logo=github)](https://github.com/marketplace/actions/json-fields)
 
 [![management: perfekt👌](https://img.shields.io/badge/management-perfekt👌-red.svg)](https://github.com/lekterable/perfekt)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
@@ -72,7 +72,7 @@
 
 <p align="center" style="text-align:center;">
     <a href="https://www.typescriptlang.org/">
-        <img src="https://img.shields.io/badge/javascript%20-%23323330.svg?&logo=javascript&logoColor=%23F7DF1E" alt="JavaScript" />
+        <img src="https://img.shields.io/badge/javascript%20-%23323330.svg?&logo=typescript&logoColor=%23F7DF1E" alt="Typescript" />
     </a>
     <a href="https://www.repostatus.org/#active">
         <img src="https://img.shields.io/badge/Project%20Status-Active-brightgreen" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed." />
@@ -85,71 +85,73 @@
     </a>
 </p>
 
-Creates _**Json Unique Fields**_ by language and input color parameters.
+Processes JSON file by provided list of fields and file source parameters.
 
 ## _Inputs_
 
-### `language`
+### `jsonMode`
 
-**Optional** Proverb's language (default **random**)
+**Required** JSON operation mode
 
-### `pattern`
+#### `unique`
 
-**Optional** Proverb's image background pattern (default **random**)
+Only unique fields to be filtered
 
-### `width`
+#### `duplicate`
 
-**Optional** Proverb's image width (default **100%**)
+Only duplicate fields to be filtered
 
-### `height`
+### `sourceFile`
 
-**Optional** Proverb's image height (default **100%**)
+**Required** JSON source file to operate by
 
-### `backgroundColor`
+### `targetPath`
 
-**Optional** Proverb's image background color (default **%23FFFFFF**)
+**Required** Target path to store filtered JSON file
 
-### `fontColor`
+### `destFile`
 
-**Optional** Proverb's image font color (default **%230A83DC**)
+**Required** JSON destination file name
 
-### `opacity`
+### `targetProperty`
 
-**Optional** Proverb's image background opacity (default **0.3**)
+**Required** String representing slash-separated list of properties hierarchy to operate by (**property1/property2/.../propertyN**)
 
-### `colorPattern`
+### `fields`
 
-**Optional** Proverb's image text color (default **%23FFE0E9**)
+**Optional** String representing comma-separated list of fields to operate by (**field1,field2,...,fieldN**)
 
-### `name`
+## _Outputs_
 
-**Optional** Proverb's image name (default **proverb**)
+### `status`
 
-### `path`
+JSON operation status
 
-**Optional** Proverb's image path (default **images**)
+#### `true`
 
-## _Outputs_
+When file successfully processed and stored to destination folder
 
-### `image`
+#### `false`
 
-Generated proverb image (stored in the `path` directory)
+When errors occurred while processing source file
 
 ## _Examples_
 
 ```yml
-- name: Create json with unique fields
+- name: Process JSON file by fields
   uses: alexrogalskiy/github-action-json-fields@master
   with:
-    language: 'french'
-    pattern: 'wiggle'
-    name: 'proverb'
-    path: 'images'
+    jsonMode: 'unique'
+    sourceFile: ./data/african_proverbs.json
+    targetPath: ./data
+    destFile: african_proverbs_unique.json
+    targetProperty: 'african'
+    fields: 'text'
 ```
 
 Running locally:
 
-- `npm run start:action --action github-action-json-fields --language 'french' --pattern 'wiggle' --name proverb --path images`
+- `npm run start:action --action github-action-json-fields --jsonMode 'unique' --sourceFile './data/african_proverbs.json' --targetPath './data' --destFile 'african_proverbs_unique.json' --targetProperty 'african' --fields 'text'`
 
 ## _Visitor stats_
 
@@ -161,15 +163,15 @@ Running locally:
 
 ## _Licensing_
 
-_**Json Unique Fields**_ is distributed under LGPL version 3 or later,
+_**Json Fields**_ is distributed under LGPL version 3 or later,
 [[License](https://github.com/AlexRogalskiy/github-action-json-fields/blob/master/LICENSE)]. LGPLv3 is additional
 permissions on top of GPLv3.
 
 ![license](https://user-images.githubusercontent.com/19885116/48661948-6cf97e80-ea7a-11e8-97e7-b45332a13e49.png)
 
 ## _Authors_
 
-_**Json Unique Fields**_ is maintained by the following GitHub team-members:
+_**Json Fields**_ is maintained by the following GitHub team-members:
 
 - [![Author](https://img.shields.io/badge/author-AlexRogalskiy-FB8F0A)](https://github.com/AlexRogalskiy)
 
@@ -207,7 +209,7 @@ See also the list of [contributors][contributors] who participated in this proje
 
 ## _Development Support_
 
-Like _**Json Unique Fields**_ ? Consider buying me a coffee :\)
+Like _**Json Fields**_ ? Consider buying me a coffee :\)
 
 [![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square&logo=patreon&color=e64413)](https://www.patreon.com/alexrogalskiy)
 [![Buy Me A Coffee](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=buy%20me%20a%20coffee)](https://www.buymeacoffee.com/AlexRogalskiy)

README.md

@@ -1,58 +1,36 @@
-name: 'Json Unique Fields'
-description: 'Create JSON with unique fields'
+name: 'Json Fields'
+description: 'Create JSON file with filtered fields (unique/duplicate)'
 author: 'AlexRogalskiy'
 
 inputs:
-  language:
-    description: 'proverbs language'
-    required: false
-    default: 'random'
-  pattern:
-    description: 'proverbs image background pattern'
-    required: false
-    default: 'random'
-  width:
-    description: 'proverbs image width'
-    required: false
-    default: '100%'
-  height:
-    description: 'proverbs image height'
-    required: false
-    default: '100%'
-  backgroundColor:
-    description: 'proverbs image background color'
-    required: false
-    default: '%23FFFFFF'
-  fontColor:
-    description: 'proverbs image font color'
-    required: false
-    default: '%230A83DC'
-  opacity:
-    description: 'proverbs image background opacity'
-    required: false
-    default: '0.3'
-  colorPattern:
-    description: 'proverbs image text color'
-    required: false
-    default: '%23FFE0E9'
-  name:
-    description: 'proverbs image name'
-    required: false
-    default: 'quote'
-  path:
-    description: 'proverbs image path'
-    required: false
-    default: 'images'
+  jsonMode:
+    description: 'JSON operation mode (unique/duplicate)'
+    required: true
+  sourceFile:
+    description: 'JSON source file'
+    required: true
+  targetPath:
+    description: 'Target path to store filtered JSON file'
+    required: true
+  destFile:
+    description: 'JSON destination file name'
+    required: true
+  targetProperty:
+    description: 'JSON target property name to operate by'
+    required: true
+  fields:
+    description: 'JSON fields to operate by'
+    required: true
 
 outputs:
-  image:
-    description: 'proverb image generated by input parameters'
+  status:
+    description: 'JSON operation status'
 
 runs:
   using: 'node12'
   main: 'dist/index.js'
 
 # Ref: https://haya14busa.github.io/github-action-brandings/
 branding:
-  icon: 'bookmark'
-  color: 'blue'
+  icon: 'file-text'
+  color: 'white'

action.yml

@@ -4,16 +4,18 @@ module.exports = {
     clearMocks: true,
     moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
     testEnvironment: 'node',
-    testMatch: ['**/*.test.ts', '**/__tests__/**/?(*.)+(spec|test).ts'],
+    testMatch: ['**/*.test.(ts|js)', '**/__tests__/**/?(*.)+(spec|test).ts'],
     testRunner: 'jest-circus/runner',
-    testPathIgnorePatterns: ['/node_modules/', '/__fixtures__/'],
+    testPathIgnorePatterns: ['/node_modules/', '/__fixtures__/', '/spec/'],
     transform: {
         '^.+\\.(ts)$': 'ts-jest',
     },
     collectCoverage: true,
     collectCoverageFrom: [
         '**/*.ts',
         '!**/*.d.ts',
+        '!**/*.folio.ts',
+        '!**/*.spec.ts',
         '!**/dist/**',
         '!**/node_modules/**',
         '!**/vendor/**',