voca - npm Package Compare versions

Comparing version 0.0.1 to 1.0.0-alpha.0

package.json

 {
   "name": "voca",
-  "version": "0.0.1",
-  "description": "Coming soon...",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "1.0.0-alpha.0",
+  "description": "The ultimate JavaScript string library",
+  "homepage": "https://vocajs.com",
+  "author": {
+    "name": "Dmitri Pavlutin",
+    "email": "[e-mail]",
+    "url": "https://rainsoft.io/about-me/"
   },
+  "license": "MIT",
+  "keywords": [
+    "voca",
+    "string",
+    "sprintf",
+    "util"
+  ],
   "repository": {
@@ -13,8 +22,64 @@ "type": "git",
   },
-  "author": "Dmitri Pavlutin",
-  "license": "MIT",
   "bugs": {
-    "url": "https://github.com/panzerdp/voca/issues"
+    "url": "https://github.com/panzerdp/voca/issues",
+    "email": "[e-mail]"
   },
-  "homepage": "https://github.com/panzerdp/voca#readme"
+  "main": "index.js",
+  "scripts": {
+    "eslint": "eslint . --ext .js",
+
+    "build": "npm run build-dist && npm run build-npm-package",
+      "build-dist": "rollup -c config/rollup_dist.js && rollup -c config/rollup_dist_min.js && rollup -c config/rollup_test.js",
+      "build-npm-package": "rm -rf dist_mod && mkdir dist_mod && cp package.json README.md ./dist_mod && rollup -c config/rollup_dist_mod.js && node config/transform.js",
+
+    "test": "mocha test/index.js --reporter dot",
+    "test-npm-package": "mocha test/modules_common.js test/modules_es2015.js --reporter dot",
+    "test-sl": "grunt --gruntfile ./test_runner/gruntfile.js --base .",
+
+    "coverage": "istanbul cover _mocha -- test/index.js --reporter spec",
+    "report-coverage": "cat ./coverage/lcov.info | codecov",
+
+    "verify": "npm run eslint && npm run coverage",
+
+    "jsdoc": "jsdoc --configure .jsdoc.json",
+
+    "deploy": "rollup -c config/rollup_dist.js && cp dist/voca.js docs/scripts && scp -r docs/* rainishere:/home/rainishere/webapps/voca_docs"
+  },
+  "devDependencies": {
+    "babel-cli": "6.18.0",
+    "babel-core": "6.18.2",
+    "babel-eslint": "7.1.1",
+    "babel-plugin-add-module-exports": "0.2.1",
+    "babel-plugin-module-resolver": "2.3.0",
+    "babel-plugin-transform-es2015-block-scoping": "6.18.0",
+    "babel-plugin-transform-es2015-modules-commonjs": "6.18.0",
+    "babel-plugin-transform-es2015-parameters": "6.18.0",
+    "babel-plugin-transform-es2015-shorthand-properties": "6.18.0",
+    "babel-plugin-transform-es2015-spread": "6.8.0",
+    "babel-plugin-transform-object-assign": "6.8.0",
+    "babel-register": "6.18.0",
+    "babel-root-import": "4.1.5",
+    "chai": "3.5.0",
+    "codecov.io": "0.1.6",
+    "eslint": "3.10.2",
+    "ghooks": "1.3.2",
+    "glob": "7.1.1",
+    "grunt": "1.0.1",
+    "grunt-contrib-connect": "1.0.2",
+    "grunt-saucelabs": "9.0.0",
+    "istanbul": "1.1.0-alpha.1",
+    "jsdoc": "3.4.3",
+    "mkdirp": "0.5.1",
+    "mocha": "3.2.0",
+    "rollup": "0.36.4",
+    "rollup-plugin-babel": "2.6.1",
+    "rollup-plugin-uglify": "1.0.1",
+    "source-map-support": "0.4.6"
+  },
+  "dependencies": {},
+  "config": {
+    "ghooks": {
+      "pre-commit": "npm run eslint && npm run test"
+    }
+  }
 }

