Initial commit

Author: adamsol

.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+# https://docs.github.com/en/actions/guides/building-and-testing-nodejs
+
+name: CI
+on:
+  push:
+    paths-ignore: ['*.md']
+jobs:
+  test:
+    strategy:
+      matrix:
+        include:
+          - { node-version: 12.x, platform: ubuntu-latest }
+          - { node-version: 14.x, platform: windows-latest }
+          - { node-version: 16.x, platform: macos-latest }
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+      - run: npm ci
+      - run: npm test

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+node_modules/
+_*

LICENSE.txt

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2021 Adam Sołtysik
+
+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,32 @@
+vue-component-store
+===================
+
+[![License](https://img.shields.io/github/license/adamsol/vue-component-store.svg)](https://github.com/adamsol/vue-component-store/blob/master/LICENSE.txt)
+[![CI](https://github.com/adamsol/vue-component-store/actions/workflows/ci.yml/badge.svg)](https://github.com/adamsol/vue-component-store/actions)
+
+A simple plugin for Vue.js 2.6.x, offering a clean way to keep the state of your application inside your components.
+
+This library was inspired by https://github.com/LinusBorg/vue-reactive-provide. The basic idea is similar, but the API and implementation are different.
+
+Why?
+----
+
+1. Vuex is centralized by design, but suggests dividing the store into modules to mimic the application's structure. This usually requires a lot of boilerplate. It's easier to use the existing component hierarchy and Vue's reactivity system directly instead.
+2. Vue has a `provide`/`inject` mechanism for passing data down the component hierarchy without chains of props, but [it's not reactive by default](https://github.com/vuejs/vue/issues/7017).
+
+API
+---
+
+You can use the following new options in your components:
+
+* `provideFields` – A list of fields (from `props`, `data`, or `computed`) to share with the descendant components. The fields will be reactive (one-way binding, like props).
+* `injectFields` – A list of fields (provided by ancestor components) to use in the current component. The effect is similar to using `mapState` and `mapGetters` from Vuex.
+* `provideMethods` – A list of methods to share with the descendant components.
+* `injectMethods` – A list of methods (provided by ancestor components) to use in the current component. This is functionally equivalent to bare `inject`, but exists for consistency of the API. The effect is similar to using `mapActions` from Vuex.
+
+In order to share global state between all components in your application, use `provideFields`/`provideMethods` in the root component.
+
+Example
+-------
+
+See https://github.com/adamsol/vue-component-store/tree/master/test/components/.

babel.config.js

@@ -0,0 +1,10 @@
+
+const mode = process.env.NODE_ENV;
+
+module.exports = {
+    presets: [
+        ['@babel/preset-env', {
+            targets: mode === 'test' ? { node: 'current' } : 'defaults',
+        }],
+    ],
+};

jest.config.js

@@ -0,0 +1,10 @@
+
+module.exports = {
+    moduleFileExtensions: ['js', 'vue'],
+    testEnvironment: 'jsdom',
+    testMatch: ['**/test/**/*.js'],
+    transform: {
+        '^.+\\.js$': 'babel-jest',
+        '^.+\\.vue$': 'vue-jest',
+    },
+};