icedream
/
vscode-php-intellisense
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

style: use prettier

pull/391/head
Felix Becker 2018-11-11 18:32:17 +01:00
parent edd8806ab7
commit 0c2985e776
16 changed files with 260 additions and 196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,4 +1,3 @@
<!--
THERE IS A 99% CHANCE YOU ARE FILING THIS ISSUE IN THE WRONG REPOSITORY.

4
.prettierignore Normal file
View File

@ -0,0 +1,4 @@
package.json
package-lock.json
vendor/
out/

22
.prettierrc Normal file
View File

@ -0,0 +1,22 @@
{
"tabWidth": 4,
"printWidth": 120,
"proseWrap": "preserve",
"semi": false,
"trailingComma": "es5",
"singleQuote": true,
"overrides": [
{
"files": "{*.js?(on),*.y?(a)ml,.*.js?(on),.*.y?(a)ml,*.md,.prettierrc,.stylelintrc,.babelrc}",
"options": {
"tabWidth": 2
}
},
{
"files": "composer.{json,lock}",
"options": {
"tabWidth": 4
}
}
]
}

9
.vscode/launch.json vendored
View File

@ -7,9 +7,7 @@
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"args": [
"--extensionDevelopmentPath=${workspaceRoot}"
],
"args": ["--extensionDevelopmentPath=${workspaceRoot}"],
"stopOnEntry": false,
"sourceMaps": true,
"outDir": "${workspaceRoot}/out"
@ -19,10 +17,7 @@
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"args": [
"--extensionDevelopmentPath=${workspaceRoot}",
"--extensionTestsPath=${workspaceRoot}/out/test"
],
"args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test"],
"stopOnEntry": false,
"sourceMaps": true,
"outDir": "${workspaceRoot}/out/test"

14
.vscode/settings.json vendored
View File

@ -1,10 +1,10 @@
// Place your settings in this file to overwrite default and user settings.
{
"files.exclude": {
"out": false // set this to true to hide the "out" folder with the compiled JS files
},
"search.exclude": {
"out": true // set this to false to include "out" folder in search results
},
"typescript.tsdk": "./node_modules/typescript/lib" // we want to use the TS server from our node_modules folder to control its version
"files.exclude": {
"out": false // set this to true to hide the "out" folder with the compiled JS files
},
"search.exclude": {
"out": true // set this to false to include "out" folder in search results
},
"typescript.tsdk": "./node_modules/typescript/lib" // we want to use the TS server from our node_modules folder to control its version
}

8
.vscode/tasks.json vendored
View File

@ -6,16 +6,12 @@
{
"type": "npm",
"script": "build",
"problemMatcher": [
"$tsc"
]
"problemMatcher": ["$tsc"]
},
{
"type": "npm",
"script": "watch",
"problemMatcher": [
"$tsc-watch"
]
"problemMatcher": ["$tsc-watch"]
}
]
}

1
CHANGELOG.md
View File

@ -1,2 +1 @@
# See [GitHub releases](https://github.com/felixfbecker/vscode-php-intellisense/releases)

17
README.md
View File

