Add documentation and an order function (#30)

* Update and add documentation

* Fix build

* fix up linging and CI CD

* Package

Author: develohpanda

.circleci/config.yml

@@ -0,0 +1,4 @@
+node_modules/
+dist
+coverage
+jest.config.js

.eslintignore

@@ -0,0 +1,48 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module",
+    "project": "./tsconfig.json",
+    "tsconfigRootDir": "."
+  },
+  "env": {
+    "jest/globals": true
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "jest",
+    "prettier"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier/@typescript-eslint",
+    "plugin:prettier/recommended",
+    "plugin:import/typescript",
+    "plugin:import/errors",
+    "plugin:import/warnings"
+  ],
+  "rules": {
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/array-type": [
+      "warn",
+      {
+        "default": "generic"
+      }
+    ],
+    "@typescript-eslint/no-explicit-any": "off",
+    "import/prefer-default-export": "off",
+    "no-undef": "off",
+    "no-unused-expressions": [
+      "warn",
+      {
+        "allowShortCircuit": true,
+        "allowTernary": true
+      }
+    ],
+    "no-prototype-builtins": "off"
+  }
+}

.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "trailingComma": "es5",
+  "printWidth": 80,
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "bracketSpacing": false,
+  "quoteProps": "consistent"
+}

.npmignore

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "dbaeumer.vscode-eslint",
+        "pmneo.tsimporter",
+        "coenraads.bracket-pair-colorizer",
+    ]
+}

.prettierrc

@@ -0,0 +1,11 @@
+{
+    "editor.rulers": [
+        80,
+        120
+    ],
+    "editor.formatOnSave": false,
+    "eslint.enable": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": true
+    }
+}

.vscode/extensions.json

@@ -1,6 +1,7 @@
-# json-order
+# 📚 json-order
 
-[![npm version](https://badge.fury.io/js/json-order.svg)](https://badge.fury.io/js/json-order) [![CircleCI](https://circleci.com/gh/develohpanda/json-order.svg?style=svg)](https://circleci.com/gh/develohpanda/json-order)
+[![npm](https://img.shields.io/npm/v/json-order?logo=npm)](https://www.npmjs.com/package/json-order)
+[![Azure DevOps builds](https://img.shields.io/azure-devops/build/develohpanda/5974ee25-e62e-483b-b9aa-c3560b2a7be1/1?label=Azure%20Pipelines&logo=Azure%20Pipelines)](https://dev.azure.com/json-order/_build?definitionId=1)
 
 json-order allows for conversion between JS Objects and a JSON string while keeping property order, controlled via a property map. **All manner of nesting is supported**.
 
@@ -31,6 +32,18 @@ const jsonString = orderedJson.stringify(srcObj, map, 2);
 - `separator` [optional]: a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
 - `space` [optional]: a `number` used to insert white space into the output JSON string for readability purposes, as per the `JSON.stringify` [documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters).
 
+### `order`
+
+To duplicate a JS object but containing a particular property order:
+```js
+const orderedObj = orderedJson.order(srcObj, map, 2);
+```
+
+#### Parameters
+- `srcObj`: an object with the properties in any order
+- `map` [optional]: the property map generated by `parse` above. If the map is unset, the response is a standard `JSON.stringify`. 
+- `separator` [optional]: a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
+
 ## Example
 
 An object with a particular property order:

.vscode/settings.json

@@ -1,13 +1,18 @@
-import orderedJSON from '../src/index';
+import order from '../src/order';
 import parse from '../src/parse';
 import stringify from '../src/stringify';
+import orderedJSON from '../src';
 
 describe('package export', () => {
-    it('parse correctly configured', () => {
-        expect(orderedJSON.parse).toBe(parse);
-    });
+  it('parse correctly configured', () => {
+    expect(orderedJSON.parse).toBe(parse);
+  });
 
-    it('stringify correctly configured', () => {
-        expect(orderedJSON.stringify).toBe(stringify);
-    });
+  it('stringify correctly configured', () => {
+    expect(orderedJSON.stringify).toBe(stringify);
+  });
+
+  it('order correctly configured', () => {
+    expect(orderedJSON.order).toBe(order);
+  });
 });