Merge pull request #233 from mrodrig/tsify

Migrate to TypeScript

Author: mrodrig

.eslintrc

@@ -0,0 +1,52 @@
+module.exports = {
+    root: true,
+    env: {
+        es2022: true,
+        node: true,
+        mocha: true,
+    },
+    parserOptions: {
+        ecmaVersion: 13,
+        project: ['tsconfig.json'],
+        sourceType: 'module',
+        tsconfigRootDir: __dirname,
+    },
+    extends: [
+        'eslint:recommended',
+        'plugin:import/errors',
+        'plugin:import/warnings',
+        'plugin:import/typescript',
+        'plugin:@typescript-eslint/recommended',
+    ],
+    parser: '@typescript-eslint/parser',
+    ignorePatterns: [
+        '/lib/**/*', // Ignore built files.
+    ],
+    plugins: [
+        '@typescript-eslint',
+        'import',
+    ],
+    rules: {
+        // Basic ES6
+        indent: [
+            'error', 4, { // use 4 spaces for indents
+                'SwitchCase': 1, // indent case within switch
+            }
+        ],
+        'linebreak-style': 0, // mixed environment let git config enforce line endings
+        quotes: ['error', 'single'],
+        semi: ['error', 'always'],
+        'no-var': 'error',
+        'no-console': 0, // allow use of console.log,
+        'arrow-body-style': [0, 'always'],
+        'max-len': 0,
+        'camelcase': 1,
+        'import/no-unresolved': [
+            'error', {
+                // https://github.com/firebase/firebase-admin-node/discussions/1359
+                ignore: ['^firebase-admin/.+'],
+            },
+        ],
+        '@typescript-eslint/consistent-type-definitions': 'warn'
+    },
+};

.eslintrc.js

@@ -10,3 +10,6 @@ node_modules
 
 # Debug logs
 npm-debug.log
+
+# Built JavaScript files
+lib

.gitignore

@@ -1,12 +1,30 @@
-test/
-.git*
+# Debug Logs
 npm-debug.log
-.travis.yml
-.eslintrc
-node_modules
-coverage
+
+# Uncompiled Source Files
+src
+test
+
+# Node Modules
+node_modules/
+node_modules/*
+
+# Configuration Files
+.eslintrc*
+tsconfig*
+
+# Test/Coverage Files
+coverage/
+coverage/*
+.nycrc
 .nyc_output
-upgrade_guides
-tslint.json
-_config.yml
+.nyc_output/*
 .coveralls.yml
+lib/test
+
+# Github Configuration Files
+_config.yml
+.git*
+
+# Extra documentation files
+upgrade_guides/*

.npmignore

@@ -0,0 +1,16 @@
+{
+    "check-coverage": true,
+    "all": true,
+    "include": [
+        "src/**/!(*.test.*).[tj]s?(x)"
+    ],
+    "exclude": [
+        "test/**/*.*"
+    ],
+    "reporter": [
+        "lcov",
+        "text-summary",
+        "text"
+    ],
+    "report-dir": "coverage"
+}

.nycrc

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2020 Michael Rodrigues
+Copyright (c) 2014-Present Michael Rodrigues
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

.travis.yml

@@ -1,15 +1,14 @@
 # json-2-csv
 **Convert JSON to CSV _or_ CSV to JSON**
 