@ -15,50 +15,63 @@ I recommend to disable VS Code's built-in PHP IntelliSense by setting `php.sugge
## Features
### Completion
![Completion search demo](images/completion.gif)
### Signature Help
![Signature help demo](images/signatureHelp.gif)
### Workspace symbol search
![Workspace symbol search demo](images/workspaceSymbol.gif)
### Find all References
![Find References demo](images/references.png)
### Go to Definition
![Go To Definition demo](images/definition.gif)
### Hover
![Hover class demo](images/hoverClass.png)
![Hover parameter demo](images/hoverParam.png)
### Find all symbols
![Find all symbols demo](images/documentSymbol.gif)
### Column-accurate error reporting
![Error reporting demo](images/publishDiagnostics.png)
### Code style linting
Please use a dedicated extension like [PHP CodeSniffer](https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs).
### Format code
Please use a dedicated extension like [PHP CS Fixer](https://marketplace.visualstudio.com/items?itemName=junstyle.php-cs-fixer).
## Todo
- Rename
- Signature help
- Rename
- Signature help
## Contributing
Clone whole repository and in root directory execute:
```bash
composer install
npm install
npm run build
code .
```
The last command will open the folder in VS Code. Hit `F5` to launch an Extension Development Host with the extension.
For working on the language server, the easiest way is to replace the language server installation from composer in `vendor/felixfbecker/language-server` with a symlink to your local clone.

54
dependencies.yml
View File

@ -1,35 +1,33 @@
collectors:
- type: js-npm
path: /
actors:
# pull requests for new major versions
- type: js-npm
versions: "Y.0.0"
settings:
# these updates should generally not have an effect on users
commit_message_prefix: "chore: "
# receive pull requests to update composer.lock for any update to the language server or dependencies of it
# after merging, depending on whether it was a patch or feature update,
# semantic-release will bundle a new patch or feature version of the extension
- type: php-composer
path: /
settings:
collect_transitive: true
actors:
path: /
actors:
# pull requests for new major versions
- type: js-npm
versions: 'Y.0.0'
settings:
# these updates should generally not have an effect on users
commit_message_prefix: 'chore: '
# receive pull requests to update composer.lock for any update to the language server or dependencies of it
# after merging, depending on whether it was a patch or feature update,
# semantic-release will bundle a new patch or feature version of the extension
- type: php-composer
versions: "L.L.Y"
path: /
settings:
commit_message_prefix: "fix: "
collect_transitive: true
actors:
- type: php-composer
versions: 'L.L.Y'
settings:
commit_message_prefix: 'fix: '
- type: php-composer
versions: "L.Y.0"
settings:
commit_message_prefix: "feat: "
- type: php-composer
versions: 'L.Y.0'
settings:
commit_message_prefix: 'feat: '
- type: php-composer
versions: "Y.0.0"
settings:
commit_message_prefix: "chore: "
- type: php-composer
versions: 'Y.0.0'
settings:
commit_message_prefix: 'chore: '

6
package.json
View File

@ -47,7 +47,9 @@
"build": "tsc -p .",
"watch": "tsc -w -p .",
"postinstall": "node ./node_modules/vscode/bin/install",
"lint": "tslint -c tslint.json \"src/**/*.ts\"",
"lint": "npm run prettier && npm run tslint",
"tslint": "tslint -p tsconfig.json -c tslint.json \"src/**/*.ts\"",
"prettier": "prettier '**/{*.{js?(on),ts,yml},.*.js?(on),.*.yml,.prettierrc,*.md}' --write --list-different",
"semantic-release": "semantic-release"
},
"devDependencies": {
@ -59,9 +61,11 @@
"@types/node": "8.10.29",
"@types/semver": "5.5.0",
"husky": "1.1.3",
"prettier": "1.15.2",
"semantic-release": "15.10.8",
"semantic-release-vsce": "2.1.2",
"tslint": "5.11.0",
"tslint-config-prettier": "^1.15.0",
"typescript": "3.1.6",
"vscode": "1.1.21"
},

6
renovate.json
View File

