roc - npm Package Compare versions

Comparing version 1.0.0-alpha1 to 1.0.0-alpha10

package.json

 {
   "name": "roc",
-  "version": "1.0.0-alpha1",
+  "version": "1.0.0-alpha10",
   "description": "CLI for the Roc ecosystem",
@@ -10,4 +10,8 @@ "main": "./lib/index.js",
     "build": "babel src --out-dir lib --source-maps",
-    "clean": "rimraf lib",
-    "test": "npm run lint",
+    "build:watch": "npm run build -- --watch",
+    "clean": "rimraf lib docs coverage",
+    "test": "npm run lint && npm run test:coverage",
+    "test:unit": "mocha --compilers js:babel/register --recursive test/",
+    "test:unit:watch": "mocha --watch --compilers js:babel/register --recursive test/",
+    "test:coverage": "babel-node ./node_modules/.bin/isparta cover _mocha -- --recursive test/",
     "lint": "eslint .",
@@ -27,3 +31,3 @@ "check": "ncu",
     "request": "~2.65.0",
-    "roc-config": "1.0.0-alpha1",
+    "roc-config": "*",
     "semver": "~5.0.3",
@@ -37,6 +41,14 @@ "source-map-support": "~0.3.2",
     "babel-eslint": "~4.1.1",
+    "chai": "~3.4.1",
+    "codacy-coverage": "~1.1.3",
+    "codeclimate-test-reporter": "~0.1.1",
+    "coveralls": "~2.11.4",
     "eslint": "~1.9.0",
     "eslint-config-vgno": "~5.0.0",
+    "isparta": "~3.5.3",
+    "mocha": "~2.3.4",
     "npm-check-updates": "~2.4.2",
-    "rimraf": "~2.4.3"
+    "rimraf": "~2.4.3",
+    "sinon": "~1.17.2",
+    "sinon-chai": "~2.8.0"
   },
@@ -47,2 +59,5 @@ "repository": {
   },
