volar-service-html 0.0.13 → 0.0.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present Johnson Chu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# volar-service-html
+
+Volar plugin for [`vscode-html-languageservice`](https://github.com/microsoft/vscode-html-languageservice).
+
+## Installation
+
+```sh
+npm install volar-service-html
+```
+
+## Usage
+
+`volar.config.js`
+
+```js
+module.exports = {
+	services: [
+		require('volar-service-html').create(),
+	],
+};
+```
+
+## License
+
+[MIT](LICENSE) © [Johnson Chu](https://github.com/johnsoncodehk)

package/out/index.d.ts

@@ -8,8 +8,10 @@ export interface Provide {
     'html/updateCustomData': (extraData: html.IHTMLDataProvider[]) => void;
 }
 export declare function getHtmlDocument(document: TextDocument): html.HTMLDocument;
-export declare function create(options?: {
-    validLang?: string;
-    disableCustomData?: boolean;
+export declare function create({ languageId, useDefaultDataProvider, useCustomDataProviders, }?: {
+    languageId?: string;
+    useDefaultDataProvider?: boolean;
+    useCustomDataProviders?: boolean;
 }): Service<Provide>;
 export default create;
+//# sourceMappingURL=index.d.ts.map

package/out/index.js

@@ -1,31 +1,8 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = exports.getHtmlDocument = void 0;
-const html = __importStar(require("vscode-html-languageservice"));
-const path = __importStar(require("path"));
+const html = require("vscode-html-languageservice");
+const path = require("path");
 const vscode_uri_1 = require("vscode-uri");
 const parserLs = html.getLanguageService();
 const htmlDocuments = new WeakMap();
@@ -44,7 +21,7 @@ function getHtmlDocument(document) {
 exports.getHtmlDocument = getHtmlDocument;
 // https://github.com/microsoft/vscode/blob/09850876e652688fb142e2e19fd00fd38c0bc4ba/extensions/html-language-features/server/src/htmlServer.ts#L183
 const triggerCharacters = ['.', ':', '<', '"', '=', '/'];
-function create(options = {}) {
+function create({ languageId = 'html', useDefaultDataProvider = true, useCustomDataProviders = true, } = {}) {
     return (context) => {
         if (!context) {
             return { triggerCharacters };
@@ -85,7 +62,7 @@ function create(options = {}) {
         return {
             provide: {
                 'html/htmlDocument': (document) => {
-                    if (document.languageId === (options.validLang ?? 'html')) {
+                    if (document.languageId === languageId) {
                         return getHtmlDocument(document);
                     }
                 },
@@ -132,12 +109,7 @@ function create(options = {}) {
             },
             provideDocumentSymbols(document) {
                 return worker(document, (htmlDocument) => {
-                    // TODO: wait for https://github.com/microsoft/vscode-html-languageservice/pull/152
-                    const symbols = [];
-                    htmlDocument.roots.forEach(node => {
-                        provideFileSymbolsInternal(document, node, symbols);
-                    });
-                    return symbols;
+                    return htmlLs.findDocumentSymbols2(document, htmlDocument);
                 });
             },
             provideFoldingRanges(document) {
@@ -260,15 +232,15 @@ function create(options = {}) {
             },
         };
         async function initCustomData() {
-            if (shouldUpdateCustomData && !options.disableCustomData) {
+            if (shouldUpdateCustomData && useCustomDataProviders) {
                 shouldUpdateCustomData = false;
                 customData = await getCustomData();
-                htmlLs.setDataProviders(true, [...customData, ...extraData]);
+                htmlLs.setDataProviders(useDefaultDataProvider, [...customData, ...extraData]);
             }
         }
         function updateExtraCustomData(data) {
             extraData = data;
-            htmlLs.setDataProviders(true, [...customData, ...extraData]);
+            htmlLs.setDataProviders(useDefaultDataProvider, [...customData, ...extraData]);
         }
         async function getCustomData() {
             const customData = await context?.env.getConfiguration?.('html.customData') ?? [];
@@ -285,7 +257,7 @@ function create(options = {}) {
             return newData;
         }
         async function worker(document, callback) {
-            if (document.languageId !== (options.validLang ?? 'html'))
+            if (document.languageId !== languageId)
                 return;
             const htmlDocument = getHtmlDocument(document);
             if (!htmlDocument)
@@ -305,36 +277,4 @@ const NL = '\n'.charCodeAt(0);
 function isNewlineCharacter(charCode) {
     return charCode === CR || charCode === NL;
 }
-function provideFileSymbolsInternal(document, node, symbols) {
-    const name = nodeToName(node);
-    const range = {
-        start: document.positionAt(node.start),
-        end: document.positionAt(node.end),
-    };
-    const symbol = {
-        name,
-        kind: 8,
-        range,
-        selectionRange: range,
-    };
-    symbols.push(symbol);
-    node.children.forEach(child => {
-        symbol.children ??= [];
-        provideFileSymbolsInternal(document, child, symbol.children);
-    });
-}
-function nodeToName(node) {
-    let name = node.tag;
-    if (node.attributes) {
-        const id = node.attributes['id'];
-        const classes = node.attributes['class'];
-        if (id) {
-            name += `#${id.replace(/[\"\']/g, '')}`;
-        }
-        if (classes) {
-            name += classes.replace(/[\"\']/g, '').split(/\s+/).map(className => `.${className}`).join('');
-        }
-    }
-    return name || '?';
-}
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,13 @@
 {
 	"name": "volar-service-html",
-	"version": "0.0.13",
+	"version": "0.0.15",
+	"description": "Integrate vscode-languageservice-html into Volar",
+	"homepage": "https://github.com/volarjs/services/tree/master/packages/html",
+	"bugs": "https://github.com/volarjs/services/issues",
+	"sideEffects": false,
+	"keywords": [
+		"volar-service"
+	],
 	"main": "out/index.js",
 	"license": "MIT",
 	"files": [
@@ -12,12 +19,17 @@
 		"url": "https://github.com/volarjs/services.git",
 		"directory": "packages/html"
 	},
+	"author": {
+		"name": "Johnson Chu",
+		"email": "johnsoncodehk@gmail.com",
+		"url": "https://github.com/johnsoncodehk"
+	},
 	"dependencies": {
-		"vscode-html-languageservice": "^5.0.4",
-		"vscode-uri": "^3.0.7"
+		"vscode-html-languageservice": "^5.1.0",
+		"vscode-uri": "^3.0.8"
 	},
 	"devDependencies": {
-		"vscode-languageserver-textdocument": "^1.0.8"
+		"vscode-languageserver-textdocument": "^1.0.11"
 	},
 	"peerDependencies": {
 		"@volar/language-service": "~1.10.0"
@@ -27,5 +39,5 @@
 			"optional": true
 		}
 	},
-	"gitHead": "eeaa0ff3504c0ec251c8ad9cb2847f89a2c58865"
+	"gitHead": "3a59378715a959b433ca65700d2515d708469388"
 }