-
-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ADDED: - Get ready for the rewrite in ES6. - Moved from JSHint to ESLint - Uses the babel-boilerplate generator to scaffold files for the module Test GPG signing More eslint rules and contributing guide Add test folder Add badges, CI config and coverage push to coveralls Add flow type checking config Turn off some checks for ESLint and Flow needs node_modules Add new task for checking code with flow Fix chai should not working properly globally Add CHANGELOG.md Add basic source file Added more JSDoc information to source - Added more JSDoc info for options object parameters - Updated README Fix failing build Plugin configuration was wrong and babel-eslint plugin was outdated. Fixed in commit. Build was failing due to few formatting errors. Fixed in commit.
- Loading branch information
1 parent
e733113
commit 2bb6f3d
Showing
24 changed files
with
750 additions
and
277 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "plugins": [ | ||
| "transform-flow-strip-types" | ||
| ], | ||
| "presets": ["es2015"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # EditorConfig is awesome: http://EditorConfig.org | ||
|
|
||
| root = true; | ||
|
|
||
| [*] | ||
| # Ensure there's no lingering whitespace | ||
| trim_trailing_whitespace = true | ||
| # Ensure a newline at the end of each file | ||
| insert_final_newline = true | ||
|
|
||
| [*.js] | ||
| # Unix-style newlines | ||
| end_of_line = lf | ||
| charset = utf-8 | ||
| indent_style = space | ||
| indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| { | ||
| "parser": "babel-eslint", | ||
| "plugins": [ | ||
| "flow-vars" | ||
| ], | ||
| "rules": { | ||
| "comma-dangle": 2, // disallow or enforce trailing commas | ||
| "no-cond-assign": 2, // disallow assignment in conditional expressions | ||
| "no-console": 1, // disallow use of console (off by default in the node environment) | ||
| "no-constant-condition": 2, // disallow use of constant expressions in conditions | ||
| "no-control-regex": 2, // disallow control characters in regular expressions | ||
| "no-debugger": 2, // disallow use of debugger | ||
| "no-dupe-args": 2, // disallow duplicate arguments in functions | ||
| "no-dupe-keys": 2, // disallow duplicate keys when creating object literals | ||
| "no-duplicate-case": 2, // disallow a duplicate case label. | ||
| "no-empty": 2, // disallow empty statements | ||
| "no-ex-assign": 2, // disallow assigning to the exception in a catch block | ||
| "no-extra-boolean-cast": 2, // disallow double-negation boolean casts in a boolean context | ||
| "no-extra-parens": 0, // disallow unnecessary parentheses (off by default) | ||
| "no-extra-semi": 2, // disallow unnecessary semicolons | ||
| "no-func-assign": 2, // disallow overwriting functions written as function declarations | ||
| "no-inner-declarations": 2, // disallow function or variable declarations in nested blocks | ||
| "no-invalid-regexp": 2, // disallow invalid regular expression strings in the RegExp constructor | ||
| "no-irregular-whitespace": 2, // disallow irregular whitespace outside of strings and comments | ||
| "no-negated-in-lhs": 2, // disallow negation of the left operand of an in expression | ||
| "no-obj-calls": 2, // disallow the use of object properties of the global object (Math and JSON) as functions | ||
| "no-regex-spaces": 2, // disallow multiple spaces in a regular expression literal | ||
| "no-sparse-arrays": 2, // disallow sparse arrays | ||
| "no-unreachable": 2, // disallow unreachable statements after a return, throw, continue, or break statement | ||
| "use-isnan": 2, // disallow comparisons with the value NaN | ||
| "valid-jsdoc": 2, // Ensure JSDoc comments are valid (off by default) | ||
| "valid-typeof": 2, // Ensure that the results of typeof are compared against a valid string | ||
| "block-scoped-var": 0, // treat var statements as if they were block scoped (off by default). 0: deep destructuring is not compatible https://github.com/eslint/eslint/issues/1863 | ||
| "complexity": 0, // specify the maximum cyclomatic complexity allowed in a program (off by default) | ||
| "consistent-return": 0, // require return statements to either always or never specify values | ||
| "curly": 2, // specify curly brace conventions for all control statements | ||
| "default-case": 2, // require default case in switch statements (off by default) | ||
| "dot-notation": 2, // encourages use of dot notation whenever possible | ||
| "eqeqeq": 2, // require the use of === and !== | ||
| "guard-for-in": 2, // make sure for-in loops have an if statement (off by default) | ||
| "no-alert": 2, // disallow the use of alert, confirm, and prompt | ||
| "no-caller": 2, // disallow use of arguments.caller or arguments.callee | ||
| "no-div-regex": 2, // disallow division operators explicitly at beginning of regular expression (off by default) | ||
| "no-else-return": 2, // disallow else after a return in an if (off by default) | ||
| "no-eq-null": 2, // disallow comparisons to null without a type-checking operator (off by default) | ||
| "no-eval": 2, // disallow use of eval() | ||
| "no-extend-native": 2, // disallow adding to native types | ||
| "no-extra-bind": 2, // disallow unnecessary function binding | ||
| "no-fallthrough": 2, // disallow fallthrough of case statements | ||
| "no-floating-decimal": 2, // disallow the use of leading or trailing decimal points in numeric literals (off by default) | ||
| "no-implied-eval": 2, // disallow use of eval()-like methods | ||
| "no-iterator": 2, // disallow usage of __iterator__ property | ||
| "no-labels": 2, // disallow use of labeled statements | ||
| "no-lone-blocks": 2, // disallow unnecessary nested blocks | ||
| "no-loop-func": 2, // disallow creation of functions within loops | ||
| "no-multi-spaces": 2, // disallow use of multiple spaces | ||
| "no-multi-str": 2, // disallow use of multiline strings | ||
| "no-native-reassign": 2, // disallow reassignments of native objects | ||
| "no-new": 2, // disallow use of new operator when not part of the assignment or comparison | ||
| "no-new-func": 2, // disallow use of new operator for Function object | ||
| "no-new-wrappers": 2, // disallows creating new instances of String,Number, and Boolean | ||
| "no-octal": 2, // disallow use of octal literals | ||
| "no-octal-escape": 2, // disallow use of octal escape sequences in string literals, such as var foo = "Copyright \251"; | ||
| "no-param-reassign": 0, // disallow reassignment of function parameters (off by default) | ||
| "no-process-env": 2, // disallow use of process.env (off by default) | ||
| "no-proto": 2, // disallow usage of __proto__ property | ||
| "no-redeclare": 2, // disallow declaring the same variable more then once | ||
| "no-return-assign": 2, // disallow use of assignment in return statement | ||
| "no-script-url": 2, // disallow use of javascript: urls. | ||
| "no-self-compare": 2, // disallow comparisons where both sides are exactly the same (off by default) | ||
| "no-sequences": 2, // disallow use of comma operator | ||
| "no-throw-literal": 2, // restrict what can be thrown as an exception (off by default) | ||
| "no-unused-expressions": 2, // disallow usage of expressions in statement position | ||
| "no-void": 2, // disallow use of void operator (off by default) | ||
| "no-warning-comments": [0, {"terms": ["todo", "fixme"], "location": "start"}], // disallow usage of configurable warning terms in comments": 2, // e.g. TODO or FIXME (off by default) | ||
| "no-with": 2, // disallow use of the with statement | ||
| "radix": 2, // require use of the second argument for parseInt() (off by default) | ||
| "vars-on-top": 2, // requires to declare all vars on top of their containing scope (off by default) | ||
| "wrap-iife": 2, // require immediate function invocation to be wrapped in parentheses (off by default) | ||
| "yoda": 2, // require or disallow Yoda conditions | ||
| "strict": 0, // controls location of Use Strict Directives. 0: required by `babel-eslint` | ||
| "no-catch-shadow": 2, // disallow the catch clause parameter name being the same as a variable in the outer scope (off by default in the node environment) | ||
| "no-delete-var": 2, // disallow deletion of variables | ||
| "no-label-var": 2, // disallow labels that share a name with a variable | ||
| "no-shadow": 2, // disallow declaration of variables already declared in the outer scope | ||
| "no-shadow-restricted-names": 2, // disallow shadowing of names such as arguments | ||
| "no-undef": 2, // disallow use of undeclared variables unless mentioned in a /*global */ block | ||
| "no-undef-init": 2, // disallow use of undefined when initializing variables | ||
| "no-undefined": 2, // disallow use of undefined variable (off by default) | ||
| "no-unused-vars": 2, // disallow declaration of variables that are not used in the code | ||
| "no-use-before-define": 2, // disallow use of variables before they are defined | ||
| "indent": [1, 2], // this option sets a specific tab width for your code (off by default) | ||
| "brace-style": 1, // enforce one true brace style (off by default) | ||
| "camelcase": 1, // require camel case names | ||
| "comma-spacing": [1, {"before": false, "after": true}], // enforce spacing before and after comma | ||
| "comma-style": [1, "last"], // enforce one true comma style (off by default) | ||
| "consistent-this": [1, "_this"], // enforces consistent naming when capturing the current execution context (off by default) | ||
| "eol-last": 1, // enforce newline at the end of file, with no multiple empty lines | ||
| "func-names": 0, // require function expressions to have a name (off by default) | ||
| "func-style": 0, // enforces use of function declarations or expressions (off by default) | ||
| "key-spacing": [1, {"beforeColon": false, "afterColon": true}], // enforces spacing between keys and values in object literal properties | ||
| "max-nested-callbacks": [1, 3], // specify the maximum depth callbacks can be nested (off by default) | ||
| "new-cap": [1, {newIsCap: true, capIsNew: false}], // require a capital letter for constructors | ||
| "new-parens": 1, // disallow the omission of parentheses when invoking a constructor with no arguments | ||
| "newline-after-var": 0, // allow/disallow an empty newline after var statement (off by default) | ||
| "no-array-constructor": 1, // disallow use of the Array constructor | ||
| "no-inline-comments": 1, // disallow comments inline after code (off by default) | ||
| "no-lonely-if": 1, // disallow if as the only statement in an else block (off by default) | ||
| "no-mixed-spaces-and-tabs": 1, // disallow mixed spaces and tabs for indentation | ||
| "no-multiple-empty-lines": [1, {"max": 2}], // disallow multiple empty lines (off by default) | ||
| "no-nested-ternary": 1, // disallow nested ternary expressions (off by default) | ||
| "no-new-object": 1, // disallow use of the Object constructor | ||
| "no-spaced-func": 1, // disallow space between function identifier and application | ||
| "no-ternary": 0, // disallow the use of ternary operators (off by default) | ||
| "no-trailing-spaces": 1, // disallow trailing whitespace at the end of lines | ||
| "no-underscore-dangle": 0, // disallow dangling underscores in identifiers | ||
| "one-var": [1, "never"], // allow just one var statement per function (off by default) | ||
| "operator-assignment": [1, "never"], // require assignment operator shorthand where possible or prohibit it entirely (off by default) | ||
| "padded-blocks": [1, "never"], // enforce padding within blocks (off by default) | ||
| "quote-props": [1, "as-needed"], // require quotes around object literal property names (off by default) | ||
| "quotes": [1, "single"], // specify whether double or single quotes should be used | ||
| "semi": [1, "always"], // require or disallow use of semicolons instead of ASI | ||
| "semi-spacing": [1, {"before": false, "after": true}], // enforce spacing before and after semicolons | ||
| "sort-vars": 0, // sort variables within the same declaration block (off by default) | ||
| "keyword-spacing": 2, // require a space after certain keywords (off by default) | ||
| "space-before-blocks": [1, "always"], // require or disallow space before blocks (off by default) | ||
| "space-before-function-paren": [1, {"anonymous": "always", "named": "never"}], // require or disallow space before function opening parenthesis (off by default) | ||
| "space-in-parens": [1, "never"], // require or disallow spaces inside parentheses (off by default) | ||
| "space-unary-ops": [1, {"words": true, "nonwords": false}], // Require or disallow spaces before/after unary operators (words on by default, nonwords off by default) | ||
| "wrap-regex": 0, // require regex literals to be wrapped in parentheses (off by default) | ||
| "no-var": 2, // require let or const instead of var (off by default) | ||
| "generator-star-spacing": [2, "before"], // enforce the spacing around the * in generator functions (off by default) | ||
| "max-depth": [2, 3], // specify the maximum depth that blocks can be nested (off by default) | ||
| "max-len": [2, 100, 2], // specify the maximum length of a line in your program (off by default) | ||
| "max-params": [2, 5], // limits the number of parameters that can be used in the function declaration. (off by default) | ||
| "max-statements": 0, // specify the maximum number of statement allowed in a function (off by default) | ||
| "no-bitwise": 0, // disallow use of bitwise operators (off by default) | ||
| "no-plusplus": 2, // disallow use of unary operators, ++ and -- (off by default), | ||
| "flow-vars/define-flow-type": 1, | ||
| "flow-vars/use-flow-type": 1 | ||
| }, | ||
| "env": { | ||
| "browser": true, | ||
| "node": true | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| [ignore] | ||
| .*/node_modules/gulp-flowtype/* | ||
|
|
||
| [include] | ||
|
|
||
| [libs] | ||
| flow-typed | ||
|
|
||
| [options] | ||
| suppress_comment= \\(.\\|\n\\)*\\$FlowExpectedError | ||
|
|
||
| [version] | ||
| >=0.23 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Logs | ||
| logs | ||
| *.log | ||
|
|
||
| # Runtime data | ||
| pids | ||
| *.pid | ||
| *.seed | ||
|
|
||
| # Directory for instrumented libs generated by jscoverage/JSCover | ||
| lib-cov | ||
|
|
||
| # Coverage directory used by tools like istanbul | ||
| coverage | ||
|
|
||
| # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) | ||
| .grunt | ||
|
|
||
| # Compiled binary addons (http://nodejs.org/api/addons.html) | ||
| build/Release | ||
|
|
||
| # Dependency directory | ||
| # Commenting this out is preferred by some people, see | ||
| # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- | ||
| node_modules | ||
| bower_components | ||
| coverage | ||
| tmp | ||
|
|
||
| # Users Environment Variables | ||
| .lock-wscript |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,10 @@ | ||
| language: node_js | ||
| node_js: | ||
| - '5' | ||
| - '4' | ||
| - '0.12' | ||
| - '0.10' | ||
| - '0.12' | ||
| - '4' | ||
| - '5' | ||
| sudo: false | ||
| notifications: | ||
| email: | ||
| on_success: always | ||
| on_failure: always | ||
| script: "gulp coverage" | ||
| after_success: | ||
| - cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ### [1.0.0](https://github.com/riyadhalnur/node-base64-image/releases/tag/v1.0.0) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk: | ||
|
|
||
| So, you want to contribute to this project! That's awesome. However, before | ||
| doing so, please read the following simple steps how to contribute. This will | ||
| make the life easier and will avoid wasting time on things which are not | ||
| requested. :sparkles: | ||
|
|
||
| ## Discuss the changes before doing them | ||
| - First of all, open an issue in the repository, using the [bug tracker][1], | ||
| describing the contribution you would like to make, the bug you found or any | ||
| other ideas you have. This will help us to get you started on the right | ||
| foot. | ||
|
|
||
| - If it makes sense, add the platform and software information (e.g. operating | ||
| system, Node.JS version etc.), screenshots (so we can see what you are | ||
| seeing). | ||
|
|
||
| - It is recommended to wait for feedback before continuing to next steps. | ||
| However, if the issue is clear (e.g. a typo) and the fix is simple, you can | ||
| continue and fix it. | ||
|
|
||
| ## Fixing issues | ||
| - Fork the project in your account and create a branch with your fix: | ||
| `some-great-feature` or `some-issue-fix`. | ||
|
|
||
| - Commit your changes in that branch, writing the code following the | ||
| style used in this module. If the project contains tests (generally, the `test` | ||
| directory), you are encouraged to add a test as well. :memo: | ||
|
|
||
| - If the project contains a `package.json` or a `bower.json` file add yourself | ||
| in the `contributors` array (or `authors` in the case of `bower.json`; | ||
| if the array does not exist, create it): | ||
|
|
||
| ```json | ||
| { | ||
| "contributors": [ | ||
| "Your Name <and@email.address> (http://your.website)" | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Creating a pull request | ||
|
|
||
| - Open a pull request, and reference the initial issue in the pull request | ||
| message (e.g. *fixes #<your-issue-number>*). Write a good description and | ||
| title, so everybody will know what is fixed/improved. | ||
|
|
||
| - If it makes sense, add screenshots, gifs etc., so it is easier to see what | ||
| is going on. | ||
|
|
||
| ## Wait for feedback | ||
| Before accepting your contributions, we will review them. You may get feedback | ||
| about what should be fixed in your modified code. If so, just keep committing | ||
| in your branch and the pull request will be updated automatically. | ||
|
|
||
| ## Everyone is happy! | ||
| Finally, your contributions will be merged, and everyone will be happy! :smile: | ||
| Contributions are more than welcome! | ||
|
|
||
| Thanks! :sweat_smile: | ||
|
|
||
|
|
||
| [1]: https://github.com/riyadhalnur/node-base64-image/issues | ||
|
|
||
| *Generated using [Blah](https://www.npmjs.com/package/blah)* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.