├── docs ├── linux-install.md ├── mac-install.md ├── windows-install.md └── README.md ├── client ├── testFixture │ ├── completion.txt │ └── diagnostics.txt ├── tsconfig.json ├── package.json ├── src │ ├── test │ │ ├── runTest.ts │ │ ├── index.ts │ │ ├── completion.test.ts │ │ ├── helper.ts │ │ └── diagnostics.test.ts │ └── extension.ts └── package-lock.json ├── images ├── demo.gif ├── logo.png └── settings.jpeg ├── .vscode ├── extensions.json ├── settings.json ├── tasks.json └── launch.json ├── scripts └── e2e.sh ├── server ├── tsconfig.json ├── package.json ├── package-lock.json └── src │ └── server.ts ├── tsconfig.json ├── README.md ├── package.json ├── .gitignore └── LICENSE /docs/linux-install.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/mac-install.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/windows-install.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /client/testFixture/completion.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /client/testFixture/diagnostics.txt: -------------------------------------------------------------------------------- 1 | ANY browsers, ANY OS. -------------------------------------------------------------------------------- /images/demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mymusise/vscode-writer-assistant/HEAD/images/demo.gif -------------------------------------------------------------------------------- /images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mymusise/vscode-writer-assistant/HEAD/images/logo.png -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | 3 | "recommendations": [ 4 | "dbaeumer.vscode-eslint" 5 | ] 6 | } -------------------------------------------------------------------------------- /images/settings.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mymusise/vscode-writer-assistant/HEAD/images/settings.jpeg -------------------------------------------------------------------------------- /scripts/e2e.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | export CODE_TESTS_PATH="$(pwd)/client/out/test" 4 | export CODE_TESTS_WORKSPACE="$(pwd)/client/testFixture" 5 | 6 | node "$(pwd)/client/out/test/runTest" -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "editor.insertSpaces": false, 3 | "tslint.enable": true, 4 | "typescript.tsc.autoDetect": "off", 5 | "typescript.preferences.quoteStyle": "single", 6 | "editor.codeActionsOnSave": { 7 | "source.fixAll.eslint": true 8 | } 9 | } -------------------------------------------------------------------------------- /client/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "target": "es2019", 5 | "lib": ["ES2019"], 6 | "outDir": "out", 7 | "rootDir": "src", 8 | "sourceMap": true 9 | }, 10 | "include": ["src"], 11 | "exclude": ["node_modules", ".vscode-test"] 12 | } 13 | -------------------------------------------------------------------------------- /server/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es2019", 4 | "lib": ["ES2019"], 5 | "module": "commonjs", 6 | "moduleResolution": "node", 7 | "sourceMap": true, 8 | "strict": true, 9 | "outDir": "out", 10 | "rootDir": "src" 11 | }, 12 | "include": ["src"], 13 | "exclude": ["node_modules", ".vscode-test"] 14 | } 15 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "target": "es2019", 5 | "lib": ["ES2019"], 6 | "outDir": "out", 7 | "rootDir": "src", 8 | "sourceMap": true 9 | }, 10 | "include": [ 11 | "src" 12 | ], 13 | "exclude": [ 14 | "node_modules", 15 | ".vscode-test" 16 | ], 17 | "references": [ 18 | { "path": "./client" }, 19 | { "path": "./server" } 20 | ] 21 | } -------------------------------------------------------------------------------- /server/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "writer-assistant-server", 3 | "description": "Help writer write faster.", 4 | "version": "0.0.1", 5 | "author": "mymusise", 6 | "publisher": "mymusise", 7 | "license": "MIT", 8 | "engines": { 9 | "node": "*", 10 | "vscode": "^1.52.0" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "https://github.com/mymusise/vscode-writer-assistant" 15 | }, 16 | "dependencies": { 17 | "vscode-languageserver": "^7.0.0", 18 | "vscode-languageserver-textdocument": "^1.0.1" 19 | }, 20 | "scripts": {} 21 | } 22 | -------------------------------------------------------------------------------- /client/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "writer-assistant-client", 3 | "description": "Help writer write faster", 4 | "author": "mymusise", 5 | "license": "MIT", 6 | "version": "0.0.1", 7 | "publisher": "mymusise", 8 | "repository": { 9 | "type": "git", 10 | "url": "https://github.com/mymusise/vscode-writer-assistant" 11 | }, 12 | "engines": { 13 | "vscode": "^1.52.0" 14 | }, 15 | "dependencies": { 16 | "vscode-languageclient": "^7.0.0" 17 | }, 18 | "devDependencies": { 19 | "@types/vscode": "^1.52.0", 20 | "vscode-test": "^1.3.0" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # 安装部署手册 2 | 3 | - windows用户参考: [windows-install.md](windows-install.md) 4 | - linux用户参考: [linux-install.md](linux-install.md) 5 | - mac用户参考: [mac-install.md](mac-install.md) 6 | 7 | # 镜像下载 8 | 9 | 通过docker官方镜像站下载(pull)比较慢, 可以通过百度云下载离线镜像进行加载: 10 | 11 | - 下载镜像 12 | 13 | 链接: https://pan.baidu.com/s/13Ki4OU7XHaVPoAxj-8gLZA 提取码: 9asb 14 | 15 | - 加载镜像 16 | 17 | 对下载好的镜像进行加载 18 | ```bash 19 | docker load -i writer-assistant-server.tar 20 | ``` 21 | 22 | - 启动镜像 23 | 24 | ```bash 25 | docker run -d -p 23423:80 --name writer-assistant-server mymusise/writer-assistant-server 26 | ``` 27 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "type": "npm", 6 | "script": "compile", 7 | "group": "build", 8 | "presentation": { 9 | "panel": "dedicated", 10 | "reveal": "never" 11 | }, 12 | "problemMatcher": [ 13 | "$tsc" 14 | ] 15 | }, 16 | { 17 | "type": "npm", 18 | "script": "watch", 19 | "isBackground": true, 20 | "group": { 21 | "kind": "build", 22 | "isDefault": true 23 | }, 24 | "presentation": { 25 | "panel": "dedicated", 26 | "reveal": "never" 27 | }, 28 | "problemMatcher": [ 29 | "$tsc-watch" 30 | ] 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /client/src/test/runTest.ts: -------------------------------------------------------------------------------- 1 | import * as path from 'path'; 2 | 3 | import { runTests } from 'vscode-test'; 4 | 5 | async function main() { 6 | try { 7 | // The folder containing the Extension Manifest package.json 8 | // Passed to `--extensionDevelopmentPath` 9 | const extensionDevelopmentPath = path.resolve(__dirname, '../../../'); 10 | 11 | // The path to test runner 12 | // Passed to --extensionTestsPath 13 | const extensionTestsPath = path.resolve(__dirname, './index'); 14 | 15 | // Download VS Code, unzip it and run the integration test 16 | await runTests({ extensionDevelopmentPath, extensionTestsPath }); 17 | } catch (err) { 18 | console.error('Failed to run tests'); 19 | process.exit(1); 20 | } 21 | } 22 | 23 | main(); -------------------------------------------------------------------------------- /client/src/test/index.ts: -------------------------------------------------------------------------------- 1 | import * as path from 'path'; 2 | import * as Mocha from 'mocha'; 3 | import * as glob from 'glob'; 4 | 5 | export function run(): Promise { 6 | // Create the mocha test 7 | const mocha = new Mocha({ 8 | ui: 'tdd', 9 | color: true 10 | }); 11 | mocha.timeout(100000); 12 | 13 | const testsRoot = __dirname; 14 | 15 | return new Promise((resolve, reject) => { 16 | glob('**.test.js', { cwd: testsRoot }, (err, files) => { 17 | if (err) { 18 | return reject(err); 19 | } 20 | 21 | // Add files to the test suite 22 | files.forEach(f => mocha.addFile(path.resolve(testsRoot, f))); 23 | 24 | try { 25 | // Run the mocha test 26 | mocha.run(failures => { 27 | if (failures > 0) { 28 | reject(new Error(`${failures} tests failed.`)); 29 | } else { 30 | resolve(); 31 | } 32 | }); 33 | } catch (err) { 34 | console.error(err); 35 | reject(err); 36 | } 37 | }); 38 | }); 39 | } -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | // A launch configuration that compiles the extension and then opens it inside a new window 2 | { 3 | "version": "0.2.0", 4 | "configurations": [ 5 | { 6 | "type": "extensionHost", 7 | "request": "launch", 8 | "name": "Launch Client", 9 | "runtimeExecutable": "${execPath}", 10 | "args": ["--extensionDevelopmentPath=${workspaceRoot}"], 11 | "outFiles": ["${workspaceRoot}/client/out/**/*.js"], 12 | "preLaunchTask": { 13 | "type": "npm", 14 | "script": "watch" 15 | } 16 | }, 17 | { 18 | "type": "node", 19 | "request": "attach", 20 | "name": "Attach to Server", 21 | "port": 6009, 22 | "restart": true, 23 | "outFiles": ["${workspaceRoot}/server/out/**/*.js"] 24 | }, 25 | { 26 | "name": "Language Server E2E Test", 27 | "type": "extensionHost", 28 | "request": "launch", 29 | "runtimeExecutable": "${execPath}", 30 | "args": [ 31 | "--extensionDevelopmentPath=${workspaceRoot}", 32 | "--extensionTestsPath=${workspaceRoot}/client/out/test/index", 33 | "${workspaceRoot}/client/testFixture" 34 | ], 35 | "outFiles": ["${workspaceRoot}/client/out/test/**/*.js"] 36 | } 37 | ], 38 | "compounds": [ 39 | { 40 | "name": "Client + Server", 41 | "configurations": ["Launch Client", "Attach to Server"] 42 | } 43 | ] 44 | } 45 | -------------------------------------------------------------------------------- /client/src/test/completion.test.ts: -------------------------------------------------------------------------------- 1 | 2 | import * as vscode from 'vscode'; 3 | import * as assert from 'assert'; 4 | import { getDocUri, activate } from './helper'; 5 | 6 | suite('Should do completion', () => { 7 | const docUri = getDocUri('completion.txt'); 8 | 9 | test('Completes JS/TS in txt file', async () => { 10 | await testCompletion(docUri, new vscode.Position(0, 0), { 11 | items: [ 12 | { label: 'JavaScript', kind: vscode.CompletionItemKind.Text }, 13 | { label: 'TypeScript', kind: vscode.CompletionItemKind.Text } 14 | ] 15 | }); 16 | }); 17 | }); 18 | 19 | async function testCompletion( 20 | docUri: vscode.Uri, 21 | position: vscode.Position, 22 | expectedCompletionList: vscode.CompletionList 23 | ) { 24 | await activate(docUri); 25 | 26 | // Executing the command `vscode.executeCompletionItemProvider` to simulate triggering completion 27 | const actualCompletionList = (await vscode.commands.executeCommand( 28 | 'vscode.executeCompletionItemProvider', 29 | docUri, 30 | position 31 | )) as vscode.CompletionList; 32 | 33 | assert.ok(actualCompletionList.items.length >= 2); 34 | expectedCompletionList.items.forEach((expectedItem, i) => { 35 | const actualItem = actualCompletionList.items[i]; 36 | assert.equal(actualItem.label, expectedItem.label); 37 | assert.equal(actualItem.kind, expectedItem.kind); 38 | }); 39 | } 40 | -------------------------------------------------------------------------------- /client/src/test/helper.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from 'vscode'; 2 | import * as path from 'path'; 3 | 4 | export let doc: vscode.TextDocument; 5 | export let editor: vscode.TextEditor; 6 | export let documentEol: string; 7 | export let platformEol: string; 8 | 9 | /** 10 | * Activates the vscode.writer-assistant extension 11 | */ 12 | export async function activate(docUri: vscode.Uri) { 13 | // The extensionId is `publisher.name` from package.json 14 | const ext = vscode.extensions.getExtension('writer-assistant')!; 15 | await ext.activate(); 16 | try { 17 | doc = await vscode.workspace.openTextDocument(docUri); 18 | editor = await vscode.window.showTextDocument(doc); 19 | await sleep(2000); // Wait for server activation 20 | } catch (e) { 21 | console.error(e); 22 | } 23 | } 24 | 25 | async function sleep(ms: number) { 26 | return new Promise(resolve => setTimeout(resolve, ms)); 27 | } 28 | 29 | export const getDocPath = (p: string) => { 30 | return path.resolve(__dirname, '../../testFixture', p); 31 | }; 32 | export const getDocUri = (p: string) => { 33 | return vscode.Uri.file(getDocPath(p)); 34 | }; 35 | 36 | export async function setTestContent(content: string): Promise { 37 | const all = new vscode.Range( 38 | doc.positionAt(0), 39 | doc.positionAt(doc.getText().length) 40 | ); 41 | return editor.edit(eb => eb.replace(all, content)); 42 | } 43 | -------------------------------------------------------------------------------- /client/src/test/diagnostics.test.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from 'vscode'; 2 | import * as assert from 'assert'; 3 | import { getDocUri, activate } from './helper'; 4 | 5 | suite('Should get diagnostics', () => { 6 | const docUri = getDocUri('diagnostics.txt'); 7 | 8 | test('Diagnoses uppercase texts', async () => { 9 | await testDiagnostics(docUri, [ 10 | { message: 'ANY is all uppercase.', range: toRange(0, 0, 0, 3), severity: vscode.DiagnosticSeverity.Warning, source: 'ex' }, 11 | { message: 'ANY is all uppercase.', range: toRange(0, 14, 0, 17), severity: vscode.DiagnosticSeverity.Warning, source: 'ex' }, 12 | { message: 'OS is all uppercase.', range: toRange(0, 18, 0, 20), severity: vscode.DiagnosticSeverity.Warning, source: 'ex' } 13 | ]); 14 | }); 15 | }); 16 | 17 | function toRange(sLine: number, sChar: number, eLine: number, eChar: number) { 18 | const start = new vscode.Position(sLine, sChar); 19 | const end = new vscode.Position(eLine, eChar); 20 | return new vscode.Range(start, end); 21 | } 22 | 23 | async function testDiagnostics(docUri: vscode.Uri, expectedDiagnostics: vscode.Diagnostic[]) { 24 | await activate(docUri); 25 | 26 | const actualDiagnostics = vscode.languages.getDiagnostics(docUri); 27 | 28 | assert.equal(actualDiagnostics.length, expectedDiagnostics.length); 29 | 30 | expectedDiagnostics.forEach((expectedDiagnostic, i) => { 31 | const actualDiagnostic = actualDiagnostics[i]; 32 | assert.equal(actualDiagnostic.message, expectedDiagnostic.message); 33 | assert.deepEqual(actualDiagnostic.range, expectedDiagnostic.range); 34 | assert.equal(actualDiagnostic.severity, expectedDiagnostic.severity); 35 | }); 36 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Writer Assistant 2 | 3 | 一款基于生成模型GPT-2的写作助手，旨在提高写作速度和增加写作灵感。目前依托vscode平台，作为插件辅助用户写作使用。 4 | 5 | ## 效果 6 | 7 | ![](https://github.com/mymusise/vscode-writer-assistant/raw/main/images/demo.gif) 8 | 9 | ## 使用 10 | 11 | 打开需要编辑的TXT文件， 编辑一个开头后，追加一个空格符 `_` ， 然后按 `Ctrl` + `I` 续写文章。例如： 输入”今天... 我们“上文后，需要在后面追加一个空格”今天... 我们 “，才能进行续写。 12 | 13 | > 注意：打开的文本后缀必须是.txt, 新建的文本需要保存后才能自动续写。 14 | 15 | ## 安装 16 | 17 | ### 插件安装 18 | 19 | 通过[vscode市场](https://marketplace.visualstudio.com/items?itemName=mymusise.writer-assistant)搜索 `writer-assistant` 可以直接安装插件, 也可以通过[下载插件](https://github.com/mymusise/vscode-writer-assistant/releases/download/v0.1/writer-assistant-0.1.0.vsix)进行手动安装。 20 | 21 | 插件默认的服务是在线的，目前跑在一台只有两核的服务器上T^T，所有有时候请求会比较慢，如果想提高性能，可以通过本地部署服务来提升体验。 22 | 23 | ### 本地部署服务 24 | 25 | 通过本地部署服务和配置 26 | 27 | * 可以提高服务的响应速度，当然这个也取决于本地机器的性能。 28 | * 本地部署还可以突破补全字数以及推荐的句子数的限制。 29 | 30 | #### **Docker环境安装** 31 | 32 | 服务运行需要Docker环境，如果你的机器没有Docker, 下载安装参考[官网](https://docs.docker.com/get-docker/) 33 | 34 | #### **启动服务** 35 | 36 | 已经打包成镜像，可以直接pull下来运行。 37 | 38 | ``` bash 39 | docker run -d -p 23423:80 --name writer-assistant-server mymusise/writer-assistant-server 40 | ``` 41 | 42 | 更具体的安装过程参考[详细文档](docs/README.md) 43 | 44 | ## 设置参数 45 | 46 | * `serverAddress`: 后台服务地址，本地部署后填写本地地址 47 | * `maxContext`: 最大参考上下文长度（只参考上文） 48 | * `maxLength`: 生成文本的最大长度（通用服务最长长度为8, 本地部署最长支持128） 49 | * `numSuggest`: 推荐的句子数（通用服务一次最多推荐3个句子, 本地部署不受限制） 50 | 51 | ![图](https://github.com/mymusise/vscode-writer-assistant/raw/main/images/settings.jpeg) 52 | 53 | 54 | ## 关于模型 55 | 56 | - 模型原型： [GPT-2](https://openai.com/blog/better-language-models/) 57 | - 数据源： [nlp_chinese_corpus](https://github.com/brightmart/nlp_chinese_corpus) 58 | - 训练代码： https://github.com/mymusise/gpt2-quickly 59 | 60 | ### 声明 61 | 62 | 项目用到的数据均来源网络，本项目未进行任何商业目的。本项目遵从[GPL协议](LICENSE)，引用请注明出处。 63 | -------------------------------------------------------------------------------- /server/package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "writer-assistant-server", 3 | "version": "1.0.0", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "vscode-jsonrpc": { 8 | "version": "6.0.0", 9 | "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-6.0.0.tgz", 10 | "integrity": "sha512-wnJA4BnEjOSyFMvjZdpiOwhSq9uDoK8e/kpRJDTaMYzwlkrhG1fwDIZI94CLsLzlCK5cIbMMtFlJlfR57Lavmg==" 11 | }, 12 | "vscode-languageserver": { 13 | "version": "7.0.0", 14 | "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-7.0.0.tgz", 15 | "integrity": "sha512-60HTx5ID+fLRcgdHfmz0LDZAXYEV68fzwG0JWwEPBode9NuMYTIxuYXPg4ngO8i8+Ou0lM7y6GzaYWbiDL0drw==", 16 | "requires": { 17 | "vscode-languageserver-protocol": "3.16.0" 18 | } 19 | }, 20 | "vscode-languageserver-protocol": { 21 | "version": "3.16.0", 22 | "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.16.0.tgz", 23 | "integrity": "sha512-sdeUoAawceQdgIfTI+sdcwkiK2KU+2cbEYA0agzM2uqaUy2UpnnGHtWTHVEtS0ES4zHU0eMFRGN+oQgDxlD66A==", 24 | "requires": { 25 | "vscode-jsonrpc": "6.0.0", 26 | "vscode-languageserver-types": "3.16.0" 27 | } 28 | }, 29 | "vscode-languageserver-textdocument": { 30 | "version": "1.0.1", 31 | "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.1.tgz", 32 | "integrity": "sha512-UIcJDjX7IFkck7cSkNNyzIz5FyvpQfY7sdzVy+wkKN/BLaD4DQ0ppXQrKePomCxTS7RrolK1I0pey0bG9eh8dA==" 33 | }, 34 | "vscode-languageserver-types": { 35 | "version": "3.16.0", 36 | "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.16.0.tgz", 37 | "integrity": "sha512-k8luDIWJWyenLc5ToFQQMaSrqCHiLwyKPHKPQZ5zz21vM+vIVUSvsRpcbiECH4WR88K2XZqc4ScRcZ7nk/jbeA==" 38 | } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "writer-assistant", 3 | "description": "Help writer write faster", 4 | "icon": "images/logo.png", 5 | "author": "mymusise", 6 | "license": "MIT", 7 | "version": "0.1.0", 8 | "repository": { 9 | "type": "git", 10 | "url": "https://github.com/mymusise/vscode-writer-assistant" 11 | }, 12 | "publisher": "mymusise", 13 | "categories": [], 14 | "keywords": [ 15 | "multi-root ready" 16 | ], 17 | "engines": { 18 | "vscode": "^1.43.0" 19 | }, 20 | "activationEvents": [ 21 | "onLanguage:plaintext" 22 | ], 23 | "main": "./client/out/extension", 24 | "contributes": { 25 | "configuration": { 26 | "type": "object", 27 | "title": "Example configuration", 28 | "properties": { 29 | "compositionAssistant.serverAddress": { 30 | "scope": "resource", 31 | "type": "string", 32 | "default": "https://wrlp.mymusise.com", 33 | "description": "生成服务地址." 34 | }, 35 | "compositionAssistant.maxContext": { 36 | "scope": "resource", 37 | "type": "number", 38 | "default": 128, 39 | "description": "最大参考上下文长度." 40 | }, 41 | "compositionAssistant.maxLength": { 42 | "scope": "resource", 43 | "type": "number", 44 | "default": 8, 45 | "description": "生成文本的长度." 46 | }, 47 | "compositionAssistant.numSuggest": { 48 | "scope": "resource", 49 | "type": "number", 50 | "default": 3, 51 | "description": "生成的句子数量." 52 | } 53 | } 54 | } 55 | }, 56 | "scripts": { 57 | "vscode:prepublish": "npm run compile", 58 | "compile": "tsc -b", 59 | "watch": "tsc -b -w", 60 | "postinstall": "cd client && npm install && cd ../server && npm install && cd ..", 61 | "test": "sh ./scripts/e2e.sh" 62 | }, 63 | "devDependencies": { 64 | "@types/mocha": "^8.0.3", 65 | "mocha": "^8.1.1", 66 | "@types/node": "^12.12.0", 67 | "eslint": "^6.4.0", 68 | "@typescript-eslint/parser": "^2.3.0", 69 | "typescript": "^4.0.2" 70 | }, 71 | "dependencies": { 72 | "axios": "^0.21.1", 73 | "got": "^11.8.1" 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /client/src/extension.ts: -------------------------------------------------------------------------------- 1 | import * as path from 'path'; 2 | import { workspace, ExtensionContext } from 'vscode'; 3 | 4 | import { 5 | LanguageClient, 6 | LanguageClientOptions, 7 | ServerOptions, 8 | TransportKind 9 | } from 'vscode-languageclient/node'; 10 | 11 | let client: LanguageClient; 12 | 13 | export function activate(context: ExtensionContext) { 14 | // The server is implemented in node 15 | let serverModule = context.asAbsolutePath( 16 | path.join('server', 'out', 'server.js') 17 | ); 18 | // The debug options for the server 19 | // --inspect=6009: runs the server in Node's Inspector mode so VS Code can attach to the server for debugging 20 | let debugOptions = { execArgv: ['--nolazy', '--inspect=6009'] }; 21 | 22 | // If the extension is launched in debug mode then the debug server options are used 23 | // Otherwise the run options are used 24 | let serverOptions: ServerOptions = { 25 | run: { module: serverModule, transport: TransportKind.ipc }, 26 | debug: { 27 | module: serverModule, 28 | transport: TransportKind.ipc, 29 | options: debugOptions 30 | } 31 | }; 32 | 33 | // Options to control the language client 34 | let clientOptions: LanguageClientOptions = { 35 | // Register the server for plain text documents 36 | documentSelector: [{ scheme: 'file', language: 'plaintext' }], 37 | synchronize: { 38 | // Notify the server about file changes to '.clientrc files contained in the workspace 39 | fileEvents: workspace.createFileSystemWatcher('**/.clientrc') 40 | } 41 | }; 42 | 43 | // Create the language client and start the client. 44 | client = new LanguageClient( 45 | 'languageServerExample', 46 | 'Language Server Example', 47 | serverOptions, 48 | clientOptions 49 | ); 50 | 51 | // Start the client. This will also launch the server 52 | client.start(); 53 | } 54 | 55 | export function deactivate(): Thenable | undefined { 56 | if (!client) { 57 | return undefined; 58 | } 59 | return client.stop(); 60 | } 61 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | # vscode 107 | *.vsix 108 | 109 | # vscode extension 110 | client/out/* 111 | server/out/* 112 | -------------------------------------------------------------------------------- /server/src/server.ts: -------------------------------------------------------------------------------- 1 | import { 2 | createConnection, 3 | TextDocuments, 4 | ProposedFeatures, 5 | InitializeParams, 6 | DidChangeConfigurationNotification, 7 | CompletionItem, 8 | CompletionItemKind, 9 | TextDocumentPositionParams, 10 | TextDocumentSyncKind, 11 | InitializeResult, 12 | Position, 13 | Range 14 | } from 'vscode-languageserver/node'; 15 | 16 | import { 17 | TextDocument, 18 | } from 'vscode-languageserver-textdocument'; 19 | import axios from "axios"; 20 | // Create a connection for the server, using Node's IPC as a transport. 21 | // Also include all preview / proposed LSP features. 22 | let connection = createConnection(ProposedFeatures.all); 23 | 24 | // Create a simple text document manager. 25 | let documents: TextDocuments = new TextDocuments(TextDocument); 26 | 27 | let hasConfigurationCapability: boolean = false; 28 | let hasWorkspaceFolderCapability: boolean = false; 29 | let hasDiagnosticRelatedInformationCapability: boolean = false; 30 | 31 | connection.onInitialize((params: InitializeParams) => { 32 | let capabilities = params.capabilities; 33 | 34 | // Does the client support the `workspace/configuration` request? 35 | // If not, we fall back using global settings. 36 | hasConfigurationCapability = !!( 37 | 38 | capabilities.workspace && !!capabilities.workspace.configuration 39 | ); 40 | hasWorkspaceFolderCapability = !!( 41 | capabilities.workspace && !!capabilities.workspace.workspaceFolders 42 | ); 43 | hasDiagnosticRelatedInformationCapability = !!( 44 | capabilities.textDocument && 45 | capabilities.textDocument.publishDiagnostics && 46 | capabilities.textDocument.publishDiagnostics.relatedInformation 47 | ); 48 | 49 | const result: InitializeResult = { 50 | capabilities: { 51 | textDocumentSync: TextDocumentSyncKind.Incremental, 52 | // Tell the client that this server supports code completion. 53 | completionProvider: { 54 | // resolveProvider: true, 55 | // triggerCharacters: [',', '。', '！'], 56 | // allCommitCharacters: [',', '。', '！'], 57 | } 58 | } 59 | }; 60 | if (hasWorkspaceFolderCapability) { 61 | result.capabilities.workspace = { 62 | workspaceFolders: { 63 | supported: true 64 | } 65 | }; 66 | } 67 | return result; 68 | }); 69 | 70 | connection.onInitialized(() => { 71 | if (hasConfigurationCapability) { 72 | // Register for all configuration changes. 73 | connection.client.register(DidChangeConfigurationNotification.type, undefined); 74 | } 75 | if (hasWorkspaceFolderCapability) { 76 | connection.workspace.onDidChangeWorkspaceFolders(_event => { 77 | connection.console.log('Workspace folder change event received.'); 78 | }); 79 | } 80 | }); 81 | 82 | interface ExampleSettings { 83 | maxContext: number, 84 | serverAddress: string, 85 | maxLength: number, 86 | numSuggest: number, 87 | } 88 | 89 | const defaultSettings: ExampleSettings = { maxContext:128, maxLength:8 , serverAddress: 'https://wrlp.mymusise.com', numSuggest: 3}; 90 | let globalSettings: ExampleSettings = defaultSettings; 91 | 92 | // Cache the settings of all open documents 93 | let documentSettings: Map> = new Map(); 94 | 95 | connection.onDidChangeConfiguration(change => { 96 | if (hasConfigurationCapability) { 97 | // Reset all cached document settings 98 | documentSettings.clear(); 99 | } else { 100 | globalSettings = ( 101 | (change.settings.languageServerExample || defaultSettings) 102 | ); 103 | } 104 | 105 | }); 106 | 107 | 108 | // Only keep settings for open documents 109 | documents.onDidClose(e => { 110 | documentSettings.delete(e.document.uri); 111 | }); 112 | 113 | // The content of a text document has changed. This event is emitted 114 | // when the text document first opened or when its content has changed. 115 | 116 | 117 | 118 | function getDocumentSettings(resource: string): Thenable { 119 | if (!hasConfigurationCapability) { 120 | return Promise.resolve(globalSettings); 121 | } 122 | let result = documentSettings.get(resource); 123 | if (!result) { 124 | result = connection.workspace.getConfiguration({ 125 | scopeUri: resource, 126 | section: 'compositionAssistant' 127 | }); 128 | documentSettings.set(resource, result); 129 | } 130 | return result; 131 | } 132 | 133 | 134 | connection.onDidChangeWatchedFiles(_change => { 135 | // Monitored files have change in VSCode 136 | connection.console.log('We received an file change event'); 137 | }); 138 | 139 | 140 | connection.onCompletion( 141 | async (_textDocumentPosition: TextDocumentPositionParams) => { 142 | 143 | const document = documents.get(_textDocumentPosition.textDocument.uri); 144 | if (!document) { 145 | return []; 146 | } 147 | let settings = await getDocumentSettings(_textDocumentPosition.textDocument.uri); 148 | 149 | const position = _textDocumentPosition.position; 150 | let start_position = Position.create(position.line, 0) 151 | if (position.line > 0 && position.character < settings.maxContext){ 152 | start_position = Position.create(position.line - 1, 0) 153 | } 154 | const end_position = Position.create(position.line, position.character) 155 | const range = Range.create(start_position, end_position) 156 | const current = document.getText(range).slice(-settings.maxContext, ) 157 | 158 | if (!current.endsWith(' ')) { 159 | return [] 160 | } 161 | 162 | const res = await axios.get(`${settings.serverAddress}/model/suggest/`, { 163 | params: { 164 | current: current, 165 | max_length: settings.maxLength, 166 | num_suggest: settings.numSuggest, 167 | } 168 | }) 169 | 170 | let completions: CompletionItem[] = [] 171 | res.data.forEach((element: string, i: Number) => { 172 | completions.push({ 173 | label: element, 174 | kind: CompletionItemKind.Text, 175 | }) 176 | }); 177 | return completions 178 | 179 | } 180 | ); 181 | 182 | connection.onCompletionResolve( 183 | (item: CompletionItem): CompletionItem => { 184 | // if (item.data === 1) { 185 | // item.detail = 'TypeScript details'; 186 | // item.documentation = 'TypeScript documentation'; 187 | // } else if (item.data === 2) { 188 | // item.detail = 'JavaScript details'; 189 | // item.documentation = 'JavaScript documentation'; 190 | // } 191 | return item; 192 | } 193 | ); 194 | 195 | 196 | // Make the text document manager listen on the connection 197 | // for open, change and close text document events 198 | documents.listen(connection); 199 | 200 | // Listen on the connection 201 | connection.listen(); 202 | -------------------------------------------------------------------------------- /client/package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "writer-assistant-client", 3 | "version": "0.0.1", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "@types/vscode": { 8 | "version": "1.52.0", 9 | "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.52.0.tgz", 10 | "integrity": "sha512-Kt3bvWzAvvF/WH9YEcrCICDp0Z7aHhJGhLJ1BxeyNP6yRjonWqWnAIh35/pXAjswAnWOABrYlF7SwXR9+1nnLA==", 11 | "dev": true 12 | }, 13 | "agent-base": { 14 | "version": "4.3.0", 15 | "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-4.3.0.tgz", 16 | "integrity": "sha512-salcGninV0nPrwpGNn4VTXBb1SOuXQBiqbrNXoeizJsHrsL6ERFM2Ne3JUSBWRE6aeNJI2ROP/WEEIDUiDe3cg==", 17 | "dev": true, 18 | "requires": { 19 | "es6-promisify": "^5.0.0" 20 | } 21 | }, 22 | "balanced-match": { 23 | "version": "1.0.0", 24 | "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", 25 | "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=" 26 | }, 27 | "brace-expansion": { 28 | "version": "1.1.11", 29 | "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", 30 | "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", 31 | "requires": { 32 | "balanced-match": "^1.0.0", 33 | "concat-map": "0.0.1" 34 | } 35 | }, 36 | "concat-map": { 37 | "version": "0.0.1", 38 | "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", 39 | "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" 40 | }, 41 | "debug": { 42 | "version": "3.1.0", 43 | "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", 44 | "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", 45 | "dev": true, 46 | "requires": { 47 | "ms": "2.0.0" 48 | } 49 | }, 50 | "es6-promise": { 51 | "version": "4.2.8", 52 | "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.8.tgz", 53 | "integrity": "sha512-HJDGx5daxeIvxdBxvG2cb9g4tEvwIk3i8+nhX0yGrYmZUzbkdg8QbDevheDB8gd0//uPj4c1EQua8Q+MViT0/w==", 54 | "dev": true 55 | }, 56 | "es6-promisify": { 57 | "version": "5.0.0", 58 | "resolved": "https://registry.npmjs.org/es6-promisify/-/es6-promisify-5.0.0.tgz", 59 | "integrity": "sha1-UQnWLz5W6pZ8S2NQWu8IKRyKUgM=", 60 | "dev": true, 61 | "requires": { 62 | "es6-promise": "^4.0.3" 63 | } 64 | }, 65 | "fs.realpath": { 66 | "version": "1.0.0", 67 | "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", 68 | "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", 69 | "dev": true 70 | }, 71 | "glob": { 72 | "version": "7.1.6", 73 | "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", 74 | "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", 75 | "dev": true, 76 | "requires": { 77 | "fs.realpath": "^1.0.0", 78 | "inflight": "^1.0.4", 79 | "inherits": "2", 80 | "minimatch": "^3.0.4", 81 | "once": "^1.3.0", 82 | "path-is-absolute": "^1.0.0" 83 | } 84 | }, 85 | "http-proxy-agent": { 86 | "version": "2.1.0", 87 | "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-2.1.0.tgz", 88 | "integrity": "sha512-qwHbBLV7WviBl0rQsOzH6o5lwyOIvwp/BdFnvVxXORldu5TmjFfjzBcWUWS5kWAZhmv+JtiDhSuQCp4sBfbIgg==", 89 | "dev": true, 90 | "requires": { 91 | "agent-base": "4", 92 | "debug": "3.1.0" 93 | } 94 | }, 95 | "https-proxy-agent": { 96 | "version": "2.2.4", 97 | "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-2.2.4.tgz", 98 | "integrity": "sha512-OmvfoQ53WLjtA9HeYP9RNrWMJzzAz1JGaSFr1nijg0PVR1JaD/xbJq1mdEIIlxGpXp9eSe/O2LgU9DJmTPd0Eg==", 99 | "dev": true, 100 | "requires": { 101 | "agent-base": "^4.3.0", 102 | "debug": "^3.1.0" 103 | } 104 | }, 105 | "inflight": { 106 | "version": "1.0.6", 107 | "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", 108 | "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", 109 | "dev": true, 110 | "requires": { 111 | "once": "^1.3.0", 112 | "wrappy": "1" 113 | } 114 | }, 115 | "inherits": { 116 | "version": "2.0.4", 117 | "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", 118 | "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", 119 | "dev": true 120 | }, 121 | "lru-cache": { 122 | "version": "6.0.0", 123 | "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", 124 | "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", 125 | "requires": { 126 | "yallist": "^4.0.0" 127 | } 128 | }, 129 | "minimatch": { 130 | "version": "3.0.4", 131 | "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", 132 | "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", 133 | "requires": { 134 | "brace-expansion": "^1.1.7" 135 | } 136 | }, 137 | "ms": { 138 | "version": "2.0.0", 139 | "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", 140 | "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", 141 | "dev": true 142 | }, 143 | "once": { 144 | "version": "1.4.0", 145 | "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", 146 | "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", 147 | "dev": true, 148 | "requires": { 149 | "wrappy": "1" 150 | } 151 | }, 152 | "path-is-absolute": { 153 | "version": "1.0.1", 154 | "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", 155 | "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", 156 | "dev": true 157 | }, 158 | "rimraf": { 159 | "version": "2.7.1", 160 | "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz", 161 | "integrity": "sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w==", 162 | "dev": true, 163 | "requires": { 164 | "glob": "^7.1.3" 165 | } 166 | }, 167 | "semver": { 168 | "version": "7.3.4", 169 | "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.4.tgz", 170 | "integrity": "sha512-tCfb2WLjqFAtXn4KEdxIhalnRtoKFN7nAwj0B3ZXCbQloV2tq5eDbcTmT68JJD3nRJq24/XgxtQKFIpQdtvmVw==", 171 | "requires": { 172 | "lru-cache": "^6.0.0" 173 | } 174 | }, 175 | "vscode-jsonrpc": { 176 | "version": "6.0.0", 177 | "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-6.0.0.tgz", 178 | "integrity": "sha512-wnJA4BnEjOSyFMvjZdpiOwhSq9uDoK8e/kpRJDTaMYzwlkrhG1fwDIZI94CLsLzlCK5cIbMMtFlJlfR57Lavmg==" 179 | }, 180 | "vscode-languageclient": { 181 | "version": "7.0.0", 182 | "resolved": "https://registry.npmjs.org/vscode-languageclient/-/vscode-languageclient-7.0.0.tgz", 183 | "integrity": "sha512-P9AXdAPlsCgslpP9pRxYPqkNYV7Xq8300/aZDpO35j1fJm/ncize8iGswzYlcvFw5DQUx4eVk+KvfXdL0rehNg==", 184 | "requires": { 185 | "minimatch": "^3.0.4", 186 | "semver": "^7.3.4", 187 | "vscode-languageserver-protocol": "3.16.0" 188 | } 189 | }, 190 | "vscode-languageserver-protocol": { 191 | "version": "3.16.0", 192 | "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.16.0.tgz", 193 | "integrity": "sha512-sdeUoAawceQdgIfTI+sdcwkiK2KU+2cbEYA0agzM2uqaUy2UpnnGHtWTHVEtS0ES4zHU0eMFRGN+oQgDxlD66A==", 194 | "requires": { 195 | "vscode-jsonrpc": "6.0.0", 196 | "vscode-languageserver-types": "3.16.0" 197 | } 198 | }, 199 | "vscode-languageserver-types": { 200 | "version": "3.16.0", 201 | "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.16.0.tgz", 202 | "integrity": "sha512-k8luDIWJWyenLc5ToFQQMaSrqCHiLwyKPHKPQZ5zz21vM+vIVUSvsRpcbiECH4WR88K2XZqc4ScRcZ7nk/jbeA==" 203 | }, 204 | "vscode-test": { 205 | "version": "1.3.0", 206 | "resolved": "https://registry.npmjs.org/vscode-test/-/vscode-test-1.3.0.tgz", 207 | "integrity": "sha512-LddukcBiSU2FVTDr3c1D8lwkiOvwlJdDL2hqVbn6gIz+rpTqUCkMZSKYm94Y1v0WXlHSDQBsXyY+tchWQgGVsw==", 208 | "dev": true, 209 | "requires": { 210 | "http-proxy-agent": "^2.1.0", 211 | "https-proxy-agent": "^2.2.4", 212 | "rimraf": "^2.6.3" 213 | } 214 | }, 215 | "wrappy": { 216 | "version": "1.0.2", 217 | "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", 218 | "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", 219 | "dev": true 220 | }, 221 | "yallist": { 222 | "version": "4.0.0", 223 | "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", 224 | "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" 225 | } 226 | } 227 | } 228 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------