@platformos/platformos-language-server-common 0.0.9 → 0.0.11

package/dist/utils/debounce.d.ts

@@ -24,7 +24,7 @@ export interface DebouncedFunction<F extends Function> {
  * This is useful in cases where you have an "expensive" function that you only want
  * to execute after the user is idle for a little bit.
  *
- * e.g. Run theme check after the user has stopped typing for at least 100ms.
+ * e.g. Run platformos-check after the user has stopped typing for at least 100ms.
  *
  * The debounced function has the same type signature as its argument.
  *

package/dist/utils/debounce.js

@@ -11,7 +11,7 @@ exports.debounce = debounce;
  * This is useful in cases where you have an "expensive" function that you only want
  * to execute after the user is idle for a little bit.
  *
- * e.g. Run theme check after the user has stopped typing for at least 100ms.
+ * e.g. Run platformos-check after the user has stopped typing for at least 100ms.
  *
  * The debounced function has the same type signature as its argument.
  *

package/dist/utils/liquidDoc.js

@@ -21,7 +21,7 @@ function formatLiquidDocTagHandle(label, description, example) {
 }
 exports.SUPPORTED_LIQUID_DOC_TAG_HANDLES = {
     [platformos_check_common_1.SupportedDocTagTypes.Param]: {
-        description: 'Provides information about a parameter for the snippet.\n' +
+        description: 'Provides information about a parameter for the partial.\n' +
             `- The type of parameter is optional and can be ${Object.values(platformos_check_common_1.BasicParamTypes)
                 .map((type) => `\`${type}\``)
                 .join(', ')}\n` +
@@ -36,13 +36,13 @@ exports.SUPPORTED_LIQUID_DOC_TAG_HANDLES = {
         template: `param {$2} $1$0`,
     },
     [platformos_check_common_1.SupportedDocTagTypes.Example]: {
-        description: 'Provides an example on how to use the snippet.',
-        example: '{% doc %}\n' + '  @example {% render "snippet-name", arg1: "value" %}\n' + '{% enddoc %}\n',
+        description: 'Provides an example on how to use the partial.',
+        example: '{% doc %}\n' + '  @example {% render "partial-name", arg1: "value" %}\n' + '{% enddoc %}\n',
         template: `example $0`,
     },
     [platformos_check_common_1.SupportedDocTagTypes.Description]: {
-        description: 'Provides information on what the snippet does.',
-        example: '{% doc %}\n' + '  @description This snippet renders a product image.\n' + '{% enddoc %}\n',
+        description: 'Provides information on what the partial does.',
+        example: '{% doc %}\n' + '  @description This partial renders a product image.\n' + '{% enddoc %}\n',
         template: `description $0`,
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformos/platformos-language-server-common",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "platformOS",
@@ -27,9 +27,9 @@
     "type-check": "tsc --noEmit -p ./tsconfig.json"
   },
   "dependencies": {
-    "@platformos/liquid-html-parser": "^0.0.9",
-    "@platformos/platformos-check-common": "0.0.9",
-    "@platformos/platformos-graph": "0.0.9",
+    "@platformos/liquid-html-parser": "^0.0.10",
+    "@platformos/platformos-check-common": "0.0.11",
+    "@platformos/platformos-graph": "0.0.11",
     "@vscode/web-custom-data": "^0.4.6",
     "vscode-json-languageservice": "^5.7.1",
     "vscode-languageserver": "^9.0.1",

package/dist/codeActions/providers/GenerateDocBlockProvider.d.ts

@@ -1,10 +0,0 @@
-import { CodeAction, CodeActionParams, Command } from 'vscode-languageserver';
-import { BaseCodeActionsProvider } from '../BaseCodeActionsProvider';
-/**
- * GenerateDocBlockProvider provides a source action to generate {% doc %} blocks
- * for partials and blocks based on detected parameters.
- */
-export declare class GenerateDocBlockProvider extends BaseCodeActionsProvider {
-    static kind: "source";
-    codeActions(params: CodeActionParams): (Command | CodeAction)[];
-}

package/dist/codeActions/providers/GenerateDocBlockProvider.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GenerateDocBlockProvider = void 0;
-const vscode_languageserver_1 = require("vscode-languageserver");
-const platformos_check_common_1 = require("@platformos/platformos-check-common");
-const BaseCodeActionsProvider_1 = require("../BaseCodeActionsProvider");
-/**
- * GenerateDocBlockProvider provides a source action to generate {% doc %} blocks
- * for partials and blocks based on detected parameters.
- */
-class GenerateDocBlockProvider extends BaseCodeActionsProvider_1.BaseCodeActionsProvider {
-    codeActions(params) {
-        const { uri } = params.textDocument;
-        const document = this.documentManager.get(uri);
-        if (!document)
-            return [];
-        // Only provide for liquid files that support doc blocks (partials/blocks)
-        if (!(0, platformos_check_common_1.filePathSupportsLiquidDoc)(uri))
-            return [];
-        // Check if file already has a doc block
-        const ast = document.ast;
-        if ((0, platformos_check_common_1.isError)(ast))
-            return [];
-        // Return a code action that will trigger the command
-        const codeAction = {
-            title: 'Generate doc block from parameters',
-            kind: GenerateDocBlockProvider.kind,
-            command: {
-                title: 'Generate Doc Block',
-                command: 'platformOS.generateDocBlock',
-                arguments: [uri, document.version],
-            },
-        };
-        return [codeAction];
-    }
-}
-exports.GenerateDocBlockProvider = GenerateDocBlockProvider;
-GenerateDocBlockProvider.kind = vscode_languageserver_1.CodeActionKind.Source;
-//# sourceMappingURL=GenerateDocBlockProvider.js.map

package/dist/codeActions/providers/GenerateDocBlockProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"GenerateDocBlockProvider.js","sourceRoot":"","sources":["../../../src/codeActions/providers/GenerateDocBlockProvider.ts"],"names":[],"mappings":";;;AAAA,iEAK+B;AAC/B,iFAAyF;AACzF,wEAAqE;AAGrE;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,iDAAuB;IAGnE,WAAW,CAAC,MAAwB;QAClC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE/C,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAEzB,0EAA0E;QAC1E,IAAI,CAAC,IAAA,mDAAyB,EAAC,GAAG,CAAC;YAAE,OAAO,EAAE,CAAC;QAE/C,wCAAwC;QACxC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACzB,IAAI,IAAA,iCAAO,EAAC,GAAG,CAAC;YAAE,OAAO,EAAE,CAAC;QAE5B,qDAAqD;QACrD,MAAM,UAAU,GAAe;YAC7B,KAAK,EAAE,oCAAoC;YAC3C,IAAI,EAAE,wBAAwB,CAAC,IAAI;YACnC,OAAO,EAAE;gBACP,KAAK,EAAE,oBAAoB;gBAC3B,OAAO,EAAE,6BAA6B;gBACtC,SAAS,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC;aACnC;SACF,CAAC;QAEF,OAAO,CAAC,UAAU,CAAC,CAAC;IACtB,CAAC;;AA5BH,4DA6BC;AA5BQ,6BAAI,GAAG,sCAAc,CAAC,MAAM,CAAC"}

package/dist/commands/providers/GenerateDocBlockCommandProvider.d.ts

@@ -1,19 +0,0 @@
-import { ThemeDocset } from '@platformos/platformos-check-common';
-import { Command } from 'vscode-languageserver';
-import { BaseExecuteCommandProvider } from '../BaseExecuteCommandProvider';
-/**
- * GenerateDocBlockCommandProvider handles the `platformOS.generateDocBlock` command.
- *
- * It generates a {% doc %} block based on detected parameters in a partial/block file
- * and inserts it at the beginning of the file.
- */
-export declare class GenerateDocBlockCommandProvider extends BaseExecuteCommandProvider {
-    static command: "platformOS.generateDocBlock";
-    private themeDocset;
-    setThemeDocset(themeDocset: ThemeDocset): void;
-    execute(uri: string, version: number | undefined): Promise<void>;
-}
-/**
- * Creates a command to generate a doc block for the given URI.
- */
-export declare function generateDocBlockCommand(uri: string, version: number | undefined): Command;

package/dist/commands/providers/GenerateDocBlockCommandProvider.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GenerateDocBlockCommandProvider = void 0;
-exports.generateDocBlockCommand = generateDocBlockCommand;
-const platformos_check_common_1 = require("@platformos/platformos-check-common");
-const vscode_languageserver_1 = require("vscode-languageserver");
-const BaseExecuteCommandProvider_1 = require("../BaseExecuteCommandProvider");
-/**
- * GenerateDocBlockCommandProvider handles the `platformOS.generateDocBlock` command.
- *
- * It generates a {% doc %} block based on detected parameters in a partial/block file
- * and inserts it at the beginning of the file.
- */
-class GenerateDocBlockCommandProvider extends BaseExecuteCommandProvider_1.BaseExecuteCommandProvider {
-    setThemeDocset(themeDocset) {
-        this.themeDocset = themeDocset;
-    }
-    async execute(uri, version) {
-        if (!this.clientCapabilities.hasApplyEditSupport)
-            return;
-        const document = this.documentManager.get(uri);
-        if (!document || document.type !== platformos_check_common_1.SourceCodeType.LiquidHtml)
-            return;
-        if (version !== undefined && document.version !== version)
-            return;
-        const ast = document.ast;
-        if ((0, platformos_check_common_1.isError)(ast))
-            return;
-        // Generate the doc block
-        const result = await (0, platformos_check_common_1.generateDocBlock)(ast, uri, this.themeDocset);
-        // If there's already a doc block, notify the user and return
-        if (result.hasExistingDocBlock) {
-            // File already has a doc block - we could update it, but for now just skip
-            // The user can manually edit or we could offer a separate "Update doc block" command
-            return;
-        }
-        // If no parameters were detected, still insert an empty doc block
-        const docBlockText = result.docBlockText;
-        // Insert at the beginning of the file (line 0, character 0)
-        const textEdit = {
-            range: {
-                start: { line: 0, character: 0 },
-                end: { line: 0, character: 0 },
-            },
-            newText: docBlockText + '\n\n',
-        };
-        const textDocumentEdit = vscode_languageserver_1.TextDocumentEdit.create({ uri: document.textDocument.uri, version: document.textDocument.version }, [textEdit]);
-        await this.connection.sendRequest(vscode_languageserver_1.ApplyWorkspaceEditRequest.type, {
-            label: 'Generate doc block',
-            edit: {
-                documentChanges: [textDocumentEdit],
-            },
-        });
-    }
-}
-exports.GenerateDocBlockCommandProvider = GenerateDocBlockCommandProvider;
-GenerateDocBlockCommandProvider.command = 'platformOS.generateDocBlock';
-/**
- * Creates a command to generate a doc block for the given URI.
- */
-function generateDocBlockCommand(uri, version) {
-    return vscode_languageserver_1.Command.create('Generate Doc Block', GenerateDocBlockCommandProvider.command, uri, version);
-}
-//# sourceMappingURL=GenerateDocBlockCommandProvider.js.map

package/dist/commands/providers/GenerateDocBlockCommandProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"GenerateDocBlockCommandProvider.js","sourceRoot":"","sources":["../../../src/commands/providers/GenerateDocBlockCommandProvider.ts"],"names":[],"mappings":";;;AA8EA,0DAEC;AAhFD,iFAK6C;AAC7C,iEAK+B;AAC/B,8EAA2E;AAE3E;;;;;GAKG;AACH,MAAa,+BAAgC,SAAQ,uDAA0B;IAK7E,cAAc,CAAC,WAAwB;QACrC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,OAA2B;QACpD,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,mBAAmB;YAAE,OAAO;QAEzD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,wCAAc,CAAC,UAAU;YAAE,OAAO;QACrE,IAAI,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,OAAO;YAAE,OAAO;QAElE,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACzB,IAAI,IAAA,iCAAO,EAAC,GAAG,CAAC;YAAE,OAAO;QAEzB,yBAAyB;QACzB,MAAM,MAAM,GAAG,MAAM,IAAA,0CAAgB,EAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAElE,6DAA6D;QAC7D,IAAI,MAAM,CAAC,mBAAmB,EAAE,CAAC;YAC/B,2EAA2E;YAC3E,qFAAqF;YACrF,OAAO;QACT,CAAC;QAED,kEAAkE;QAClE,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAEzC,4DAA4D;QAC5D,MAAM,QAAQ,GAAa;YACzB,KAAK,EAAE;gBACL,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE;gBAChC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE;aAC/B;YACD,OAAO,EAAE,YAAY,GAAG,MAAM;SAC/B,CAAC;QAEF,MAAM,gBAAgB,GAAG,wCAAgB,CAAC,MAAM,CAC9C,EAAE,GAAG,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,EAC1E,CAAC,QAAQ,CAAC,CACX,CAAC;QAEF,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,iDAAyB,CAAC,IAAI,EAAE;YAChE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE;gBACJ,eAAe,EAAE,CAAC,gBAAgB,CAAC;aACpC;SACF,CAAC,CAAC;IACL,CAAC;;AApDH,0EAqDC;AApDQ,uCAAO,GAAG,6BAAsC,CAAC;AAsD1D;;GAEG;AACH,SAAgB,uBAAuB,CAAC,GAAW,EAAE,OAA2B;IAC9E,OAAO,+BAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,+BAA+B,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AACrG,CAAC"}