@ -4,12 +4,10 @@
"rangeStrategy": "pin",
"semanticCommits": true,
"npm": {
"semanticCommitType": "chore",
"packageRules": [
{
"packagePatterns": [
"*"
],
"packagePatterns": ["*"],
"semanticCommitType": "chore",
"minor": {
"groupName": "all non-major dependencies",
"groupSlug": "all-minor-patch"

159
src/extension.ts
View File

@ -1,134 +1,135 @@
import * as path from 'path';
import { spawn, ChildProcess } from 'mz/child_process';
import * as vscode from 'vscode';
import { LanguageClient, LanguageClientOptions, StreamInfo } from 'vscode-languageclient';
import * as semver from 'semver';
import * as net from 'net';
import * as url from 'url';
import execa from 'execa';
import execa from 'execa'
import { ChildProcess, spawn } from 'mz/child_process'
import * as net from 'net'
import * as path from 'path'
import * as semver from 'semver'
import * as url from 'url'
import * as vscode from 'vscode'
import { LanguageClient, LanguageClientOptions, StreamInfo } from 'vscode-languageclient'
export async function activate(context: vscode.ExtensionContext): Promise<void> {
const conf = vscode.workspace.getConfiguration('php');
const executablePath = conf.get<string>('executablePath') ||
const conf = vscode.workspace.getConfiguration('php')
const executablePath =
conf.get<string>('executablePath') ||
conf.get<string>('validate.executablePath') ||
(process.platform === 'win32' ? 'php.exe' : 'php');
(process.platform === 'win32' ? 'php.exe' : 'php')
const memoryLimit = conf.get<string>('memoryLimit') || '4095M';
const memoryLimit = conf.get<string>('memoryLimit') || '4095M'
if (memoryLimit !== '-1' && !/^\d+[KMG]?$/.exec(memoryLimit)) {
const selected = await vscode.window.showErrorMessage(
'The memory limit you\'d provided is not numeric, nor "-1" nor valid php shorthand notation!',
'Open settings'
);
)
if (selected === 'Open settings') {
await vscode.commands.executeCommand('workbench.action.openGlobalSettings');
await vscode.commands.executeCommand('workbench.action.openGlobalSettings')
}
return;
return
}
// Check path (if PHP is available and version is ^7.0.0)
let stdout: string;
let stdout: string
try {
stdout = await execa.stdout(executablePath, ['--version']);
stdout = await execa.stdout(executablePath, ['--version'])
} catch (err) {
if (err.code === 'ENOENT') {
const selected = await vscode.window.showErrorMessage(
'PHP executable not found. Install PHP 7 and add it to your PATH or set the php.executablePath setting',
'Open settings'
);
)
if (selected === 'Open settings') {
await vscode.commands.executeCommand('workbench.action.openGlobalSettings');
await vscode.commands.executeCommand('workbench.action.openGlobalSettings')
}
} else {
vscode.window.showErrorMessage('Error spawning PHP: ' + err.message);
console.error(err);
vscode.window.showErrorMessage('Error spawning PHP: ' + err.message)
console.error(err)
}
return;
return
}
// Parse version and discard OS info like 7.0.8--0ubuntu0.16.04.2
const match = stdout.match(/^PHP ([^\s]+)/m);
const match = stdout.match(/^PHP ([^\s]+)/m)
if (!match) {
vscode.window.showErrorMessage('Error parsing PHP version. Please check the output of php --version');
return;
vscode.window.showErrorMessage('Error parsing PHP version. Please check the output of php --version')
return
}
let version = match[1].split('-')[0];
let version = match[1].split('-')[0]
// Convert PHP prerelease format like 7.0.0rc1 to 7.0.0-rc1
if (!/^\d+.\d+.\d+$/.test(version)) {
version = version.replace(/(\d+.\d+.\d+)/, '$1-');
version = version.replace(/(\d+.\d+.\d+)/, '$1-')
}
if (semver.lt(version, '7.0.0')) {
vscode.window.showErrorMessage('The language server needs at least PHP 7 installed. Version found: ' + version);
return;
vscode.window.showErrorMessage('The language server needs at least PHP 7 installed. Version found: ' + version)
return
}
let client: LanguageClient;
let client: LanguageClient
const serverOptions = () => new Promise<ChildProcess | StreamInfo>((resolve, reject) => {
// Use a TCP socket because of problems with blocking STDIO
const server = net.createServer(socket => {
// 'connection' listener
console.log('PHP process connected');
socket.on('end', () => {
console.log('PHP process disconnected');
});
server.close();
resolve({ reader: socket, writer: socket });
});
// Listen on random port
server.listen(0, '127.0.0.1', () => {
// The server is implemented in PHP
const childProcess = spawn(executablePath, [
context.asAbsolutePath(path.join('vendor', 'felixfbecker', 'language-server', 'bin', 'php-language-server.php')),
'--tcp=127.0.0.1:' + server.address().port,
'--memory-limit=' + memoryLimit
]);
childProcess.stderr.on('data', (chunk: Buffer) => {
const str = chunk.toString();
console.log('PHP Language Server:', str);
client.outputChannel.appendLine(str);
});
// childProcess.stdout.on('data', (chunk: Buffer) => {
// console.log('PHP Language Server:', chunk + '');
// });
childProcess.on('exit', (code, signal) => {
client.outputChannel.appendLine(`Language server exited ` + (signal ? `from signal ${signal}` : `with exit code ${code}`));
if (code !== 0) {
client.outputChannel.show();
}
});
return childProcess;
});
});
const serverOptions = () =>
new Promise<ChildProcess | StreamInfo>((resolve, reject) => {
// Use a TCP socket because of problems with blocking STDIO
const server = net.createServer(socket => {
// 'connection' listener
console.log('PHP process connected')
socket.on('end', () => {
console.log('PHP process disconnected')
})
server.close()
resolve({ reader: socket, writer: socket })
})
// Listen on random port
server.listen(0, '127.0.0.1', () => {
// The server is implemented in PHP
const childProcess = spawn(executablePath, [
context.asAbsolutePath(
path.join('vendor', 'felixfbecker', 'language-server', 'bin', 'php-language-server.php')
),
'--tcp=127.0.0.1:' + server.address().port,
'--memory-limit=' + memoryLimit,
])
childProcess.stderr.on('data', (chunk: Buffer) => {
const str = chunk.toString()
console.log('PHP Language Server:', str)
client.outputChannel.appendLine(str)
})
// childProcess.stdout.on('data', (chunk: Buffer) => {
// console.log('PHP Language Server:', chunk + '');
// });
childProcess.on('exit', (code, signal) => {
client.outputChannel.appendLine(
`Language server exited ` + (signal ? `from signal ${signal}` : `with exit code ${code}`)
)
if (code !== 0) {
client.outputChannel.show()
}
})
return childProcess
})
})
// Options to control the language client
const clientOptions: LanguageClientOptions = {
// Register the server for php documents
documentSelector: [
{ scheme: 'file', language: 'php' },
{ scheme: 'untitled', language: 'php' }
],
documentSelector: [{ scheme: 'file', language: 'php' }, { scheme: 'untitled', language: 'php' }],
uriConverters: {
// VS Code by default %-encodes even the colon after the drive letter
// NodeJS handles it much better
code2Protocol: uri => url.format(url.parse(uri.toString(true))),
protocol2Code: str => vscode.Uri.parse(str)
protocol2Code: str => vscode.Uri.parse(str),
},
synchronize: {
// Synchronize the setting section 'php' to the server
configurationSection: 'php',
// Notify the server about changes to PHP files in the workspace
fileEvents: vscode.workspace.createFileSystemWatcher('**/*.php')
}
};
fileEvents: vscode.workspace.createFileSystemWatcher('**/*.php'),
},
}
// Create the language client and start the client.
client = new LanguageClient('PHP Language Server', serverOptions, clientOptions);
const disposable = client.start();
client = new LanguageClient('PHP Language Server', serverOptions, clientOptions)
const disposable = client.start()
// Push the disposable to the context's subscriptions so that the
// client can be deactivated on extension deactivation
context.subscriptions.push(disposable);
context.subscriptions.push(disposable)
}

