Fixed interface of Options not exported

Author: sumithemmadi

.npmignore

@@ -3,7 +3,10 @@ src/
 # Ignore development and configuration files
 node_modules/
 test/
-.git/
-.eslint*
-.prettier*
+.github
+.eslintrc.json
+.eslintignore
+.prettierignore
+.prettierrc.json
+jest.config.ts
 coverage

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+ 
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+ 
+## [1.1.3] - 2023-08-30
+ 
+Here we write upgrading notes for brands. It's a team effort to make them as
+straightforward as possible.
+ 
+### Added
+- [json-to-plain-text](https://github.com/sumithemmadi/json-to-plain-text) Added seperator option.
+   
+### Changed
+ 
+- [json-to-plain-text](https://github.com/sumithemmadi/json-to-plain-text) Made some updateds
+  
+
+### Fixed
+- [json-to-plain-text](https://github.com/sumithemmadi/json-to-plain-text) interfaceof options  `Options` is not exported. So , It is fixed in this version.

CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Code of Conduct for https://github.com/sumithemmadi/json-to-plain-text
+
+## Our Pledge
+
+We, as members, contributors, and maintainers of this repository, pledge to foster an open, inclusive, and respectful environment for everyone who engages with our project. We are dedicated to providing a harassment-free experience, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+- Being respectful and considerate towards others.
+- Encouraging and supporting each other's ideas and contributions.
+- Providing and receiving constructive feedback with grace and openness.
+- Being empathetic and understanding towards differing perspectives.
+
+Examples of unacceptable behavior include:
+
+- Use of offensive, derogatory, or inappropriate language.
+- Harassment, trolling, or any form of personal attacks.
+- Publishing private information without explicit permission.
+- Engaging in any behavior that could be considered inappropriate or harmful.
+
+## Responsibilities
+
+Project maintainers are responsible for upholding the standards of conduct within the repository. They have the right and duty to remove, edit, or reject comments, code, and other contributions that violate this Code of Conduct.
+
+## Scope
+
+This Code of Conduct applies to all interactions within the repository, as well as to any public representation of the project. This includes comments, issues, pull requests, code reviews, and any other communication.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [Your Contact Email]. All complaints will be reviewed promptly and treated with confidentiality and respect. Project maintainers are obligated to respect the privacy and security of the reporter of any incident.
+
+## Consequences
+
+Anyone found to be violating this Code of Conduct may face consequences, which can include:
+
+1. **Warning**: A private, written warning from the project maintainers.
+2. **Temporary Ban**: A temporary ban from participating in the repository.
+3. **Permanent Ban**: A permanent ban from the repository and its related activities.
+
+Project maintainers will use their discretion in determining the appropriate consequences for each case, considering the severity and impact of the violation.

README.md

@@ -6,6 +6,10 @@
 [![License](https://img.shields.io/npm/l/json-to-plain-text.svg)](https://github.com/sumithemmadi/json-to-plain-text/blob/main/LICENSE)
 [![Maintenance](https://img.shields.io/npms-io/maintenance-score/json-to-plain-text)](https://github.com/sumithemmadi/json-to-plain-text)
 [![Issues](https://img.shields.io/github/issues/sumithemmadi/json-to-plain-text)](https://github.com/sumithemmadi/json-to-plain-text/issues)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/sumithemmadi)](https://github.com/sponsors/sumithemmadi)
+[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=json-to-plain-text&query=$.install.pretty&label=install%20size)](https://packagephobia.now.sh/result?p=json-to-plain-text)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/json-to-plain-text)](https://bundlephobia.com/package/json-to-plain-text@latest)
+[![Known Vulnerabilities](https://snyk.io/test/npm/json-to-plain-text/badge.svg)](https://snyk.io/test/npm/json-to-plain-text)
 
 `json-to-plain-text` is a npm module that converts JSON-like data or plain JavaScript objects to a formatted plain text representation. It allows you to convert JSON-like data or plain JavaScript objects into  human-readable format.
 
@@ -19,7 +23,7 @@
 
 2. Import the `jsonToPlainText` function:
 
-   ```typescript
+   ```js
    import { jsonToPlainText } from "json-to-plain-text";
    ```
 
@@ -34,6 +38,7 @@ The `jsonToPlainText` function accepts two parameters: `data` and `options`.
 - `options` (optional): Configuration options for customizing the output. It is an object with the following properties:
 
   - `color` (boolean, default: `true`): Whether to apply colors to the output or not. Set to `true` to add colors using the `chalk` library or `false` for plain text output.
+  - `seperator` (string, default: `:`): seperate keys and values.
 
   - `spacing` (boolean, default: `true`): Whether to include spacing before colons. Set to `true` for formatted spacing or `false` to remove spacing before colons.
 
@@ -46,48 +51,45 @@ The `jsonToPlainText` function accepts two parameters: `data` and `options`.
 ### Example
 
 ```typescript
-import { jsonToPlainText } from "json-to-plain-text";
-
-const data = {
-    "place_id": "173937105",
-    "osm_type": "way",
-    "osm_id": "319992693",
-    "lat": "17.861533866867224",
-    "lon": "78.8081441896764",
-    "display_name": "Satadar Nagar, Ward 116 Allapur, Hyderabad, Kukatpally mandal, Telangana, 500018, India",
-    "address": {
-        "neighbourhood": "Satadar Nagar",
-        "suburb": "Ward 116 Allapur",
-        "city": "Hyderabad",
-        "county": "Kukatpally mandal",
-        "state": "Telangana",
-        "postcode": "500018",
-        "country": "India",
-        "country_code": "in"
-    },
-    "extratags": {},
-    "namedetails": {},
-    "boundingbox": [
-        "17.8598497",
-        "17.8623087",
-        "78.8079136",
-        "78.8082658"
-    ],
-    "distance": 2
-}
+import { jsonToPlainText, Options } from "json-to-plain-text";
+
+let data = {
+  place_id: "173937105",
+  osm_type: "way",
+  osm_id: "319992693",
+  lat: "17.861533866867224",
+  lon: "78.8081441896764",
+  display_name:
+    "Satadar Nagar, Ward 116 Allapur, Hyderabad, Kukatpally mandal, Telangana, 500018, India",
+  address: {
+    neighbourhood: "Satadar Nagar",
+    suburb: "Ward 116 Allapur",
+    city: "Hyderabad",
+    county: "Kukatpally mandal",
+    state: "Telangana",
+    postcode: "500018",
+    country: "India",
+    country_code: "in",
+  },
+  extratags: {},
+  namedetails: {},
+  boundingbox: ["17.8598497", "17.8623087", "78.8079136", "78.8082658"],
+  distance: 2,
+};
+
 
 // This is optional
-const options = {
+const options: Options = {
   color: true,                      // Whether to apply colors to the output or not
   spacing: true,                    // Whether to include spacing before colons or not
+  seperator: ":",                   // seperate keys and values.
   squareBracketsForArray: false,    // Whether to use square brackets for arrays or not
   doubleQuotesForKeys: false,       // Whether to use double quotes for object keys or not
   doubleQuotesForValues: false,     // Whether to use double quotes for string values or not
 }
 
 // Convert the data to formatted plain text representation
 const plainText = jsonToPlainText(data, options);
-
 console.log(plainText);
 ```
 
@@ -115,6 +117,17 @@ boundingbox   : 17.8598497, 17.8623087, 78.8079136, 78.8082658
 distance      : 2
 ```
 
+## 💝 Sponsor
+
+If you find TruecallerJS helpful or inspiring, consider supporting me through GitHub Sponsors. Your sponsorship helps me dedicate more time and effort to open source development and creating impactful projects.
+
+- **Sponsor Me**: [https://github.com/sponsors/sumithemmadi](https://github.com/sponsors/sumithemmadi/)
+  
+- <a href="https://www.buymeacoffee.com/sumithemmadi" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" style="height: 45px !important;width: 200px !important;" ></a>
+### 💖 Sponsors
+
+[![Sponsors](https://sumithemmadi.github.io/sponsor.svg)](https://github.com/sponsors/sumithemmadi/)
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

SECURITY.md

@@ -0,0 +1,20 @@
+## Supported Versions
+
+This section outlines the versions of the "json-to-plain-text" package that are currently eligible for receiving security updates and maintenance. It's essential to keep your software up to date to ensure the security and stability of your applications.
+
+| Version     | Supported          | Notes                     |
+| ----------- | ------------------ | ------------------------- |
+| 1.1.x       | :white_check_mark: | Latest and actively maintained version. Security updates and bug fixes will be provided. It's recommended to upgrade to this version. |
+| 1.0.x       | :x:                | This version is no longer receiving security updates. Users are advised to upgrade to the latest 1.1.x release for continued support. |
+| < 1.0       | :x:                | Versions prior to 1.0 are not supported and may contain known security vulnerabilities. Users should upgrade to a supported version. |
+
+It's our priority to provide a secure and reliable package for our users. We strongly encourage all users to stay up to date with the latest supported version to benefit from the latest security enhancements and bug fixes.
+
+## Reporting a Vulnerability
+
+I take security vulnerabilities seriously and appreciate the help of the community in identifying and addressing them. If you discover a security vulnerability in the "json-to-plain-text" package, please report it:
+
+**Contact Information**: You can report the vulnerability by raiseing issue [json-to-plain-text](https://github.com/sumithemmadi/json-to-plain-text). Please provide a detailed description of the vulnerability and steps to reproduce it, if possible.
+
+
+Thank you for your dedication to the security of the "json-to-plain-text" package. Your responsible disclosure helps us provide a safer experience for all our users.

dist/cjs/index.d.ts

@@ -1,6 +1,7 @@
 interface Options {
     color?: boolean;
     spacing?: boolean;
+    seperator?: string;
     squareBracketsForArray?: boolean;
     doubleQuotesForKeys?: boolean;
     doubleQuotesForValues?: boolean;
@@ -13,6 +14,7 @@ interface Options {
  * @param options {Options} - (Optional) Configuration options for customizing the output.
  *   - color {boolean} - Whether to apply colors to the output (default: true).
  *   - spacing {boolean} - Whether to include spacing after colons (default: true).
+ *   - seperator {string} -  seperator. Default ':',
  *   - squareBracketsForArray {boolean} - Whether to use square brackets for arrays (default: false).
  *   - doubleQuotesForKeys {boolean} - Whether to use double quotes for object keys (default: false).
  *   - doubleQuotesForValues {boolean} - Whether to use double quotes for string values (default: false).
@@ -23,6 +25,7 @@ interface Options {
  * const options = {
  *    color: true,
  *    spacing: true,
+ *    seperator?: "=";
  *    squareBracketsForArray: false,
  *    doubleQuotesForKeys: false,
  *    doubleQuotesForValues: false,
@@ -32,9 +35,9 @@ interface Options {
  *
  * // Output:
  * //
- * //   name : "John",
- * //   age : 30,
- * //   isEmployed : true
+ * //   name = "John",
+ * //   age = 30,
+ * //   isEmployed = true
  */
 declare function jsonToPlainText(data: unknown, options: Options): string;
-export { jsonToPlainText };
+export { jsonToPlainText, Options };

dist/cjs/index.js

@@ -30,6 +30,7 @@ const chalk_1 = __importDefault(require("chalk"));
  * @param options {Options} - (Optional) Configuration options for customizing the output.
  *   - color {boolean} - Whether to apply colors to the output (default: true).
  *   - spacing {boolean} - Whether to include spacing after colons (default: true).
+ *   - seperator {string} -  seperator. Default ':',
  *   - squareBracketsForArray {boolean} - Whether to use square brackets for arrays (default: false).
  *   - doubleQuotesForKeys {boolean} - Whether to use double quotes for object keys (default: false).
  *   - doubleQuotesForValues {boolean} - Whether to use double quotes for string values (default: false).
@@ -40,6 +41,7 @@ const chalk_1 = __importDefault(require("chalk"));
  * const options = {
  *    color: true,
  *    spacing: true,
+ *    seperator?: "=";
  *    squareBracketsForArray: false,
  *    doubleQuotesForKeys: false,
  *    doubleQuotesForValues: false,
@@ -49,16 +51,17 @@ const chalk_1 = __importDefault(require("chalk"));
  *
  * // Output:
  * //
- * //   name : "John",
- * //   age : 30,
- * //   isEmployed : true
+ * //   name = "John",
+ * //   age = 30,
+ * //   isEmployed = true
  */
 function jsonToPlainText(data, options) {
     const visited = new Set();
     let indentLevel = 1;
     const defaultOptions = {
         color: true,
         spacing: true,
+        seperator: ":",
         squareBracketsForArray: false,
         doubleQuotesForKeys: false,
         doubleQuotesForValues: false,
@@ -67,6 +70,7 @@ function jsonToPlainText(data, options) {
     const outputOptions = {
         color: mergedOptions.color,
         spacing: mergedOptions.spacing,
+        seperator: mergedOptions.seperator,
         squareBracketsForArray: mergedOptions.squareBracketsForArray,
         doubleQuotesForKeys: mergedOptions.doubleQuotesForKeys,
         doubleQuotesForValues: mergedOptions.doubleQuotesForValues,
@@ -216,8 +220,8 @@ function jsonToPlainText(data, options) {
     return handlers[getType(data)](data, false).replace(/}json-to-plain-text-special-string-(\d+){/g, (match, number) => {
         const space = parseInt(number, 10);
         return outputOptions.spacing
-            ? " ".repeat(indentLevel - space) + " : "
-            : " : ";
+            ? " ".repeat(indentLevel - space) + ` ${outputOptions.seperator} `
+            : ` ${outputOptions.seperator} `;
     });
 }
 exports.jsonToPlainText = jsonToPlainText;

dist/index.d.ts

@@ -1,6 +1,7 @@
 interface Options {
     color?: boolean;
     spacing?: boolean;
+    seperator?: string;
     squareBracketsForArray?: boolean;
     doubleQuotesForKeys?: boolean;
     doubleQuotesForValues?: boolean;
@@ -13,6 +14,7 @@ interface Options {
  * @param options {Options} - (Optional) Configuration options for customizing the output.
  *   - color {boolean} - Whether to apply colors to the output (default: true).
  *   - spacing {boolean} - Whether to include spacing after colons (default: true).
+ *   - seperator {string} -  seperator. Default ':',
  *   - squareBracketsForArray {boolean} - Whether to use square brackets for arrays (default: false).
  *   - doubleQuotesForKeys {boolean} - Whether to use double quotes for object keys (default: false).
  *   - doubleQuotesForValues {boolean} - Whether to use double quotes for string values (default: false).
@@ -23,6 +25,7 @@ interface Options {
  * const options = {
  *    color: true,
  *    spacing: true,
+ *    seperator?: "=";
  *    squareBracketsForArray: false,
  *    doubleQuotesForKeys: false,
  *    doubleQuotesForValues: false,
@@ -32,9 +35,9 @@ interface Options {
  *
  * // Output:
  * //
- * //   name : "John",
- * //   age : 30,
- * //   isEmployed : true
+ * //   name = "John",
+ * //   age = 30,
+ * //   isEmployed = true
  */
 declare function jsonToPlainText(data: unknown, options: Options): string;
-export { jsonToPlainText };
+export { jsonToPlainText, Options };