See details:

* Refactoring
* Adding preferences
* Fixing interactive interface
* Starting unit tests
* and more...

Author: atomicpages

.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+coverage/
+lib/vendor/

.eslintrc.js

@@ -0,0 +1,114 @@
+module.exports = {
+    "env": {
+        "es6": true,
+        "node": true,
+        "mocha": true
+    },
+    "plugins": [
+        "chai-expect",
+        "mocha",
+        "promise"
+    ],
+    "extends": "eslint:recommended",
+    "parserOptions": { "sourceType": "module" },
+    "rules": {
+        "indent": ["error", 4, { "SwitchCase": 1 }],
+        "linebreak-style": ["error", "unix"],
+        "semi": ["error", "always"],
+        "block-scoped-var": ["error"],
+        "class-methods-use-this": ["error"],
+        "curly": ["error", "all"],
+        "dot-location": ["error", "object"],
+        "dot-notation": ["error", { "allowKeywords": false }],
+        "eqeqeq": ["error", "always"],
+        "no-else-return": ["error"],
+        "no-eval": ["error"],
+        "no-extra-bind": ["error"],
+        "no-floating-decimal": ["error"], // 0.7, not .7
+        "no-global-assign": ["error"],
+        "no-implied-eval": ["error"],
+        "no-invalid-this": ["error"],
+        "no-labels": ["error"],
+        "no-lone-blocks": ["error"],
+        "no-loop-func": ["error"],
+        "no-multi-spaces": ["error"],
+        "no-multi-str": ["error"], // use template literals https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals
+        "no-new-func": ["error"],
+        "no-return-assign": ["error", "always"],
+        "no-proto": ["error"], // use getPrototypeOf()
+        "no-script-url": ["error"], // http://stackoverflow.com/questions/13497971/what-is-the-matter-with-script-targeted-urls
+        "no-sequences": ["error"],
+        "no-throw-literal": ["error"], // use throw new Error('message')
+        "no-useless-call": ["error"],
+        "no-useless-concat": ["error"],
+        "no-useless-escape": ["error"],
+        "no-useless-return": ["error"],
+        "no-shadow": ["error"],
+        "no-new-require": ["error"],
+        "no-use-before-define": ["error"],
+        "array-bracket-spacing": ["error", "never"],
+        "block-spacing": ["error", "always"],
+        "brace-style": ["error", "1tbs"],
+        "comma-dangle": ["error", "never"],
+        "comma-spacing": ["error", {
+            "before": false,
+            "after": true
+        }],
+        "no-case-declarations": 0,
+        "consistent-this": ["error", "self"],
+        "eol-last": ["error", "always"],
+        "func-call-spacing": ["error", "never"],
+        "key-spacing": ["error", {
+            "beforeColon": false,
+            "afterColon": true
+        }],
+        "keyword-spacing": ["error", {
+            "before": true,
+            "after": true
+        }],
+        "new-parens": ["error"],
+        "newline-before-return": ["error"],
+        "no-array-constructor": ["error"],
+        "no-lonely-if": ["error"],
+        "no-multiple-empty-lines": ["error", { "max": 2, "maxBOF": 0, "maxEOF": 1 }],
+        "no-nested-ternary": ["error"],
+        "no-new-object": ["error"],
+        "no-trailing-spaces": ["error"],
+        "no-unneeded-ternary": ["error"],
+        "no-whitespace-before-property": ["error"],
+        "operator-assignment": ["error", "always"],
+        "padded-blocks": ["error", {
+            "classes": "always",
+            "blocks": "never",
+            "switches": "never"
+        }],
+        "quotes": ["error", "single"],
+        "space-before-blocks": ["error", "always"],
+        "space-before-function-paren": ["error", {
+            "anonymous": "always",
+            "named": "never",
+            "asyncArrow": "ignore"
+        }],
+        "space-infix-ops": ["error", { "int32Hint": false }],
+        "space-unary-ops": [1, {
+            "words": true,
+            "nonwords": false
+        }],
+        "unicode-bom": ["error", "never"],
+        "arrow-body-style": ["error", "as-needed"],
+        "arrow-parens": ["error", "as-needed"],
+        "arrow-spacing": ["error", {
+            "before": true,
+            "after": true
+        }],
+        "generator-star-spacing": ["error", {
+            "before": true,
+            "after": false
+        }],
+        "no-class-assign": ["error"],
+        "no-console": ["off"],
+        "no-useless-computed-key": ["error"],
+        "no-useless-rename": ["error"],
+        "no-var": ["error"]
+    }
+};

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+	// Use IntelliSense to learn about possible Node.js debug attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Tests",
+            "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+            "stopOnEntry": true,
+            "args": ["test/*.test.js"],
+            "cwd": "${workspaceRoot}",
+            "runtimeExecutable": null
+		}
+	]
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,20 @@
+This code of conduct applies to all spaces of the Skeleton Sass project. This includes the issue tracker, DSF events and any other forums used by the project team which the community uses for communication. In addition, violations of this code outside these spaces may affect a person's ability to participate within them.
+
+If you believe someone is violating the code of conduct, we ask that you report it by emailing [email protected].
+
+* **Be friendly and patient.**
+* **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
+* **Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.
+* **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the Skeleton Sass community should be respectful when dealing with other members as well as with people outside the Skeleton Sass community.
+* **Be careful in the words that you choose.** We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to:
+    * Violent threats or language directed against another person.
+    * Discriminatory jokes and language.
+    * Posting sexually explicit or violent material.
+    * Posting (or threatening to post) other people's personally identifying information ("doxing").
+    * Personal insults, especially those using racist or sexist terms.
+    * Unwelcome sexual attention.
+    * Advocating for, or encouraging, any of the above behavior.
+    * Repeated harassment of others. In general, if someone asks you to stop, then stop.
+* **When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of Skeleton Sass comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
+
+Adopted from the [Django Code of Conduct](https://www.djangoproject.com/conduct/).

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+When contributing keep the following in mind:
+
+1. Do a search in issues to ensure as solution isn't already in progress
+2. Stick to the author's preferred code style
+3. Write unit tests for your feature/bug fix (80% minimum coverage)
+4. Write e2e tests
+5. Run linting and make sure it passes

README.md

@@ -95,6 +95,7 @@ Options:
                             setting
   --always-use-headers      Use this flag to persist column headers preferences
   --clear-settings, -c      Clear always-interactive settings
+  --quiet, -q               Silence console output    [boolean] [default: false]
   --help                    Show help                                  [boolean]
   --version                 Show version number                        [boolean]
 ```
@@ -148,7 +149,7 @@ We can define our tables two ways:
     ```
 
 ### Performance Notes
-By nature, some functions are substantially slower than others, specifically:
+By nature, some functions are considerably slower than others, for example:
 
 | Function | Time to Write 10K Rows by 100 Columns |
 | :---: | :---: |
@@ -168,7 +169,7 @@ by contrast, these functions are much faster:
 | `zip` | 2.579 |
 | `yn` | 0.706s |
 
-If you need to generate large amounts of data for _wide_ tables, it's recommended to use small pieces of data to speed up the process.
+If you need to generate large amounts of data for _wide_ tables, it's recommended to use fast functions.
 
 #### More Notes
 Instead of hundreds of async file writes (i.e. page faults), this generator uses a single stream to write content to the file. The trade-off is normal heap space, less CPU involvement, but more virtual memory used — memory is cheap; transistors aren't.
@@ -177,7 +178,7 @@ Instead of hundreds of async file writes (i.e. page faults), this generator uses
 This tool uses some scripts that are copyright of [Data Design Group Inc.](http://www.ddginc-usa.com/) For more information see the README file in `lib/vendor`.
 
 ### Developers
-Want to add a feature? Need to debug? The `readline` interface makes for cumbersome debugging, but node has our back:
+Want to add a feature? Have a useful generator? Need to debug? The `readline` interface makes for cumbersome debugging, but node has our back:
 
 ```bash
 node --inspect --inspect-brk index.js
@@ -194,3 +195,18 @@ open up Google Chrome and navigate to:
 ```
 chrome://inspect
 ```
+
+### Running Tests
+To run unit tests:
+
+```bash
+npm run test # or
+yarn test
+```
+
+To run e2e tests:
+
+```bash
+npm run e2e # or
+yarn e2e
+```

bin/gencsv

@@ -3,9 +3,9 @@
 const fs = require('fs');
 const path = require('path');
 const chalk = require('chalk');
-const _ = require('lodash/string')
 
 const Utils = require('../lib/utils');
+const Preferences = require('../lib/preferences');
 const generator = require('../lib/generator');
 
 const argv = require('yargs')
@@ -48,6 +48,12 @@ const argv = require('yargs')
         'clear-settings': {
             alias: 'c',
             describe: 'Clear always-interactive settings'
+        },
+        quiet: {
+            alias: 'q',
+            describe: 'Silence console output',
+            boolean: true,
+            default: false
         }
     })
     .help()
@@ -63,43 +69,41 @@ if (argv.functions) {
 if (argv.c) {
     console.log('Removing settings...');
 
-    try {
-        fs.unlinkSync(path.resolve(Utils.home(), '.gencsv'));
-        console.log(`Successfully removed ${chalk.cyan(path.resolve(Utils.home(), '.gencsv'))}`);
+    Preferences.truncate(
+        () => {
+            console.log(`Successfully removed ${chalk.cyan(Preferences.file())}`);
 
-        if (argv._.length <= 1) {
-            process.exit(0);
+            if (argv._.length <= 1) {
+                process.exit(0);
+            }
+        },
+        () => {
+            console.log(`Error removing ${chalk.redBright(Preferences.file())}`);
+            console.log('Attempting to run command...\n');
         }
-    } catch (e) {
-        console.log(`Error removing ${chalk.redBright(path.resolve(Utils.home(), '.gencsv'))}`);
-        console.log('Attempting to run command...\n');
-    }
+    )
 }
 
-if (Utils.isInteractive() || argv.i) {
+if (Preferences.isInteractive() || argv.i) {
     require('../index');
     return;
 }
 
 if (argv.a) {
-    fs.writeFile(path.resolve(Utils.home(), '.gencsv'), '{ "interactive": true }', err => {
-        if (err) {
-            throw new Error(err);
-        }
-
-        console.log(`Settings written to ${chalk.cyan(path.resolve(Utils.home(), '.gencsv'))}`);
+    Preferences.save('interactive', true, () => {
+        console.log(`Settings written to ${chalk.cyan(Preferences.file())}`);
         setTimeout(() => require('../index'), 500);
     });
 
     return;
 }
 
 if (argv._.length <= 1 && process.stdin.isTTY) {
-    console.log(chalk.redBright('You must define an output file name and at least one column!'));
+    console.log(chalk.redBright('You must define an output file name and at least one column definition!'));
     process.exit(1);
 }
 
-if (Utils.alwaysUseHeaders()) {
+if (Preferences.alwaysUseHeaders()) {
     argv['use-headers'] = true;
 }
 
@@ -108,26 +112,12 @@ let columns = argv._.slice(1);
 let rows = 100;
 
 if (argv.r !== 100) {
-    if (/^\d+(\.\d*)?(K|M|B)$/.test(argv.r)) {
-        let r = argv.r.toLowerCase().trim();
-
-        if (_.endsWith(r, 'k')) {
-            rows = parseFloat(r) * 1000;
-        } else if (_.endsWith(r, 'm')) {
-            rows = parseFloat(r) * 10 ** 6;
-        } else if (_.endsWith(r, 'b')) {
-            rows = parseFloat(r) * 10 ** 9;
-        }
-    } else {
-        if (!/[1-9]\d*/.test(argv.r)) {
-            console.log(chalk.redBright('Invalid row number'));
-            process.exit(1);
-        }
-
-        rows = parseInt(argv.r);
+    try {
+        rows = Utils.convertNumber(argv.r);
+    } catch (e) {
+        console.log(chalk.redBright('Invalid row number'));
+        process.exit(1);
     }
-
-    rows = Math.ceil(rows); // drop decimals if any
 }
 
 if (columns.length === 0) {
@@ -143,7 +133,9 @@ if (columns.length === 0) {
         data += line;
         data += '\n';
     }).on('close', () => {
-        console.log('Columns definitions received! Validating...');
+        if (!argv.q) {
+            console.log('Columns definitions received! Validating...');
+        }
 
         let lines = data.split('\n');
         let headers = '';
@@ -155,22 +147,18 @@ if (columns.length === 0) {
             columns = lines[0].split(/\s*,\s*/);
         }
 
-        generate(outFile, columns, {
+        Utils.generate(outFile, columns, {
             rows: rows,
             chunks: argv.chunk,
-            headers: argv['use-headers'] || headers.length > 0
+            headers: argv['use-headers'] || headers.length > 0,
+            quiet: argv.quiet
         }, headers.split(/\s*,\s*/));
     });
 } else {
-    generate(outFile, columns, {
+    Utils.generate(outFile, columns, {
         rows: rows,
         chunks: argv.chunk,
-        headers: argv['use-headers']
-    });
-}
-
-function generate(file, columns, options, headers) {
-    generator(file, columns, options, headers).then(() => {
-        process.exit(0);
+        headers: argv['use-headers'],
+        quiet: argv.quiet
     });
 }