rotorjs - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

package.json

 {
   "name": "rotorjs",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
 
+  "description": "Component-based JavaScript library for single-page applications",
+  "keywords": [
+    "RotorJS",
+    "component",
+    "single-page application", "SPA",
+    "user interface", "UI",
+    "rich Internet application", "RIA",
+    "model", "state",
+    "DOM", "virtual DOM",
+    "application loop",
+    "router",
+    "unidirectional dataflow",
+    "minimalistic", "modular",
+    "isomorphic", "universal", "browser", "server",
+    "ES2015", "ES6"
+  ],
   "homepage": "https://github.com/kuraga/rotorjs",
@@ -20,22 +36,32 @@ "repository": {
 
-  "main": "dist/index.js",
+  "main": "index.js",
+  "jsnext:main": "index.js",
 
   "dependencies": {
+    "raf": "^3.1.0",
+    "babel-runtime": "^6.3.19",
     "virtual-dom": "^2.1.1",
     "freezer-js": "^0.9.6",
-    "main-loop": "^3.2.0",
-    "route-trie": "^1.1.1"
+    "route-trie": "^1.2.1"
   },
   "devDependencies": {
-    "gulp": "^3.9.0",
-    "vinyl-source-stream": "^1.1.0",
-    "vinyl-paths": "^2.1.0",
-    "run-sequence": "^1.1.5",
-    "del": "^2.2.0",
-    "gulp-babel": "^5.3.0"
+    "glob": "^6.0.4",
+    "tapes": "^3.0.0",
+    "sinon": "^1.17.2",
+    "clone": "^1.0.2",
+    "babel-register": "^6.4.3",
+    "babel-preset-es2015": "^6.3.13",
+    "babel-preset-stage-1": "^6.3.13",
+    "babel-plugin-transform-runtime": "^6.4.3",
+    "browserify": "^13.0.0",
+    "babelify": "^7.2.0",
+    "tape-run": "^2.1.2",
+    "eslint": "^1.10.3",
+    "babel-eslint": "^5.0.0-beta6"
   },
 
   "scripts": {
-    "dist": "gulp dist",
-    "build-example": "cd ./example && npm run build",
+    "test": "node scripts/test.js",
+    "test-browser": "node scripts/testBrowser.js",
+    "lint": "eslint $(git ls-files '*.js' '*.jsx')",
 
@@ -42,0 +68,0 @@ "release-patch": "git checkout master && npm version patch && git push origin master --tags && npm publish",

README.md

@@ -1,24 +0,49 @@
-# RotorJS (concept)
+# RotorJS
 
-This is an *early development concept* of a JavaScript library for rich JavaScript applications and an example application.
+This is a beta-stage component-based JavaScript library for single-page applications and an example application.
 
 ## Philosophy
 
-Entities:
+RotorJS provides classes which represent an application and its components.
 
-* model,
-* view (renderer),
-* main loop,
-* router.
+It uses exchangeble "middlewares" under the hood.
+A middleware consist of a model class, a rendering loop class and (possible) other classes.
+You can use your own middlewares so RotorJS is DOM-agnostic, model-agnostic, etc.
 
-Approaches:
+A component is a subclass of RotorJS class, it has to provide a render function.
+Component's state (model) is available during render.
+Components may also have their activating and deactivating hooks.
+Subcomponents are supported.
 
-* minimalism and simplicity,
-* unidirectional dataflow,
-* immutable state,
-* functional reactive programming,
-* (not yet) testability and (not yet) documentability,
-* (not yet) isomorphic,
-* ECMAScript 2016.
+Application is also a subclass RotorJS class.
+You may implement application's start and stop hooks but default start hook receives a root component.
 
+A target object (e.g. DOM tree) is available after application has been started.
+It is changed during some component's state updating.
+So target is "current view" of application.
+
+Some additional features are also provided.
+
+## Approaches
+
+* minimalism,
+* modularity,
+* testability,
+* (not yet) documentability,
+* isomorphism,
+* ECMAScript 2015.
+
+## Default middleware
+
+Default middleware is based on [Freezer](https://github.com/arqex/freezer) and [virtual-dom](https://github.com/Matt-Esch/virtual-dom).
+So your application uses unidirectional dataflow, immutable state and provides DOM target with default middleware.
+
+You simple have to append application's target to your document's body and use virtual-dom's
+[virtual-hyperscript](https://github.com/Matt-Esch/virtual-dom/tree/master/virtual-hyperscript) to construct component's view.
+See [example](https://github.com/kuraga/rotorjs/tree/master/example) for more information.
+
+## Get started
+
+TODO
+
 ## Example
@@ -28,11 +53,2 @@
 
-## Dependencies
-
-Dependency | Usage
----------- | -----
-[virtual-dom](https://github.com/Matt-Esch/virtual-dom) | DOM rendering
-[Freezer](https://github.com/arqex/freezer) | Immutable data state
-[main-loop](https://github.com/Raynos/main-loop) | Application loop
-[route-trie](https://github.com/zensh/route-trie) | Routes matching
-
 ## Author
@@ -48,2 +64,3 @@
 * [React](http://facebook.github.io/react),
+* [Preact](http://developit.github.io/preact),
 * [Zorium](https://github.com/Zorium/zorium).
@@ -50,0 +67,0 @@

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

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

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

Improved metrics

Total package byte prevSize

96803

increased by438.93%

Number of package files

40

increased by344.44%

Lines of code

2664

increased by803.05%

Number of lines in readme file

73

increased by30.36%

Worsened metrics

Dependency count

5

increased by25%

Dev dependency count

13

increased by116.67%

Number of low supply chain risk alerts

2

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedbabel-runtime@^6.3.19

• + Addedraf@^3.1.0

• + Addedbabel-runtime@6.26.0(transitive)

• + Addedcore-js@2.6.12(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedraf@3.4.1(transitive)

• + Addedregenerator-runtime@0.11.1(transitive)

• - Removedmain-loop@^3.2.0

• - Removedmain-loop@3.4.0(transitive)

• - Removedperformance-now@0.1.4(transitive)

• - Removedraf@2.0.4(transitive)

• Updatedroute-trie@^1.2.1