-[![Dependencies](https://img.shields.io/librariesio/release/npm/json-2-csv)](https://www.npmjs.org/package/json-2-csv)
-[![Downloads](https://img.shields.io/npm/dm/json-2-csv.svg)](https://www.npmjs.org/package/json-2-csv)
 [![NPM version](https://img.shields.io/npm/v/json-2-csv.svg)](https://www.npmjs.org/package/json-2-csv)
+[![Typings](https://img.shields.io/npm/types/json-2-csv)](https://www.npmjs.org/package/json-2-csv)
+[![Downloads](https://img.shields.io/npm/dm/json-2-csv.svg)](https://www.npmjs.org/package/json-2-csv)
 [![Minzipped Size](https://img.shields.io/bundlephobia/minzip/json-2-csv)](https://bundlephobia.com/result?p=json-2-csv)
 
 [![Build Status](https://travis-ci.org/mrodrig/json-2-csv.svg?branch=master)](https://travis-ci.org/mrodrig/json-2-csv)
 [![Coverage Status](https://coveralls.io/repos/github/mrodrig/json-2-csv/badge.svg?branch=stable)](https://coveralls.io/github/mrodrig/json-2-csv?branch=stable)
 [![Maintainability](https://api.codeclimate.com/v1/badges/8c0cc3699d054fb77abe/maintainability)](https://codeclimate.com/github/mrodrig/json-2-csv/maintainability)
-[![Typings](https://img.shields.io/npm/types/json-2-csv)](https://www.npmjs.org/package/json-2-csv)
 
 This node module will convert an array of JSON documents to a CSV string.
 Column headings will be automatically generated based on the keys of the JSON documents. Nested documents will have a '.' appended between the keys.
@@ -30,12 +29,13 @@ $ npm install @mrodrig/json-2-csv-cli
 
 ## Upgrading?
 
-Upgrading to v3 from v2? Check out the [upgrade guide](https://github.com/mrodrig/json-2-csv/blob/master/upgrade_guides/UPGRADE_2_to_3.md).
+Upgrading to v4 from v3? Check out the [upgrade guide](https://github.com/mrodrig/json-2-csv/blob/master/upgrade_guides/UPGRADE_3_to_4.md).
 
 ## Usage
 
 ```javascript
 let converter = require('json-2-csv');
+const csv = await converter.json2csv(data, options);
 ```
 or
 ```javascript
@@ -45,11 +45,9 @@ Looking for examples? Check out the Wiki: [json-2-csv Wiki](https://github.com/m
 
 ### API
 
-#### `converter.json2csv(array, callback, options)`
+#### `json2csv(array, options)`
 
 * `array` - An array of JSON documents to be converted to CSV.
-* `callback` - A function of the form `function (err, csv)`; 
-  * This function will receive any errors and/or the string of CSV generated.
 * `options` - (Optional) A JSON document specifying any of the following key value pairs:
   * `checkSchemaDifferences` - Boolean - Should all documents have the same schema?
     * Default: `false`
@@ -146,14 +144,9 @@ Looking for examples? Check out the Wiki: [json-2-csv Wiki](https://github.com/m
 
 For examples, please refer to the [json2csv API Documentation (Link)](https://github.com/mrodrig/json-2-csv/wiki/json2csv-Documentation)
 
-#### Promisified Version: `converter.json2csvAsync(array, options)`
-
-Available in version `2.2.0`, this functionality makes use of promises from the `bluebird` module.
-
-#### `converter.csv2json(csv, callback, options)`
+#### `csv2json(csv, options)`
 
 * `csv` - A string of CSV
-* `callback` - A function of the form `function (err, array)`; This function will receive any errors and/or the array of JSON documents generated.
 * `options` - (Optional) A JSON document specifying any of the following key value pairs:
   * `delimiter` - Document - Specifies the different types of delimiters
     * `field` - String - Field Delimiter. 
@@ -181,10 +174,6 @@ Available in version `2.2.0`, this functionality makes use of promises from the
 
 For examples, please refer to the [csv2json API Documentation (Link)](https://github.com/mrodrig/json-2-csv/wiki/csv2json-Documentation)
 
-#### Promisified Version: `csv2jsonAsync(csv, options)`
-
-Available in version `2.2.0`, this functionality makes use of promises from the `bluebird` module.
-
 ### CLI
 Note: As of `3.5.8`, the command line interface functionality has been pulled out to a separate package. Please be sure to
 install the `@mrodrig/json-2-csv-cli` NPM package if you wish to use the CLI functionality shown below:
@@ -244,14 +233,6 @@ To see test coverage, please run:
 $ npm run coverage
 ```
 
-Current Coverage is:
-```
-Statements   : 100% ( 286/286 )
-Branches     : 100% ( 166/166 )
-Functions    : 100% ( 73/73 )
-Lines        : 100% ( 280/280 )
-```
-
 ## Frequently Asked Questions (FAQ)
 Please find the updated list (relocated to the Wiki) here: [Frequently Asked Questions (Link)](https://github.com/mrodrig/json-2-csv/wiki/FAQ)