+  "files": [
+    "lib"
+  ],
   "keywords": [
@@ -49,0 +64,0 @@ "roc"

README.md

@@ -1,18 +0,38 @@
-# Roc
+# Roc - CLI for the Roc ecosystem
+Develop modern web applications and components without the boilerplate fragmentation.
+
+![stability alpha](https://img.shields.io/badge/stability-alpha-red.svg)
+[![roc](https://img.shields.io/npm/v/roc.svg)](https://www.npmjs.com/package/roc)
+[![build status](https://travis-ci.org/vgno/roc.svg)](https://travis-ci.org/vgno/roc)
+[![Coverage Status](https://coveralls.io/repos/vgno/roc/badge.svg?branch=master&service=github)](https://coveralls.io/github/vgno/roc?branch=master)
+[![Code Climate](https://codeclimate.com/github/vgno/roc/badges/gpa.svg)](https://codeclimate.com/github/vgno/roc)
+[![Issue Count](https://codeclimate.com/github/vgno/roc/badges/issue_count.svg)](https://codeclimate.com/github/vgno/roc)
+[![Dependency Status](https://david-dm.org/vgno/roc.svg)](https://david-dm.org/vgno/roc)
+
+
+
 ## Modern Application Development Ecosystem
-_Project status is currently WIP proof of concept_  
+_Project status is currently work in progress and proof of concept_  
+We have started to implement the first few products based on Roc. These products are not yet in production. You have been warned!
 
-Provides a complete ecosystem for developing modern applications.  
+---
+
+Roc provides a complete ecosystem for developing modern applications.  
 Sweeps common complexities into easy-to-use packages with extendable APIs.
 
-Composes some great open source tools and make them easy to use with a streamlined CLI and configuration/extension system. Direct your focus to _writing great software_ and away from juggling boilerplate and dependencies. Built on top of the node ecosystem.
+Composes some great open source tools and make them easy to use with a streamlined command line interface and configuration/extension system.  
 
+Direct your focus to _writing great software_ and away from juggling boilerplate and dependencies. Roc is built on top of the Node.js ecosystem.
+
 ### Example of tasks handled by extensions
-- Building and bundling through Webpack
-- Web server through Koa
-- First class developer experience
-- React (complete with Redux and server side rendering)
+- Building and bundling through [Webpack](http://webpack.github.io/)
+- Web server through [Koa](http://koajs.com/)
+- [React](http://facebook.github.io/react/) (complete with [Redux](https://github.com/rackt/redux) and server side rendering)
+- First class developer experience featuring hot code reloading and [Browsersync](http://browsersync.io)
 
-Common tasks and boilerplate code does not exist in a Roc application but in extensions making it easier to maintain and update.
+Common tasks and boilerplate code does not exist in a Roc application but in extensions installed with `npm` making it easier to maintain and update. Roc extensions are opinionated by design.
 
+### Simplicity
+As a user of Roc to create components or applications you will mainly direct your attention to your application code, configuration limited to your own project and using the command line interface. You do not need a deep understanding of how Roc makes your life simpler. We do however encourage you to take a deep-dive and contribute.
+
 ## Get started
@@ -24,19 +44,53 @@ ### Install Roc
 
-### Basic web application
+This provides you with a really simple command line interface. Only Linux and OS X _currently_ supported.
+
+### Bootstrap Redux + React application
+Create application directory. Name it whatever you like. We used react-app.
+
 ```
+mkdir react-app && cd react-app
+```
+Init application starting point
+```
+roc init web-react
+```
+
+Build and start the application in development mode
+```
+roc dev
+```
+
+`roc init web-react` uses the starting point [roc-template-web-react](https://github.com/vgno/roc-template-web-react) from Github  
+
+Suitable for more ambitious web-applications that prefer **React** views, **universal rendering** and established library **Redux** for unidirectional dataflow.  
+
+
+### Bootstrap basic web application
+Create application directory. Name it whatever you like. We used basic.
+
+```
 mkdir basic && cd basic
+```
+Init application starting point
+```
 roc init web
-roc dev
 ```
 
-### Basic Redux & React application
+Build and start the application in development mode
 ```
-mkdir redux && cd redux
-roc init web-react
 roc dev
 ```
 
-`roc help` will provide available actions.  
-`dev` starts the application locally in development mode with hot code reloading and Browersync. View your application at http://localhost:3002
+`roc init web` uses the starting point [roc-template-web](https://github.com/vgno/roc-template-web) from Github  
 
+Suitable for serving static files and rendering `html` with basic `javascript` on the client.  
+
+### Where to go from here
+`roc help` will print available actions.  
+`roc dev` starts the application locally in development mode with _hot code reloading_ and _Browersync_.  
+`roc dev --help` will list all **options available to your current extension**.  
+Be sure to read through this as minor adjustments to your `roc.config.js` is a very common use-case. Also check out defaults for [web](https://github.com/vgno/roc-web/blob/master/src/roc/config/roc.config.js) and [web-react](https://github.com/vgno/roc-web-react/blob/master/src/roc/config/roc.config.js)  
+
+View your application at http://localhost:3002 using default configuration.
+
 ## Motivation
@@ -46,7 +100,9 @@ Roc was born out of the need to create modern applications following the correct conventions and using best practices consistently.
 
-## Read the code
-cli: TODO  
-web: TODO  
-web-react: TODO  
-config: TODO
+## Eco system
+| Project | Github page |
+----------|--------------
+| CLI (this project) | https://github.com/vgno/roc |
+| Roc Config | https://github.com/vgno/roc-config |
+| Roc Web | https://github.com/vgno/roc-web |
+| Roc Web React | https://github.com/vgno/roc-web-react |
 
@@ -53,0 +109,0 @@ ## Roadmap

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Wildcard dependency

Quality

Package has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.

Found 1 instance in 1 package

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

67141

increased by206.92%

Number of package files

25

increased by31.58%

Lines of code

548

increased by30.17%

Number of lines in readme file

116

increased by93.33%

Worsened metrics

Dev dependency count

14

increased by133.33%

Number of medium quality alerts

2

increased by100%

Dependency changes

• - Removeddeep-extend@0.4.2(transitive)

• - Removedroc-config@1.0.0-alpha1(transitive)

• Updatedroc-config@*