11
src/test/extension.test.ts
View File

@ -4,7 +4,7 @@
//
// The module 'assert' provides assertion methods from node
import * as assert from 'assert';
import * as assert from 'assert'
// You can import and use all API from the 'vscode' module
// as well as import your extension to test it
@ -13,10 +13,9 @@ import * as assert from 'assert';
// Defines a Mocha test suite to group tests of similar kind together
suite('Extension Tests', () => {
// Defines a Mocha unit test
test('Something 1', () => {
assert.equal(-1, [1, 2, 3].indexOf(5));
assert.equal(-1, [1, 2, 3].indexOf(0));
});
});
assert.equal(-1, [1, 2, 3].indexOf(5))
assert.equal(-1, [1, 2, 3].indexOf(0))
})
})

10
src/test/index.ts
View File

@ -10,13 +10,13 @@
// to report the results back to the caller. When the tests are finished, return
// a possible error to the callback or null if none.
const testRunner = require('vscode/lib/testrunner');
const testRunner = require('vscode/lib/testrunner')
// You can directly control Mocha options by uncommenting the following lines
// See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info
testRunner.configure({
ui: 'tdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.)
useColors: true // colored output from test results
});
ui: 'tdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.)
useColors: true, // colored output from test results
})
module.exports = testRunner;
module.exports = testRunner

24
tsconfig.json
View File

