├── .editorconfig ├── .eslintrc.js ├── .github └── workflows │ └── test.yml ├── .gitignore ├── LICENSE ├── README.md ├── jest.config.js ├── lib └── index.ts ├── package-lock.json ├── package.json ├── rollup.config.js ├── test └── index.spec.ts └── tsconfig.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | root = true 3 | 4 | [*] 5 | indent_style = space 6 | indent_size = 2 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | 12 | # Use 4 spaces for the Python files 13 | [*.py] 14 | indent_size = 4 15 | max_line_length = 80 16 | 17 | # The JSON files contain newlines inconsistently 18 | [*.json] 19 | insert_final_newline = ignore 20 | 21 | # Minified JavaScript files shouldn't be changed 22 | [**.min.js] 23 | indent_style = ignore 24 | insert_final_newline = ignore 25 | 26 | # Makefiles always use tabs for indentation 27 | [Makefile] 28 | indent_style = tab 29 | 30 | # Batch files use tabs for indentation 31 | [*.bat] 32 | indent_style = tab 33 | 34 | [*.md] 35 | trim_trailing_whitespace = false 36 | 37 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | env: { 3 | browser: true, 4 | es2021: true 5 | }, 6 | extends: [ 7 | 'standard' 8 | ], 9 | parser: '@typescript-eslint/parser', 10 | parserOptions: { 11 | ecmaVersion: 13, 12 | sourceType: 'module' 13 | }, 14 | plugins: [ 15 | '@typescript-eslint' 16 | ], 17 | rules: { 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions 3 | name: Test 4 | 5 | on: [push, pull_request] 6 | 7 | jobs: 8 | test-suntori: 9 | runs-on: ubuntu-latest 10 | 11 | strategy: 12 | matrix: 13 | node-version: [14.x] 14 | 15 | steps: 16 | - name: Checkout code 17 | uses: actions/checkout@v2 18 | 19 | - name: Use Node.js ${{ matrix.node-version }} 20 | uses: actions/setup-node@v1 21 | with: 22 | node-version: ${{ matrix.node-version }} 23 | 24 | - name: Test 25 | run: npm ci --quiet --no-progress && npm test 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | .env.test 60 | 61 | # parcel-bundler cache (https://parceljs.org/) 62 | .cache 63 | 64 | # next.js build output 65 | .next 66 | 67 | # nuxt.js build output 68 | .nuxt 69 | 70 | # vuepress build output 71 | .vuepress/dist 72 | 73 | # Serverless directories 74 | .serverless/ 75 | 76 | # FuseBox cache 77 | .fusebox/ 78 | 79 | # DynamoDB Local files 80 | .dynamodb/ 81 | 82 | # Testing. 83 | .coverage-report/ 84 | 85 | # Rollup Cache. 86 | .rpt2_cache/ 87 | 88 | # IDEs. 89 | .vscode/ 90 | .idea/ 91 | 92 | # Dist. 93 | dist/ 94 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2022 LancerComet 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vuexer 2 | 3 | [![Vuexer](https://github.com/LancerComet/vuexer/workflows/Test/badge.svg)](https://github.com/LancerComet/vuexer/actions) 4 | [![npm version](https://badge.fury.io/js/vuexer.svg)](https://badge.fury.io/js/vuexer) 5 | 6 | ## What's wrong with the "Vue 1 + Vuex 1"? 7 | 8 | If you want to distribute some vue 1 components to npm or somewhere else, and these components use Vuex 1 as its state manager, Vue 1 + Vuex 1 just can't do this. 9 | 10 | So this package is designed to solve this problem. It adds a new properity `$vuexer` in all vue components, so that you can use `$vuexer` as a bridge to communicate with each other. 11 | 12 | Only for Vue 1.0, because "Vue 2.0 + Vuex 2.0" has solved this problem. 13 | 14 | ## Quick Start 15 | 16 | ```javascript 17 | import Vue from 'vue' 18 | import Vuexer from 'vuexer' 19 | 20 | import store from './vuex/store' 21 | import actions from './vuex/actions' 22 | import getters from './vuex/getters' 23 | 24 | Vue.use(Vuexer, { 25 | store, 26 | actions, 27 | getters 28 | }) 29 | ``` 30 | 31 | After vuexer has been initialized, a new property called `$vuexer` will be added to your components. 32 | 33 | Let's see: 34 | 35 | ```html 36 | 45 | 46 | 55 | ``` 56 | 57 | Now you want to have this code in your component, and you are going to distribute it to somewhere. 58 | 59 | Once a project uses this component, just make sure Vuexer is installed in this project and everything will be fine. 60 | 61 | ## License 62 | 63 | Apache-2.0 64 | -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | verbose: true, 4 | collectCoverage: true, 5 | setupFiles: [ 6 | ] 7 | } 8 | -------------------------------------------------------------------------------- /lib/index.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Transport data between vue components from npm package and project. 3 | * Only for Vue 1. 4 | * 5 | * 2016.10.17 16:35. 6 | * # Carry Your World # 7 | * 8 | * @author: LancerComet 9 | * @license: Apache-2.0 10 | */ 11 | 12 | let installed = false 13 | 14 | const vuexer = { 15 | install: (Vue: any, options: { 16 | store: any 17 | actions: any 18 | getters: any 19 | }) => { 20 | if (!options || !options.store) { 21 | window.console && console.warn('[Vuexer] You must provide Vuex modules for Vuexer initialization.') 22 | return 23 | } 24 | 25 | if (!installed) { 26 | const vm = new Vue({ 27 | store: options.store, 28 | vuex: { 29 | actions: options.actions, 30 | getters: options.getters 31 | } 32 | }) 33 | Vue.vuexer = vm 34 | Vue.prototype.$vuexer = vm 35 | installed = true 36 | } 37 | } 38 | } 39 | 40 | export default vuexer 41 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vuexer", 3 | "version": "0.1.10", 4 | "description": "Transport data between vue components from npm package and project. Only for Vue 1.", 5 | "main": "./dist/index.js", 6 | "module": "./dist/index.esm.js", 7 | "files": [ 8 | "dist/", 9 | "README.md" 10 | ], 11 | "scripts": { 12 | "build": "rollup -c", 13 | "lint": "eslint ./lib/**", 14 | "test": "jest", 15 | "prebuild": "npm run lint", 16 | "pretest": "npm run build", 17 | "preversion": "npm run test", 18 | "prepublish": "npm run test" 19 | }, 20 | "author": { 21 | "name": "LancerComet", 22 | "email": "chw644@hotmail.com" 23 | }, 24 | "repository": { 25 | "type": "git", 26 | "url": "https://github.com/LancerComet/vuexer.git" 27 | }, 28 | "license": "Apache-2.0", 29 | "devDependencies": { 30 | "@types/jest": "^27.0.3", 31 | "@typescript-eslint/eslint-plugin": "^5.7.0", 32 | "@typescript-eslint/parser": "^5.7.0", 33 | "eslint": "^7.32.0", 34 | "eslint-config-standard": "^16.0.3", 35 | "eslint-plugin-import": "^2.25.3", 36 | "eslint-plugin-node": "^11.1.0", 37 | "eslint-plugin-promise": "^5.2.0", 38 | "jest": "^27.4.5", 39 | "rollup": "^2.61.1", 40 | "rollup-plugin-commonjs": "^10.1.0", 41 | "rollup-plugin-delete": "^2.0.0", 42 | "rollup-plugin-typescript2": "^0.31.1", 43 | "ts-jest": "^27.1.2", 44 | "typescript": "^4.5.4", 45 | "vue": "^1.0.28", 46 | "vuex": "^1.0.1" 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /rollup.config.js: -------------------------------------------------------------------------------- 1 | import typescript from 'rollup-plugin-typescript2' 2 | import commonjs from 'rollup-plugin-commonjs' 3 | import del from 'rollup-plugin-delete' 4 | 5 | export default { 6 | input: './lib/index.ts', 7 | 8 | output: [ 9 | { 10 | file: './dist/index.js', 11 | format: 'umd', 12 | name: 'Vuexer' 13 | }, 14 | { 15 | file: './dist/index.esm.js', 16 | format: 'es' 17 | } 18 | ], 19 | 20 | plugins: [ 21 | commonjs(), 22 | 23 | typescript({ 24 | tsconfigOverride: { 25 | compilerOptions: { 26 | target: 'es5' 27 | }, 28 | include: [ 29 | 'lib/**/*' 30 | ] 31 | } 32 | }), 33 | 34 | del({ 35 | targets: 'dist/*' 36 | }) 37 | ] 38 | } 39 | -------------------------------------------------------------------------------- /test/index.spec.ts: -------------------------------------------------------------------------------- 1 | // @ts-ignore 2 | import Vue from 'vue' 3 | import Vuex from 'vuex' 4 | import Vuexer from '../lib' 5 | 6 | Vue.use(Vuex) 7 | 8 | type State = { count: number } 9 | 10 | const state: State = { 11 | count: 10 12 | } 13 | 14 | const store = new Vuex.Store({ 15 | state, 16 | mutations: { 17 | INCREMENT (state: State) { 18 | state.count++ 19 | } 20 | } 21 | }) 22 | 23 | Vue.use(Vuexer, { 24 | store, 25 | actions: { 26 | setIncrement (ctx: any) { 27 | ctx.dispatch('INCREMENT') 28 | } 29 | }, 30 | getters: { 31 | getCount: (state: State) => state.count 32 | } 33 | }) 34 | 35 | describe('Vuexer testing.', () => { 36 | it('Vuexer should work.', done => { 37 | const vm = new Vue() 38 | expect(vm.$vuexer).toBeDefined() 39 | expect(vm.$vuexer.getCount).toBe(10) 40 | vm.$vuexer.setIncrement() 41 | setTimeout(() => { 42 | expect(vm.$vuexer.getCount).toBe(11) 43 | done() 44 | }, 150) 45 | }) 46 | }) 47 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "module": "ESNext", 5 | "lib": [ 6 | "dom", 7 | "es5", 8 | "es2015", 9 | "es2016", 10 | "es2017" 11 | ], 12 | "declaration": true, 13 | "noImplicitAny": true, 14 | "moduleResolution": "node", 15 | "esModuleInterop": true, 16 | "experimentalDecorators": true, 17 | "emitDecoratorMetadata": true, 18 | "skipLibCheck": true, 19 | "forceConsistentCasingInFileNames": true 20 | } 21 | } 22 | --------------------------------------------------------------------------------