Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor VTI with commander.js #2722

Merged
merged 6 commits into from
Mar 2, 2021
Merged

Refactor VTI with commander.js #2722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5ae09af
add vscode-languageclient as a VTI dependency
yukukotani Feb 25, 2021
e1e8aed
add commander as a VTI dependencies
yukukotani Feb 25, 2021
eb48e3c
refactor VTI with commander.js
yukukotani Feb 25, 2021
453cdff
add changelog
yukukotani Feb 25, 2021
1476fb4
make cli action async
yukukotani Feb 25, 2021
5edb3fc
revert needless format change in CHANGELOG
yukukotani Feb 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- Disable Vue completion in custom blocks. #2111
- Upgrade `stylus-supremacy` to 2.15.0.
- 🙌 Improve performance of template interpolation features. Thanks to contribution from [@jasonlyu123](https://github.com/jasonlyu123).
- Improve VTI command structure. See `vti --help`. #2722.

### 0.32.0 | 2021-01-21 | [VSIX](https://marketplace.visualstudio.com/_apis/public/gallery/publishers/octref/vsextensions/vetur/0.32.0/vspackage)

Expand Down
2 changes: 2 additions & 0 deletions vti/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"author": "Pine Wu <octref@gmail.com>",
"license": "MIT",
"dependencies": {
"commander": "^7.1.0",
"vls": "^0.7.0"
},
"scripts": {
Expand All @@ -21,6 +22,7 @@
"glob": "^7.1.2",
"rollup": "^2.38.5",
"typescript": "^4.1.5",
"vscode-languageclient": "^7.0.0",
"vscode-languageserver": "^7.0.0",
"vscode-languageserver-protocol": "^3.16.0",
"vscode-languageserver-types": "^3.16.0",
Expand Down
197 changes: 12 additions & 185 deletions vti/src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,196 +1,23 @@
import {
InitializeParams,
InitializeRequest,
InitializeResult,
createProtocolConnection,
StreamMessageReader,
StreamMessageWriter,
Logger,
DidOpenTextDocumentNotification,
Diagnostic,
DiagnosticSeverity,
createConnection,
ServerCapabilities
} from 'vscode-languageserver/node';

import { Duplex } from 'stream';
import { VLS } from 'vls';
import { getInitParams } from './initParams';
import fs from 'fs';
import { URI } from 'vscode-uri';
import glob from 'glob';
import path from 'path';
import chalk from 'chalk';
import { codeFrameColumns, SourceLocation } from '@babel/code-frame';
import { Range } from 'vscode-languageclient';

class NullLogger implements Logger {
error(_message: string): void {}
warn(_message: string): void {}
info(_message: string): void {}
log(_message: string): void {}
}

class TestStream extends Duplex {
_write(chunk: string, _encoding: string, done: () => void) {
this.emit('data', chunk);
done();
}

_read(_size: number) {}
}

async function prepareClientConnection(workspaceUri: URI) {
const up = new TestStream();
const down = new TestStream();
const logger = new NullLogger();

const clientConnection = createProtocolConnection(new StreamMessageReader(down), new StreamMessageWriter(up), logger);

const serverConnection = createConnection(new StreamMessageReader(up), new StreamMessageWriter(down));
const vls = new VLS(serverConnection as any);

serverConnection.onInitialize(
async (params: InitializeParams): Promise<InitializeResult> => {
await vls.init(params);

console.log('Vetur initialized');
console.log('====================================');

return {
capabilities: vls.capabilities as ServerCapabilities
};
}
);

vls.listen();
clientConnection.listen();

const init = getInitParams(workspaceUri);

await clientConnection.sendRequest(InitializeRequest.type, init);

return clientConnection;
}

function range2Location(range: Range): SourceLocation {
return {
start: {
line: range.start.line + 1,
column: range.start.character + 1
},
end: {
line: range.end.line + 1,
column: range.end.character + 1
}
};
}

async function getDiagnostics(workspaceUri: URI) {
const clientConnection = await prepareClientConnection(workspaceUri);

const files = glob.sync('**/*.vue', { cwd: workspaceUri.fsPath, ignore: ['node_modules/**'] });

if (files.length === 0) {
console.log('No input files');
return 0;
}

console.log('');
console.log('Getting diagnostics from: ', files, '\n');

const absFilePaths = files.map(f => path.resolve(workspaceUri.fsPath, f));

let errCount = 0;

for (const absFilePath of absFilePaths) {
const fileText = fs.readFileSync(absFilePath, 'utf-8');
await clientConnection.sendNotification(DidOpenTextDocumentNotification.type, {
textDocument: {
languageId: 'vue',
uri: URI.file(absFilePath).toString(),
version: 1,
text: fileText
}
});

try {
let res = (await clientConnection.sendRequest('$/getDiagnostics', {
uri: URI.file(absFilePath).toString()
})) as Diagnostic[];
/**
* Ignore eslint errors for now
*/
res = res.filter(r => r.source !== 'eslint-plugin-vue');
if (res.length > 0) {
res.forEach(d => {
const location = range2Location(d.range);
console.log(
`${chalk.green('File')} : ${chalk.green(absFilePath)}:${location.start.line}:${location.start.column}`
);
if (d.severity === DiagnosticSeverity.Error) {
console.log(`${chalk.red('Error')}: ${d.message.trim()}`);
errCount++;
} else {
console.log(`${chalk.yellow('Warn')} : ${d.message.trim()}`);
}
console.log(codeFrameColumns(fileText, location));
});
console.log('');
}
} catch (err) {
console.error(err.stack);
}
}

return errCount;
}
import { Command } from 'commander';
import { diagnostics } from './commands/diagnostics';

function getVersion(): string {
const { version }: { version: string } = require('../package.json');
return `v${version}`;
}

(async () => {
const myArgs = process.argv.slice(2);

// vls diagnostics
if (myArgs.length > 0 && myArgs[0] === 'diagnostics') {
console.log('====================================');
console.log('Getting Vetur diagnostics');
let workspaceUri;

if (myArgs[1]) {
const absPath = path.resolve(process.cwd(), myArgs[1]);
console.log(`Loading Vetur in workspace path: ${chalk.green(absPath)}`);
workspaceUri = URI.file(absPath);
} else {
console.log(`Loading Vetur in current directory: ${chalk.green(process.cwd())}`);
workspaceUri = URI.file(process.cwd());
}

const errCount = await getDiagnostics(workspaceUri);
console.log('====================================');
const program = new Command();
program.name('vti').description('Vetur Terminal Interface').version(getVersion());

program
.command('diagnostics [workspace]')
.description('Print all diagnostics')
.action(async workspace => {
await diagnostics(workspace);
});

if (errCount === 0) {
console.log(chalk.green(`VTI found no error`));
process.exit(0);
} else {
console.log(chalk.red(`VTI found ${errCount} ${errCount === 1 ? 'error' : 'errors'}`));
process.exit(1);
}
} else if (myArgs.length > 0 && myArgs[0] === 'version') {
console.log(getVersion());
} else {
// no args or wrong first args
console.log('Vetur Terminal Interface');
console.log('');
console.log('Usage:');
console.log('');
console.log(' vti diagnostics ---- Print all diagnostics');
console.log(' vti version ---- Show VTI version');
console.log('');
}
program.parse(process.argv);
})().catch(err => {
console.error(`VTI operation failed with error`);
console.error(err.stack);
Expand Down
Loading