From 93e6b0a1d6b45ade6a99dffac3b1570d134f476c Mon Sep 17 00:00:00 2001 From: andy bunce Date: Wed, 22 Feb 2023 15:08:38 +0000 Subject: [PATCH] [add] setting to control hover display --- .github/workflows/release.yml | 8 +++-- .vscode/settings.json | 3 +- CHANGELOG.md | 8 +++-- package.json | 30 ++++++++----------- src/common/configuration.ts | 14 +++++---- .../formatters/classic-xml-formatter.ts | 6 ++-- src/hover/hover.ts | 26 +++++++++------- 7 files changed, 52 insertions(+), 43 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8410891..bb4d2eb 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -10,11 +10,13 @@ jobs: runs-on: "ubuntu-latest" steps: - name: "Checkout" - uses: "actions/checkout@v2" + uses: "actions/checkout@v3" - name: "Setup NodeJS" - uses: "actions/setup-node@v2.1.0" - + uses: "actions/setup-node@v3" + with: + node-version: 16 + - name: "Install Dependencies" run: "npm install" diff --git a/.vscode/settings.json b/.vscode/settings.json index d137133..254012f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,5 +5,6 @@ }, "search.exclude": { "out": true // set this to false to include "out" folder in search results - } + }, + "basexTools.xquery.showHovers": false } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index ca0e087..c535205 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,14 @@ +# 0.1.1 (2023-02-21) +* Add Hover show option # 0.1.0 (2023-02-19) -Update xqlint to 0.2.0 +* Update xqlint to 0.2.0 # 0.0.64 (2023-01-26) -* add simple hover display +* Add simple hover display * Update `xqlint.d.ts` to support newer `tsc.exe`. This reduces size of vsix from 600kb to 300kb # 0.0.58 -* use xqlint 0.0.14 +* Use xqlint 0.0.14 # 0.0.48 * Fix xmlToText #6 diff --git a/package.json b/package.json index 9ff22e8..97f216e 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "vscode-basex", "displayName": "BaseX tools", "description": "BaseX tools: XQuery, XML, XPath Tools for Visual Studio Code", - "version": "0.1.0", + "version": "0.1.1", "preview": true, "publisher": "quodatum", "author": "Andy Bunce (https://github.com/Quodatum)", @@ -15,7 +15,7 @@ "homepage": "https://github.com/Quodatum/vscode-basex", "repository": { "type": "git", - "url": "git+https://github.com/Quodatum/vscode-basex.git" + "url": "https://github.com/Quodatum/vscode-basex.git" }, "bugs": { "url": "https://github.com/Quodatum/vscode-basex/issues" @@ -31,15 +31,6 @@ "Other" ], "activationEvents": [ - "onCommand:basexTools.evaluateXPath", - "onCommand:basexTools.executeXQuery", - "onCommand:basexTools.formatAsXml", - "onCommand:basexTools.textToXml", - "onCommand:basexTools.xmlToText", - "onCommand:basexTools.minifyXml", - "onCommand:basexTools.xqLintReport", - "onLanguage:xml", - "onLanguage:xquery", "onLanguage:xsl" ], "main": "./out/extension.js", @@ -125,6 +116,11 @@ "id": "xquery", "title": "XQuery ", "properties": { + "basexTools.xquery.showHovers": { + "type": "boolean", + "default": false, + "description": "Show hovers in xquery." + }, "basexTools.xquery.executionArguments": { "type": "array", "default": [ @@ -159,34 +155,34 @@ } }, { - "title": "BaseX Tools ", + "title": "XML edit ", "type": "object", "properties": { - "basexTools.enforcePrettySelfClosingTagOnFormat": { + "basexTools.xml.enforcePrettySelfClosingTagOnFormat": { "type": "boolean", "default": false, "description": "Enforces a space before the forward slash at the end of a self-closing XML tag.", "scope": "resource" }, - "basexTools.removeCommentsOnMinify": { + "basexTools.xml.removeCommentsOnMinify": { "type": "boolean", "default": false, "description": "Remove XML comments during minification.", "scope": "resource" }, - "basexTools.splitAttributesOnFormat": { + "basexTools.xml.splitAttributesOnFormat": { "type": "boolean", "default": false, "description": "Put each attribute on a new line when formatting XML. Overrides `basexTools.splitXmlnsOnFormat` if set to `true`.", "scope": "resource" }, - "basexTools.splitXmlnsOnFormat": { + "basexTools.xml.splitXmlnsOnFormat": { "type": "boolean", "default": true, "description": "Put each xmlns attribute on a new line when formatting XML.", "scope": "resource" }, - "basexTools.xmlFormatterImplementation": { + "basexTools.xml.FormatterImplementation": { "type": "string", "enum": [ "classic", diff --git a/src/common/configuration.ts b/src/common/configuration.ts index fbca6b2..e6c3ffb 100644 --- a/src/common/configuration.ts +++ b/src/common/configuration.ts @@ -24,7 +24,7 @@ export class Configuration { } static get xmlFormatterImplementation(): string { - return this._getForWindow("xmlFormatterImplementation"); + return this._getForWindow("xml.FormatterImplementation"); } static get xqueryExecutionArguments(): string[] { @@ -43,20 +43,24 @@ export class Configuration { return this._getForWindow("xquery.executionInputSearchPattern"); } + static xqueryShowHovers(resource: Uri): boolean { + return this._getForResource("xquery.showHovers", resource); + } + static enforcePrettySelfClosingTagOnFormat(resource: Uri): boolean { - return this._getForResource("enforcePrettySelfClosingTagOnFormat", resource); + return this._getForResource("xml.enforcePrettySelfClosingTagOnFormat", resource); } static removeCommentsOnMinify(resource: Uri): boolean { - return this._getForResource("removeCommentsOnMinify", resource); + return this._getForResource("xml.removeCommentsOnMinify", resource); } static splitAttributesOnFormat(resource: Uri): boolean { - return this._getForResource("splitAttributesOnFormat", resource); + return this._getForResource("xml.splitAttributesOnFormat", resource); } static splitXmlnsOnFormat(resource: Uri): boolean { - return this._getForResource("splitXmlnsOnFormat", resource); + return this._getForResource("xml.splitXmlnsOnFormat", resource); } private static _getForResource(section: string, resource: Uri): T { diff --git a/src/formatting/formatters/classic-xml-formatter.ts b/src/formatting/formatters/classic-xml-formatter.ts index 970e35e..6b18548 100644 --- a/src/formatting/formatters/classic-xml-formatter.ts +++ b/src/formatting/formatters/classic-xml-formatter.ts @@ -32,7 +32,7 @@ export class ClassicXmlFormatter implements XmlFormatter { output += parts[i]; inComment = false; } else if (/^<(\w|:)/.test(parts[i - 1]) && /^<\/(\w|:)/.test(parts[i]) - && /^<[\w:\-\.\,\/]+/.exec(parts[i - 1])[0] === /^<\/[\w:\-\.\,]+/.exec(parts[i])[0].replace("/", "")) { + && /^<[\w:\-.,/]+/.exec(parts[i - 1])[0] === /^<\/[\w:\-.,]+/.exec(parts[i])[0].replace("/", "")) { output += parts[i]; if (!inComment) { level--; } @@ -48,7 +48,7 @@ export class ClassicXmlFormatter implements XmlFormatter { output = (!inComment) ? output += this._getIndent(options, level--, parts[i]) : output += parts[i]; } else if (parts[i].search(/<\?/) > -1) { output += this._getIndent(options, level, parts[i]); - } else if (options.splitXmlnsOnFormat && (parts[i].search(/xmlns\:/) > -1 || parts[i].search(/xmlns\=/) > -1)) { + } else if (options.splitXmlnsOnFormat && (parts[i].search(/xmlns:/) > -1 || parts[i].search(/xmlns=/) > -1)) { output += this._getIndent(options, level, parts[i]); } else { output += parts[i]; @@ -67,7 +67,7 @@ export class ClassicXmlFormatter implements XmlFormatter { minifyXml(xml: string, options: XmlFormattingOptions): string { xml = this._stripLineBreaks(options, xml); // all line breaks outside of CDATA elements and comments - xml = (options.removeCommentsOnMinify) ? xml.replace(/\/g, "") : xml; + xml = (options.removeCommentsOnMinify) ? xml.replace(//g, "") : xml; xml = xml.replace(/>\s{0,}<"); // insignificant whitespace between tags xml = xml.replace(/"\s+(?=[^\s]+=)/g, "\" "); // spaces between attributes xml = xml.replace(/"\s+(?=>)/g, "\""); // spaces between the last attribute and tag close (>) diff --git a/src/hover/hover.ts b/src/hover/hover.ts index 84150b5..af6ed27 100644 --- a/src/hover/hover.ts +++ b/src/hover/hover.ts @@ -1,28 +1,32 @@ // xquery hover import { CancellationToken, Hover, HoverProvider, Position, TextDocument } from "vscode"; -import { XQLint} from "@quodatum/xqlint"; +import { XQLint } from "@quodatum/xqlint"; +import { Configuration } from "../common"; export class XQueryHoverProvider implements HoverProvider { public provideHover( - document: TextDocument, - position: Position, + document: TextDocument, + position: Position, token: CancellationToken ): Hover | null { const linter = new XQLint(document.getText()); - const node=linter.getAST(position); + const node = linter.getAST(position); //const sctx=linter.getCompletions(position); //channel.log("Hover: " + node.name); //const dx=dump(node); //channel.appendLine(dx); const range = document.getWordRangeAtPosition(position); - - const word = document.getText(range); - return new Hover(`XQuery Hover info: ${word} at ${position.line}: ${position.character} - value: ${ node.value }, name: ${ node.name } - `); - return null; //if there is no information to show + const word = document.getText(range); + + if (Configuration.xqueryShowHovers(document.uri)) { + return new Hover(`XQuery Hover info: ${word} at ${position.line}: ${position.character} + value: ${node.value}, name: ${node.name} + `); + } else { + return null; //if there is no information to show + } } -} +} \ No newline at end of file