@tamtamchik/json-deep-sort 0.1.1 → 1.0.1

package/.circleci/config.yml

@@ -0,0 +1,23 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: cimg/node:20.2.0
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "package-lock.json" }}
+            - v1-dependencies-
+      - run: npm ci
+      - run: npm test
+      - run: npm run coverage
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package-lock.json" }}
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - build

package/README.md

@@ -1,7 +1,10 @@
 # JSON Deep Sort
 
-![npm](https://img.shields.io/npm/v/json-deep-sort)
-![license](https://img.shields.io/npm/l/json-deep-sort)
+[![Buy Me A Coffee][ico-coffee]][link-coffee]
+[![Latest Version on NPM][ico-version]][link-npm]
+[![CircleCI][ico-circleci]][link-circleci]
+[![Software License][ico-license]](LICENSE)
+[![Total Downloads][ico-downloads]][link-downloads]
 
 JSON Deep Sort is a comprehensive package that provides flexible sorting of JSON objects by keys. This
 TypeScript-written package can handle deeply nested objects and arrays, and offers both synchronous and asynchronous
@@ -19,13 +22,13 @@ operations.
 Using npm:
 
 ```shell
-npm install json-deep-sort
+npm install @tamtamchik/json-deep-sort
 ```
 
 Using yarn:
 
 ```shell
-yarn add json-deep-sort
+yarn add @tamtamchik/json-deep-sort
 ```
 
 ## Usage
@@ -49,8 +52,9 @@ let data = {
         b: 'b'
     }
 };
+
 let sortedData = sort(data, true);
-console.log(sortedData); // { a: 'a', b: 'b', c: { a: 'a', b: 'b', c: 'c', d: 'd' } }
+// { a: 'a', b: 'b', c: { a: 'a', b: 'b', c: 'c', d: 'd' } }
 ```
 
 ## Contributing
@@ -60,3 +64,14 @@ Pull requests are welcome. For major changes, please open an issue first to disc
 ## License
 
 JSON Deep Sort is [MIT licensed](./LICENSE).
+
+[ico-coffee]: https://img.shields.io/badge/Buy%20Me%20A-Coffee-%236F4E37.svg?style=flat-square
+[ico-version]: https://img.shields.io/npm/v/@tamtamchik/json-deep-sort.svg?style=flat-square
+[ico-license]: https://img.shields.io/npm/l/@tamtamchik/json-deep-sort.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/npm/dt/@tamtamchik/json-deep-sort.svg?style=flat-square
+[ico-circleci]: https://img.shields.io/circleci/build/github/tamtamchik/json-deep-sort.svg?style=flat-square
+
+[link-coffee]: https://www.buymeacoffee.com/tamtamchik
+[link-npm]: https://www.npmjs.com/package/@tamtamchik/json-deep-sort
+[link-downloads]: https://www.npmjs.com/package/@tamtamchik/json-deep-sort
+[link-circleci]: https://app.circleci.com/pipelines/github/tamtamchik/json-deep-sort?branch=main

package/dist/cjs/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function to sort JSON data.
+ * @param {any} data - The data to be sorted.
+ * @param {boolean} [asc=true] - Whether to sort in ascending order.
+ * @returns {any} The sorted data.
+ * @throws {Error} If the data is not an object or array.
+ */
+export declare function sort(data: any, asc?: boolean): any;

package/dist/esm/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function to sort JSON data.
+ * @param {any} data - The data to be sorted.
+ * @param {boolean} [asc=true] - Whether to sort in ascending order.
+ * @returns {any} The sorted data.
+ * @throws {Error} If the data is not an object or array.
+ */
+export declare function sort(data: any, asc?: boolean): any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamtamchik/json-deep-sort",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "description": "A comprehensive utility for sorting JSON objects by keys.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -53,6 +53,7 @@
     "build": "npm run build:cjs && npm run build:esm",
     "dev": "tsc --watch",
     "prepare": "npm run build",
-    "test": "jest"
+    "test": "jest",
+    "coverage": "jest --coverage"
   }
 }