Merge pull request #312 from C2FO/v4.0.0-rc

V4.0.0

Author: doug-martin

.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
     parser: "@typescript-eslint/parser",
     parserOptions: {
-        project: "./tsconfig.json"
+        project: "./tsconfig.build.json"
     },
     plugins: ["@typescript-eslint", "prettier"],
     extends: [
@@ -14,8 +14,9 @@ module.exports = {
     ],
     env: {
         node: true,
-        mocha: true,
+        jest: true,
     },
+    ignorePatterns: ["**/build", "**/node_modules"],
     settings:{
         "import/extensions": [
             ".ts"
@@ -51,6 +52,8 @@ module.exports = {
             4,
             { "SwitchCase": 1 }
         ],
+        "import/prefer-default-export": 0,
+        "import/no-default-export": ["error"],
         "no-restricted-syntax": ["error", "ForInStatement", "LabeledStatement", "WithStatement"],
         "object-curly-spacing": ["error", "always"],
         "no-underscore-dangle": 0,
@@ -65,7 +68,7 @@ module.exports = {
     overrides: [
         {
             "files": [
-                "*.test.ts"
+                "*.spec.ts"
             ],
             "rules": {
                 "@typescript-eslint/explicit-function-return-type": "off",
@@ -74,7 +77,8 @@ module.exports = {
         },
         {
             "files": [
-                "*.js"
+                "*.js",
+                "examples/example-runner/bin/run-examples"
             ],
             "rules": {
                 "@typescript-eslint/explicit-function-return-type": "off",

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,6 +10,11 @@ assignees: doug-martin, dustinsmith1024
 **Describe the bug**
 A clear and concise description of what the bug is.
 
+**Parsing or Formatting?**
+
+ - [ ] Formatting
+ - [ ] Parsing 
+
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Example file contents if applicable

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,6 +7,11 @@ assignees: doug-martin, dustinsmith1024
 
 ---
 
+**Parsing or Formatting?**
+
+ - [ ] Formatting
+ - [ ] Parsing 
+
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 

.gitignore

@@ -5,5 +5,7 @@ node_modules
 benchmark/results
 .nyc_output
 build
-**/tmp
-coverage
+coverage
+**/*.tmp.csv
+**/*.tsbuildinfo
+lerna-debug.log

.mocharc.js

@@ -4,4 +4,9 @@ node_js:
   - "10"
   - "8"
 
+script:
+  - npm run bootstrap
+  - npm run build
+  - npm run test
+
 after_success: npm run coverage

.nycrc

@@ -1,3 +1,14 @@
+# v4.0.0
+
+* Migrated from mocha to jest
+* Moved to `lerna`.
+    * Split `parse` and `format` packages
+* Added running examples and checking output as part of the tests
+* Updated docs for new directory layout
+* Added typescript examples
+* Added generics type support to format and parse streams
+* [ADDED] Docs around using `strictColumnHandling` to emit errors when there are more columns than headers [#195]
+
 # v3.7.0
 
 * [ADDED] Ability to Transform Header [#287](https://github.com/C2FO/fast-csv/issues/287)

.travis.yml

@@ -7,54 +7,33 @@
 
 Fast-csv is library for parsing and formatting csvs or any other delimited value file in node. 
 
-## Installation
+## Packages
 
-`npm install -S fast-csv`
+There are three packages published from this repo.
 
-## Usage
+### [`fast-csv`](./packages/fast-csv)
 
-To use `fast-csv` in `javascript` you can require the module/
+Exposes both formatting and parsing methods in a single package, use this if you need to parse and format files.
 
-```js
-const csv = require('fast-csv');
-```
+* [Docs](./packages/fast-csv/README.md)
+* [JavaScript Examples](./examples/fast-csv-js/README.md)
+* [TypeScript Examples](./examples/fast-csv-ts/README.md)
 
-To import with typescript 
+###[`@fast-csv/parse`](./packages/parse)
 
-```typescript
-import * as csv from 'fast-csv';
-```
+Parsing package, use this if you only need to parse files.
 
-## Documentation
+* [Docs](./packages/parse/README.md)
+* [JavaScript Examples](./examples/parsing-js/README.md)
+* [TypeScript Examples](./examples/parsing-ts/README.md)
 
-* [Parsing Docs](./docs/parsing.md)
-* [Formatting Docs](./docs/formatting.md)
+### [`@fast-csv/format`](./packages/format) 
 
-### Quick Examples
-
-**parsing** 
-
-To read a csv with headers create a read stream and pipe it to parser.
-
-```javascript
-fs.createReadStream('path/to/my.csv')
-  .pipe(csv.parse({ headers: true }))
-  .on('data', row => console.log(row))
-```
-
-For more in depth parsing examples and docs check out the [parsing docs](./docs/parsing.md)
-
-**formatting**
-
-To format a csv you can write rows to a formatter.
-
-```javascript
-someStream
-  .pipe(csv.format({ headers: true })
-  .pipe(process.stdout);
-```
-
-For more in depth formatting examples and docs check out the [formatting docs](./docs/formatting.md)
+Formatting package, use this if you only need to format files.
+    
+* [Docs](./packages/format/README.md)
+* [JavaScript Examples](./examples/formatting-js/README.md)
+* [TypeScript Examples](./examples/formatting-ts/README.md)
 
 ### Migrating from older versions
 
@@ -70,3 +49,4 @@ MIT <https://github.com/C2FO/fast-csv/raw/master/LICENSE>
 * Twitter: [http://twitter.com/c2fo](http://twitter.com/c2fo) - 877.465.4045
 
 
+