├── .gitignore ├── LICENSE ├── README.md ├── lib └── index.ts ├── package.json └── tsconfig.json /.gitignore: -------------------------------------------------------------------------------- 1 | bin/ 2 | node_modules/ 3 | -------------------------------------------------------------------------------- /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 {yyyy} {name of copyright owner} 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 | # TypeScript Language Service Plugin for Vue 2 | 3 | WARNING: This plugin is in an alpha state. For a more polished 4 | experience, 5 | [try the VS Code plugin vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur). 6 | This plugin, however, works with the Typescript language service. So 7 | you can use it with whatever editor you want. 8 | 9 | This plugin does three things for Javascript and Typescript source in a `.vue` file: 10 | 11 | 1. It uses `vue-template-compiler` to parse out the script section of a `.vue` file. 12 | 2. It wraps a default exported object literal in `new Vue(...)` in order to propagate the Vue contextual type so that no type annotations are needed. 13 | 3. It uses the Typescript language service to provide completions. 14 | 15 | It also resolves `import other from "other.vue";` statements in the same manner. 16 | It does *not* support completions in the `template` tag. It doesn't 17 | even support the `template` or `style` tags. 18 | 19 | ## Features left to add 20 | 21 | 1. Recognise ES5-style `module.exports = { ...` in addition to ES6 `export default { ...`. 22 | 2. Recognise only lang="javascript", lang="typescript" and no lang attribute. Others should not turn on the language service. 23 | 24 | ## Instructions 25 | 26 | 1. `$ npm install vue-ts-plugin` 27 | 2. Add plugin to tsconfig. 28 | 29 | ```json 30 | { 31 | compilerOptions: { 32 | "allowSyntheticDefaultImports": true, 33 | "plugins": [{ "name": "vue-ts-plugin" }] 34 | } 35 | } 36 | ``` 37 | You will need "allowSyntheticDefaultImports" so that `import Vue from 'vue'` works. 38 | 39 | 3. Set your editor to treat `.vue` files as Typescript. 40 | 41 | For example, in Emacs, add the line: 42 | 43 | ```elisp 44 | (add-to-list 'auto-mode-alist '("\\.vue$" . typescript-mode)) 45 | ``` 46 | 47 | If you're Vim user, you can use [tsuquyomi-vue](https://github.com/Quramy/tsuquyomi-vue). 48 | 49 | Now you have typescript support inside the script tags. HTML and CSS support are non-existent right now. 50 | -------------------------------------------------------------------------------- /lib/index.ts: -------------------------------------------------------------------------------- 1 | import * as ts_module from "../node_modules/typescript/lib/tsserverlibrary"; 2 | import { parseComponent } from "vue-template-compiler"; 3 | import path = require('path'); 4 | 5 | function init({ typescript: ts } : {typescript: typeof ts_module}) { 6 | return { create, getExternalFiles }; 7 | 8 | function create(info: ts.server.PluginCreateInfo) { 9 | changeSourceFiles(info); 10 | info.languageServiceHost.resolveModuleNames = (moduleNames, containingFile) => { 11 | const options = info.languageServiceHost.getCompilationSettings(); 12 | return bifilterMap(moduleNames, importInterested, 13 | name => ({ 14 | resolvedFileName: path.join(path.dirname(containingFile), path.basename(name)), 15 | extension: ts_module.Extension.Ts 16 | }), 17 | name => ts.resolveModuleName(name, containingFile, options, ts.sys).resolvedModule); 18 | }; 19 | 20 | return info.languageService; 21 | } 22 | 23 | function changeSourceFiles(info: ts.server.PluginCreateInfo) { 24 | const clssf = ts.createLanguageServiceSourceFile; 25 | const ulssf = ts.updateLanguageServiceSourceFile; 26 | function createLanguageServiceSourceFile(fileName: string, scriptSnapshot: ts.IScriptSnapshot, scriptTarget: ts.ScriptTarget, version: string, setNodeParents: boolean, scriptKind?: ts.ScriptKind, cheat?: string): ts.SourceFile { 27 | if (interested(fileName)) { 28 | const wrapped = scriptSnapshot; 29 | scriptSnapshot = { 30 | getChangeRange: old => wrapped.getChangeRange(old), 31 | getLength: () => wrapped.getLength(), 32 | getText: (start, end) => parse(fileName, wrapped.getText(0, wrapped.getLength())).slice(start, end), 33 | }; 34 | } 35 | var sourceFile = clssf(fileName, scriptSnapshot, scriptTarget, version, setNodeParents, scriptKind); 36 | if (interested(fileName)) { 37 | modifyVueSource(sourceFile); 38 | } 39 | return sourceFile; 40 | } 41 | 42 | function updateLanguageServiceSourceFile(sourceFile: ts.SourceFile, scriptSnapshot: ts.IScriptSnapshot, version: string, textChangeRange: ts.TextChangeRange, aggressiveChecks?: boolean, cheat?: string): ts.SourceFile { 43 | if (interested(sourceFile.fileName)) { 44 | const wrapped = scriptSnapshot; 45 | scriptSnapshot = { 46 | getChangeRange: old => wrapped.getChangeRange(old), 47 | getLength: () => wrapped.getLength(), 48 | getText: (start, end) => parse(sourceFile.fileName, wrapped.getText(0, wrapped.getLength())).slice(start, end), 49 | }; 50 | } 51 | var sourceFile = ulssf(sourceFile, scriptSnapshot, version, textChangeRange, aggressiveChecks); 52 | if (interested(sourceFile.fileName)) { 53 | modifyVueSource(sourceFile); 54 | } 55 | return sourceFile; 56 | } 57 | ts.createLanguageServiceSourceFile = createLanguageServiceSourceFile; 58 | ts.updateLanguageServiceSourceFile = updateLanguageServiceSourceFile; 59 | } 60 | 61 | 62 | function interested(filename: string): boolean { 63 | return filename.slice(filename.lastIndexOf('.')) === ".vue"; 64 | } 65 | 66 | function importInterested(filename: string): boolean { 67 | return interested(filename) && filename.slice(0, 2) === "./"; 68 | } 69 | 70 | function parse(fileName: string, text: string) { 71 | const output = parseComponent(text, { pad: "space" }); 72 | return output && output.script && output.script.content; 73 | } 74 | 75 | /** Works like Array.prototype.find, returning `undefined` if no element satisfying the predicate is found. */ 76 | function find(array: T[], predicate: (element: T, index: number) => boolean): T | undefined { 77 | for (let i = 0; i < array.length; i++) { 78 | const value = array[i]; 79 | if (predicate(value, i)) { 80 | return value; 81 | } 82 | } 83 | return undefined; 84 | } 85 | 86 | /** Maps elements with one of two functions depending on whether the predicate is true */ 87 | function bifilterMap(l: T[], predicate: (t: T) => boolean, yes: (t: T) => U, no: (t: T) => U): U[] { 88 | const result = []; 89 | for (const x of l) { 90 | result.push(predicate(x) ? yes(x) : no(x)); 91 | } 92 | return result; 93 | } 94 | 95 | function modifyVueSource(sourceFile: ts.SourceFile): void { 96 | // 1. add `import Vue from './vue' 97 | // 2. find the export default and wrap it in `new Vue(...)` if it exists and is an object literal 98 | //logger.info(sourceFile.getStart() + "-" + sourceFile.getEnd()); 99 | const exportDefaultObject = find(sourceFile.statements, st => st.kind === ts.SyntaxKind.ExportAssignment && 100 | (st as ts.ExportAssignment).expression.kind === ts.SyntaxKind.ObjectLiteralExpression); 101 | var b = (n: T) => ts.setTextRange(n, { pos: 0, end: 0 }); 102 | if (exportDefaultObject) { 103 | //logger.info(exportDefaultObject.toString()); 104 | const vueImport = b(ts.createImportDeclaration(undefined, 105 | undefined, 106 | b(ts.createImportClause(b(ts.createIdentifier("Vue")), undefined)), 107 | b(ts.createLiteral("vue")))); 108 | sourceFile.statements.unshift(vueImport); 109 | const obj = (exportDefaultObject as ts.ExportAssignment).expression as ts.ObjectLiteralExpression; 110 | (exportDefaultObject as ts.ExportAssignment).expression = ts.setTextRange(ts.createNew(ts.setTextRange(ts.createIdentifier("Vue"), { pos: obj.pos, end: obj.pos + 1 }), 111 | undefined, 112 | [obj]), 113 | obj); 114 | ts.setTextRange(((exportDefaultObject as ts.ExportAssignment).expression as ts.NewExpression).arguments, obj); 115 | } 116 | } 117 | 118 | function getExternalFiles(project: ts_module.server.ConfiguredProject) { 119 | return project.getFileNames().filter(interested); 120 | } 121 | } 122 | 123 | export = init; 124 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vue-ts-plugin", 3 | "version": "0.1.0", 4 | "description": "TypeScript Language Service Plugin for Vue", 5 | "main": "bin/index.js", 6 | "scripts": { 7 | "prepublish": "node node_modules/typescript/lib/tsc", 8 | "test": "echo \"Error: no test specified\" && exit 1" 9 | }, 10 | "repository": { 11 | "type": "git", 12 | "url": "git+https://github.com/sandersn/vue-ts-plugin.git" 13 | }, 14 | "keywords": [ 15 | "typescript", 16 | "vue" 17 | ], 18 | "author": "Nathan Shively-Sanders", 19 | "license": "Apache-2.0", 20 | "bugs": { 21 | "url": "https://github.com/sandersn/vue-ts-plugin/issues" 22 | }, 23 | "homepage": "https://github.com/sandersn/vue-ts-plugin#readme", 24 | "devDependencies": { 25 | "@types/node": "^7.0.5", 26 | "typescript": "^2.2.0-dev.20170213" 27 | }, 28 | "dependencies": { 29 | "vue-template-compiler": "^2.2.1" 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "target": "es5", 5 | "noImplicitAny": false, 6 | "sourceMap": false, 7 | "outDir": "bin" 8 | } 9 | } --------------------------------------------------------------------------------