README.md

@@ -1,2 +0,96 @@
-# voca
-Coming soon...
+![Image](https://github.com/panzerdp/voca/raw/master/jsdoc/template/static/images/voca-logo250px.png)
+
+**The ultimate JavaScript string library** [https://vocajs.com](https://vocajs.com)
+
+[![travis build](https://img.shields.io/travis/panzerdp/voca.svg)](https://travis-ci.org/panzerdp/voca)
+[![code coverage](https://img.shields.io/codecov/c/github/panzerdp/voca.svg)](https://codecov.io/github/panzerdp/voca)
+[![sauce test status](https://saucelabs.com/buildstatus/panzerdp)](https://saucelabs.com/u/panzerdp)
+[![dependencies](https://david-dm.org/panzerdp/voca.svg)](https://david-dm.org/panzerdp/voca)
+
+Voca is a JavaScript library for manipulating strings.    
+
+## Features
+
+*  Provides the complete set of functions to manipulate, chop, format, escape and query strings
+*  Covered by detailed and comfortable [documentation](https://vocajs.com)
+*  Supports a wide range of environments: Node.js 0.10+, Chrome, Firefox, Safari 7+, Edge 13+, IE 9+
+*  100% code coverage
+*  No dependencies
+
+## Documentation
+
+See the complete documentation at [https://vocajs.com](https://vocajs.com)
+
+## Usage
+Voca can be used in various environments.
+
+#### Node.js, Rollup, Browserify
+Install the library with npm into your local modules directory:
+
+```bash
+npm install voca
+```
+
+Then in your application import the entire library:
+
+```javascript
+var v = require('voca');
+v.trim(' Hello World! ');
+// => 'Hello World'
+v.sprintf('%s costs $%.2f', 'Coffee', 1.5);
+// => 'Coffee costs $1.50'
+```
+
+Or individual functions:
+
+```javascript
+var words = require('voca/words');
+words('welcome to Earth');
+// => ['welcome', 'to', 'Earth']
+```
+
+#### Browser
+Load the UMD builds directly into browser's web page:
+
+* [`dist/voca.min.js`](https://raw.githubusercontent.com/panzerdp/voca/1.0.0-alpha.0/dist/voca.min.js) minified production-ready 
+* [`dist/voca.js`](https://raw.githubusercontent.com/panzerdp/voca/1.0.0-alpha.0/dist/voca.js) uncompressed with comments 
+
+```html
+<script src="voca.js" type="text/javascript"></script>
+```
+
+Then a global variable `v` is exposed for the entire library:
+
+```html
+<script type="text/javascript">
+  v.isBlank('  ');
+  // => true
+</script>
+```
+
+## Bug reports
+
+For bug reports, documentation typos or feature requests feel free to create an [issue](https://github.com/panzerdp/voca/issues).  
+Please make sure that the same problems wasn't reported already.
+
+For general usage questions please ask on [StackOverflow](http://stackoverflow.com/questions/ask).
+
+## Contribution
+
+Contribution is welcome!
+
+* Create a pull request containing bug fixes or new features. Include unit tests and keep the code coverage report near 100% 😎
+* [Propose](https://github.com/panzerdp/voca/issues) new functions, improvements, better documentation
+
+## Development
+
+Visit the [development section](https://github.com/panzerdp/voca/blob/master/markdown/DEVELOPMENT.md) to find more details.
+
+
+## Author
+
+[Dmitri Pavlutin](https://rainsoft.io/about-me/)
+
+## License
+
+Licensed under [MIT](https://github.com/panzerdp/voca/blob/master/markdown/LICENSE)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

257987

increased by16427.03%

Number of package files

96

increased by2300%

Lines of code

7037

increased byInfinity%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

96

increased by3100%

Worsened metrics

Dev dependency count

29

increased byInfinity%

No dependency changes