@ -1,15 +1,13 @@
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"moduleResolution": "node",
"outDir": "out",
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"moduleResolution": "node",
"outDir": "out",
"esModuleInterop": true,
"lib": [
"es6"
],
"lib": ["es6"],
"noImplicitAny": true,
"sourceMap": true,
"sourceMap": true,
"rootDir": "src",
"strictNullChecks": true,
"noImplicitThis": true,
@ -17,10 +15,6 @@
"noUnusedLocals": true,
"allowUnreachableCode": false,
"allowUnusedLabels": false
},
"exclude": [
"node_modules",
"out",
"vendor"
]
},
"exclude": ["node_modules", "out", "vendor"]
}

108
tslint.json
View File

@ -1,43 +1,85 @@
{
"extends": ["tslint:recommended", "tslint-config-prettier"],
"rules": {
"class-name": true,
"comment-format": [true, "check-space"],
"indent": [true, "spaces"],
"no-eval": true,
"no-internal-module": true,
"no-trailing-whitespace": true,
"no-var-keyword": true,
"one-line": [true, "check-catch", "check-finally", "check-else", "check-open-brace", "check-whitespace"],
"quotemark": [true, "single"],
"semicolon": [true, "always"],
"triple-equals": [true, "allow-null-check"],
"typedef-whitespace": [
"adjacent-overload-signatures": true,
"array-type": [true, "array"],
"arrow-return-shorthand": [true, "multiline"],
"await-promise": [true, "Thenable"],
"ban": [
true,
{
"call-signature": "nospace",
"index-signature": "nospace",
"parameter": "nospace",
"property-declaration": "nospace",
"variable-declaration": "nospace"
"name": ["*", "forEach"]
},
["describe", "only"],
["it", "only"]
],
"callable-types": true,
"class-name": true,
"comment-format": [true, "check-space"],
"curly": true,
"deprecation": {
"severity": "warning"
},
"interface-name": [false],
"interface-over-type-literal": true,
"jsdoc-format": true,
"max-classes-per-file": false,
"member-access": [true, "check-accessor"],
"member-ordering": [false],
"no-angle-bracket-type-assertion": true,
"no-arg": true,
"no-bitwise": false,
"no-boolean-literal-compare": true,
"no-conditional-assignment": true,
"no-console": [false],
"no-construct": true,
"no-debugger": true,
"no-duplicate-super": true,
"no-duplicate-variable": true,
"no-empty": true,
"no-empty-interface": false,
"no-eval": true,
"no-floating-promises": [true],
"no-for-in-array": true,
"no-inferrable-types": [true],
"no-inferred-empty-object-type": true,
"no-internal-module": true,
"no-invalid-template-strings": true,
"no-magic-numbers": false,
"no-misused-new": true,
"no-namespace": [false, "allow-declarations"],
"no-reference-import": true,
"no-shadowed-variable": false,
"no-sparse-arrays": true,
"no-string-literal": true,
"no-string-throw": true,
"no-unbound-method": true,
"no-unnecessary-callback-wrapper": false,
"no-unnecessary-qualifier": true,
"no-unnecessary-type-assertion": false,
"no-unsafe-any": false,
"no-unsafe-finally": true,
"no-unused-expression": true,
"no-use-before-declare": true,
"no-var-keyword": true,
"no-var-requires": false,
"no-void-expression": false,
"object-literal-shorthand": true,
"object-literal-sort-keys": false,
"one-variable-per-declaration": [true, "ignore-for-loop"],
"only-arrow-functions": [true, "allow-declarations", "allow-named-functions"],
"prefer-const": [
true,
{
"call-signature": "onespace",
"index-signature": "onespace",
"parameter": "onespace",
"property-declaration": "onespace",
"variable-declaration": "onespace"
"destructuring": "all"
}
],
"variable-name": [true, "ban-keywords"],
"whitespace": [true, "check-branch", "check-decl", "check-operator", "check-separator", "check-type"],
"jsdoc-format": true,
"no-consecutive-blank-lines": true,
"one-variable-per-declaration": [true, "ignore-for-loop"],
"curly": true,
"no-empty": true,
"no-unused-expression": true,
"eofline": true,
"trailing-comma": [true, {"singleline": "never", "multiline": "never"}],
"align": [true, "parameters", "statements"]
"prefer-for-of": true,
"prefer-template": [false, "allow-single-concat"],
"return-undefined": true,
"triple-equals": [true],
"typedef": [true, "call-signature"],
"unified-signatures": true,
"variable-name": [true, "ban-keywords"]
}
}