add CHANGELOG, README, LICENSE, .npmignore and eslint

Author: distolma

.npmignore

@@ -0,0 +1,14 @@
+.editorconfig
+
+npm-debug.log
+yarn-error.log
+yarn.lock
+
+*.spec.js
+.travis.yml
+
+node_modules/
+example/
+coverage/
+.cache/
+dist/

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.1.0
+* Add `README.md`.
+* Add `CHANGELOG.md`.
+* Add `LICENSE`.
+* Add `.npmignore`.
+* Add `eslint`.
+
+## 0.0.1
+* Initial release.

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dmytro Mostovyi <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,44 @@
+# storeon-svelte
+
+<img src="https://storeon.github.io/storeon/logo.svg" align="right"
+     alt="Storeon logo by Anton Lovchikov" width="160" height="142">
+
+A tiny (only 128 bytes) connector for **[Storeon]** and Svelte.
+
+---------------------
+[Storeon]: https://github.com/storeon/storeon
+
+## How to use
+```javascript
+import createStore from 'storeon';
+import { bindStoreon } from 'storeon-svelte';
+
+let counter = store => {
+  // Initial state
+  store.on('@init', () => ({ count: 0 }));
+  // Reducers returns only changed part of the state
+  store.on('inc', ({ count }) => ({  count: count + 1 }));
+};
+
+const store = createStore([counter]);
+
+export const connect = bindStoreon(store);
+```
+
+```html
+<script>
+  import { connect } from './store.js';
+
+  const [dispatch, count] = connect('count');
+
+  function increment() {
+    dispatch('inc');
+  }
+</script>
+
+<h1>The count is {$count}</h1>
+
+<button on:click={increment}>
+	+
+</button>
+```

index.js

@@ -4,36 +4,36 @@
  *
  * @return {}
  */
-const bindStoreon = function (store) {
+function bindStoreon (store) {
   /**
    *
    */
   return function (key) {
-    var state = store.get();
-    var subscribers = [];
+    var state = store.get()
+    var subscribers = []
 
-    function subscribe(run) {
-      subscribers.push(run);
+    function subscribe (run) {
+      subscribers.push(run)
       run(state[key])
 
       return function () {
-        var index = subscribers.indexOf(run);
-        if (index !== -1) subscribers.splice(index, 1);
+        var index = subscribers.indexOf(run)
+        if (index !== -1) subscribers.splice(index, 1)
       }
     }
 
-    store.on("@changed", function (_, changed) {
+    store.on('@changed', function (_, changed) {
       if (key in changed) {
-        subscribers.forEach(s => s(changed[key]))
+        subscribers.forEach(function (s) { return s(changed[key]) })
       }
     })
 
     var changes = {
       subscribe: subscribe
     }
 
-    return [store.dispatch, changes];
+    return [store.dispatch, changes]
   }
 }
 
-module.exports = { bindStoreon }
+module.exports = { bindStoreon: bindStoreon }

index.spec.js

@@ -0,0 +1,78 @@
+var createStore = require('storeon')
+
+var bindStoreon = require('.').bindStoreon
+
+function connectFactory () {
+  function counter (store) {
+    store.on('@init', function () { return { count: 0, foo: 'baz' } })
+    store.on('inc', function (state) { return { count: state.count + 1 } })
+  }
+
+  var store = createStore([counter])
+
+  return bindStoreon(store)
+}
+
+it('should start with init value', function () {
+  var connect = connectFactory()
+
+  var count = connect('count')[1]
+
+  count.subscribe(function (value) { return expect(value).toBe(0) })
+})
+
+it('should be reactive', function () {
+  var connect = connectFactory()
+
+  var currentValue
+  var connection = connect('count')
+  var dispatch = connection[0]
+  var count = connection[1]
+
+  count.subscribe(function (value) { currentValue = value })
+
+  expect(currentValue).toBe(0)
+
+  dispatch('inc')
+
+  expect(currentValue).toBe(1)
+})
+
+it('should not emmit changes on other dispatches', function () {
+  var connect = connectFactory()
+  var spyCb = jest.fn()
+
+  var connection = connect('foo')
+  var dispatch = connection[0]
+  var foo = connection[1]
+
+  foo.subscribe(spyCb)
+
+  dispatch('inc')
+
+  expect(spyCb).toBeCalledWith('baz')
+  expect(spyCb).toBeCalledTimes(1)
+})
+
+it('shoud to be unsubscribed', function () {
+  var connect = connectFactory()
+
+  var currentValue
+  var connection = connect('count')
+  var dispatch = connection[0]
+  var count = connection[1]
+
+  var unsubscribe = count.subscribe(function (value) { currentValue = value })
+
+  expect(currentValue).toBe(0)
+
+  dispatch('inc')
+
+  expect(currentValue).toBe(1)
+
+  unsubscribe()
+  unsubscribe()
+  dispatch('inc')
+
+  expect(currentValue).toBe(1)
+})

index.test.js

@@ -7,23 +7,37 @@
   "license": "MIT",
   "scripts": {
     "start": "parcel serve example/index.html --open",
-    "test": "jest --coverage && size-limit"
+    "lint": "eslint *.js",
+    "test": "jest --coverage && yarn lint && size-limit"
   },
   "devDependencies": {
+    "@logux/eslint-config": "^28.2.1",
+    "eslint": "^5.16.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-es5": "^1.3.1",
+    "eslint-plugin-import": "^2.17.2",
+    "eslint-plugin-import-helpers": "^0.1.4",
+    "eslint-plugin-jest": "^22.5.1",
+    "eslint-plugin-node": "^9.0.1",
+    "eslint-plugin-promise": "^4.1.1",
+    "eslint-plugin-security": "^1.4.0",
+    "eslint-plugin-standard": "^4.0.0",
     "husky": "^2.3.0",
     "jest": "^24.8.0",
     "lint-staged": "^8.1.7",
     "parcel-bundler": "^1.12.3",
     "parcel-plugin-svelte": "^3.0.1",
     "prettier": "^1.17.1",
     "size-limit": "^1.3.2",
-    "svelte": "^3.4.0"
+    "svelte": "^3.4.0",
+    "typescript": "^3.4.5"
   },
   "dependencies": {
     "storeon": "^0.8.3"
   },
   "lint-staged": {
     "*.js": [
+      "eslint --fix",
       "prettier --write",
       "git add"
     ]
@@ -42,6 +56,9 @@
       "limit": "128 B"
     }
   ],
+  "eslintConfig": {
+    "extends": "@logux/eslint-config/browser"
+  },
   "prettier": {
     "trailingComma": "all",
     "tabWidth": 2,