@platformos/platformos-language-server-common 0.0.2

package/dist/types.d.ts

@@ -0,0 +1,149 @@
+import { Config, Dependencies as ThemeCheckDependencies } from '@platformos/platformos-check-common';
+import { AbstractFileSystem } from '@platformos/platformos-common';
+import { URI } from 'vscode-languageserver';
+import * as rpc from 'vscode-jsonrpc';
+import { WithOptional } from './utils';
+import { Range } from 'vscode-json-languageservice';
+import { Reference } from '@platformos/platformos-graph';
+export type Dependencies = WithOptional<RequiredDependencies, 'log' | 'getMetafieldDefinitions' | 'fetchMetafieldDefinitionsForURI'>;
+export interface RequiredDependencies {
+    /**
+     * A basic logging function.
+     *
+     * You might want console.log in development, and bugsnag in production.
+     */
+    log(message: string): void;
+    /**
+     * loadConfig(uri)
+     *
+     * In local environments, it's possible for one Language Server to deal
+     * with a workspace that contains many different configurations. In the
+     * browser, it isn't.
+     *
+     * loadConfig is the runtime-agnostic solution.
+     *
+     * @example
+     *
+     * Here's an example VS Code workspace a partner could run
+     * ```
+     * theme1/
+     *   src/
+     *     locales/
+     *     sections/
+     *     snippets/
+     *   dist/
+     *     locales/
+     *     sections/
+     *       foo.liquud
+     *     snippets/
+     * theme2/
+     *   locales/
+     *   sections/
+     *   snippets/
+     * ```
+     *
+     * In this situation, we have 3 different "roots."
+     *
+     * @param uri - a file path
+     * @returns {Promise<Config>}
+     */
+    loadConfig(uri: URI, fs: AbstractFileSystem): Promise<Config>;
+    /**
+     * In local environments, the Language Server can download the latest versions
+     * of themes docset from `Shopify/theme-liquid-docs`. However, this is not
+     * possible in the browser, so we implement different solutions for each
+     * environment.
+     */
+    themeDocset: NonNullable<ThemeCheckDependencies['themeDocset']>;
+    /**
+     * In local environments, the Language Server can download the latest versions
+     * of themes schemas from `Shopify/theme-liquid-docs`. Due to limitations in
+     * browser environments, json schemas must be precompiled into validators prior
+     * to theme-check instantiation.
+     */
+    jsonValidationSet: NonNullable<ThemeCheckDependencies['jsonValidationSet']>;
+    /**
+     * A file system abstraction that allows the Language Server to read files by URI.
+     *
+     * In Node.js, this is a wrapper around node:fs/promises.
+     *
+     * In VS Code, this is a wrapper around the VS Code API.
+     *
+     * The browser accepts a custom implementation.
+     */
+    fs: AbstractFileSystem;
+    /**
+     * In local environments, the Language Server can download the metafield definitions
+     * and provide a set of memoized definitions. In other environments, we rely on dynamically
+     * fetching the set of metafield definitions every time.
+     */
+    getMetafieldDefinitions: ThemeCheckDependencies['getMetafieldDefinitions'];
+    /**
+     * Fetch Metafield definitions using the CLI provided the URI of the project root.
+     * This should only be used in node environments; not on the browser.
+     */
+    fetchMetafieldDefinitionsForURI: (uri: URI) => Promise<void>;
+}
+export declare namespace ThemeGraphReferenceRequest {
+    const method = "themeGraph/references";
+    const type: rpc.RequestType<Params, Response, void>;
+    interface Params {
+        uri: string;
+        offset?: number;
+        includeIndirect?: boolean;
+    }
+    type Response = AugmentedReference[];
+}
+export declare namespace ThemeGraphDependenciesRequest {
+    const method = "themeGraph/dependencies";
+    const type: rpc.RequestType<Params, Response, void>;
+    interface Params {
+        uri: string;
+        offset?: number;
+        includeIndirect?: boolean;
+    }
+    type Response = AugmentedReference[];
+}
+export declare namespace ThemeGraphRootRequest {
+    const method = "themeGraph/rootUri";
+    const type: rpc.RequestType<Params, string, void>;
+    interface Params {
+        uri: string;
+    }
+    type Response = string;
+}
+export declare namespace ThemeGraphDeadCodeRequest {
+    const method = "themeGraph/deadCode";
+    const type: rpc.RequestType<Params, Response, void>;
+    interface Params {
+        uri: string;
+    }
+    type Response = string[];
+}
+export declare namespace ThemeGraphDidUpdateNotification {
+    const method = "themeGraph/onDidChangeTree";
+    const type: rpc.NotificationType<Params>;
+    interface Params {
+        uri: string;
+    }
+}
+export type AugmentedLocationWithExistence = {
+    uri: string;
+    range: undefined;
+    excerpt: undefined;
+    position: undefined;
+    exists: boolean;
+};
+export type AugmentedLocationWithExcerpt = {
+    uri: string;
+    range: [number, number];
+    excerpt: string;
+    position: Range;
+    exists: boolean;
+};
+export type AugmentedLocation = AugmentedLocationWithExistence | AugmentedLocationWithExcerpt;
+export interface AugmentedReference extends Reference {
+    source: AugmentedLocation;
+    target: AugmentedLocation;
+    indirect: boolean;
+}

package/dist/types.js

@@ -0,0 +1,63 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThemeGraphDidUpdateNotification = exports.ThemeGraphDeadCodeRequest = exports.ThemeGraphRootRequest = exports.ThemeGraphDependenciesRequest = exports.ThemeGraphReferenceRequest = void 0;
+const rpc = __importStar(require("vscode-jsonrpc"));
+var ThemeGraphReferenceRequest;
+(function (ThemeGraphReferenceRequest) {
+    ThemeGraphReferenceRequest.method = 'themeGraph/references';
+    ThemeGraphReferenceRequest.type = new rpc.RequestType(ThemeGraphReferenceRequest.method);
+})(ThemeGraphReferenceRequest || (exports.ThemeGraphReferenceRequest = ThemeGraphReferenceRequest = {}));
+var ThemeGraphDependenciesRequest;
+(function (ThemeGraphDependenciesRequest) {
+    ThemeGraphDependenciesRequest.method = 'themeGraph/dependencies';
+    ThemeGraphDependenciesRequest.type = new rpc.RequestType(ThemeGraphDependenciesRequest.method);
+})(ThemeGraphDependenciesRequest || (exports.ThemeGraphDependenciesRequest = ThemeGraphDependenciesRequest = {}));
+var ThemeGraphRootRequest;
+(function (ThemeGraphRootRequest) {
+    ThemeGraphRootRequest.method = 'themeGraph/rootUri';
+    ThemeGraphRootRequest.type = new rpc.RequestType(ThemeGraphRootRequest.method);
+})(ThemeGraphRootRequest || (exports.ThemeGraphRootRequest = ThemeGraphRootRequest = {}));
+var ThemeGraphDeadCodeRequest;
+(function (ThemeGraphDeadCodeRequest) {
+    ThemeGraphDeadCodeRequest.method = 'themeGraph/deadCode';
+    ThemeGraphDeadCodeRequest.type = new rpc.RequestType(ThemeGraphDeadCodeRequest.method);
+})(ThemeGraphDeadCodeRequest || (exports.ThemeGraphDeadCodeRequest = ThemeGraphDeadCodeRequest = {}));
+var ThemeGraphDidUpdateNotification;
+(function (ThemeGraphDidUpdateNotification) {
+    ThemeGraphDidUpdateNotification.method = 'themeGraph/onDidChangeTree';
+    ThemeGraphDidUpdateNotification.type = new rpc.NotificationType(ThemeGraphDidUpdateNotification.method);
+})(ThemeGraphDidUpdateNotification || (exports.ThemeGraphDidUpdateNotification = ThemeGraphDidUpdateNotification = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,oDAAsC;AAgGtC,IAAiB,0BAA0B,CAS1C;AATD,WAAiB,0BAA0B;IAC5B,iCAAM,GAAG,uBAAuB,CAAC;IACjC,+BAAI,GAAG,IAAI,GAAG,CAAC,WAAW,CAAyB,2BAAA,MAAM,CAAC,CAAC;AAO1E,CAAC,EATgB,0BAA0B,0CAA1B,0BAA0B,QAS1C;AAED,IAAiB,6BAA6B,CAS7C;AATD,WAAiB,6BAA6B;IAC/B,oCAAM,GAAG,yBAAyB,CAAC;IACnC,kCAAI,GAAG,IAAI,GAAG,CAAC,WAAW,CAAyB,8BAAA,MAAM,CAAC,CAAC;AAO1E,CAAC,EATgB,6BAA6B,6CAA7B,6BAA6B,QAS7C;AAED,IAAiB,qBAAqB,CAOrC;AAPD,WAAiB,qBAAqB;IACvB,4BAAM,GAAG,oBAAoB,CAAC;IAC9B,0BAAI,GAAG,IAAI,GAAG,CAAC,WAAW,CAAyB,sBAAA,MAAM,CAAC,CAAC;AAK1E,CAAC,EAPgB,qBAAqB,qCAArB,qBAAqB,QAOrC;AAED,IAAiB,yBAAyB,CAOzC;AAPD,WAAiB,yBAAyB;IAC3B,gCAAM,GAAG,qBAAqB,CAAC;IAC/B,8BAAI,GAAG,IAAI,GAAG,CAAC,WAAW,CAAyB,0BAAA,MAAM,CAAC,CAAC;AAK1E,CAAC,EAPgB,yBAAyB,yCAAzB,yBAAyB,QAOzC;AAED,IAAiB,+BAA+B,CAM/C;AAND,WAAiB,+BAA+B;IACjC,sCAAM,GAAG,4BAA4B,CAAC;IACtC,oCAAI,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAS,gCAAA,MAAM,CAAC,CAAC;AAI/D,CAAC,EANgB,+BAA+B,+CAA/B,+BAA+B,QAM/C"}

package/dist/utils/array.d.ts

@@ -0,0 +1 @@
+export declare function findLast<T>(array: T[], pred: (n: T) => boolean): T | undefined;

package/dist/utils/array.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findLast = findLast;
+// Array.prototype.findLast is only available in es2023. Which feels too new?
+function findLast(array, pred) {
+    for (let i = array.length - 1; i >= 0; i--) {
+        if (pred(array[i]))
+            return array[i];
+    }
+}
+//# sourceMappingURL=array.js.map

package/dist/utils/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../src/utils/array.ts"],"names":[],"mappings":";;AACA,4BAIC;AALD,6EAA6E;AAC7E,SAAgB,QAAQ,CAAI,KAAU,EAAE,IAAuB;IAC7D,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;AACH,CAAC"}

package/dist/utils/debounce.d.ts

@@ -0,0 +1,37 @@
+import { ArgumentTypes } from '@platformos/platformos-check-common';
+export interface DebouncedFunction<F extends Function> {
+    /**
+     * A function that will execute on the trailing edge of a timer with the
+     * last arguments it was called with (unless forced)
+     */
+    (...args: ArgumentTypes<F>): void;
+    /**
+     * Debounced version of a function but making sure that it is called with
+     * this specific set of arguments.
+     *
+     * Subsequent calls will be ignored until the timer has expired and the
+     * function has executed.
+     */
+    force(...args: ArgumentTypes<F>): void;
+}
+/**
+ * debounce(fn, ms)
+ *
+ * A debounced function only executes once after a timer has expired. Repeated
+ * call to the debounced function before its timer has expired result in a delayed
+ * execution of the 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.
+ *
+ * The debounced function has the same type signature as its argument.
+ *
+ * The input function must return void (or else you might "bomb" when you resolve).
+ *
+ * @param fn a function that should be debounced
+ * @param ms milliseconds after last function call for it to execute
+ * @returns a function that will execute on the trailing edge of a timer with the last argument it was called with
+ */
+export declare function debounce<F extends Function>(fn: F, ms?: number): DebouncedFunction<F>;

package/dist/utils/debounce.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debounce = debounce;
+/**
+ * debounce(fn, ms)
+ *
+ * A debounced function only executes once after a timer has expired. Repeated
+ * call to the debounced function before its timer has expired result in a delayed
+ * execution of the 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.
+ *
+ * The debounced function has the same type signature as its argument.
+ *
+ * The input function must return void (or else you might "bomb" when you resolve).
+ *
+ * @param fn a function that should be debounced
+ * @param ms milliseconds after last function call for it to execute
+ * @returns a function that will execute on the trailing edge of a timer with the last argument it was called with
+ */
+function debounce(fn, ms) {
+    let timeoutId = null;
+    let force = false; // force use a certain set of arguments in the next call
+    const debouncedFn = (...args) => {
+        if (timeoutId !== null && force)
+            return;
+        if (timeoutId !== null)
+            clearTimeout(timeoutId);
+        timeoutId = setTimeout(async () => {
+            await Promise.resolve(fn(...args));
+            timeoutId = null;
+            force = false;
+        }, ms);
+    };
+    debouncedFn.force = (...args) => {
+        debouncedFn(...args);
+        force = true;
+    };
+    return debouncedFn;
+}
+//# sourceMappingURL=debounce.js.map

package/dist/utils/debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../src/utils/debounce.ts"],"names":[],"mappings":";;AAuCA,4BAoBC;AAxCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,QAAQ,CAAqB,EAAK,EAAE,EAAW;IAC7D,IAAI,SAAS,GAAyC,IAAI,CAAC;IAC3D,IAAI,KAAK,GAAG,KAAK,CAAC,CAAC,wDAAwD;IAE3E,MAAM,WAAW,GAAG,CAAC,GAAG,IAAsB,EAAQ,EAAE;QACtD,IAAI,SAAS,KAAK,IAAI,IAAI,KAAK;YAAE,OAAO;QACxC,IAAI,SAAS,KAAK,IAAI;YAAE,YAAY,CAAC,SAAS,CAAC,CAAC;QAChD,SAAS,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YACnC,SAAS,GAAG,IAAI,CAAC;YACjB,KAAK,GAAG,KAAK,CAAC;QAChB,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC,CAAC;IAEF,WAAW,CAAC,KAAK,GAAG,CAAC,GAAG,IAAsB,EAAQ,EAAE;QACtD,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;QACrB,KAAK,GAAG,IAAI,CAAC;IACf,CAAC,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/utils/htmlTagNames.d.ts

@@ -0,0 +1,5 @@
+import { LiquidHtmlNode } from '@platformos/liquid-html-parser';
+import { TextDocumentPositionParams, Range } from 'vscode-languageserver';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+export declare function getHtmlElementNameRanges(node: LiquidHtmlNode, ancestors: LiquidHtmlNode[], params: TextDocumentPositionParams, textDocument: TextDocument): Range[] | null;
+export declare function isDanglingOpenHtmlElement(node: LiquidHtmlNode): boolean;

package/dist/utils/htmlTagNames.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHtmlElementNameRanges = getHtmlElementNameRanges;
+exports.isDanglingOpenHtmlElement = isDanglingOpenHtmlElement;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+const vscode_languageserver_1 = require("vscode-languageserver");
+const isCovered_1 = require("./isCovered");
+function getHtmlElementNameRanges(node, ancestors, params, textDocument) {
+    let htmlElementNode = null;
+    // Try parent node as HTML Element
+    // <name> case
+    const parentNode = ancestors.at(-1);
+    if (parentNode &&
+        parentNode.type === liquid_html_parser_1.NodeTypes.HtmlElement &&
+        parentNode.name.length > 0 &&
+        (0, isCovered_1.isCovered)(textDocument.offsetAt(params.position), {
+            start: parentNode.name[0].position.start,
+            end: parentNode.name.at(-1).position.end,
+        })) {
+        htmlElementNode = parentNode;
+    }
+    // </name> case
+    if (node.type === liquid_html_parser_1.NodeTypes.HtmlElement &&
+        node.name.length > 0 &&
+        (0, isCovered_1.isCovered)(textDocument.offsetAt(params.position), node.blockEndPosition)) {
+        htmlElementNode = node;
+    }
+    if (!htmlElementNode || isDanglingOpenHtmlElement(htmlElementNode))
+        return null;
+    const nameNodes = htmlElementNode.name;
+    const firstNode = nameNodes.at(0);
+    const lastNode = nameNodes.at(-1);
+    const startRange = vscode_languageserver_1.Range.create(textDocument.positionAt(firstNode.position.start), textDocument.positionAt(lastNode.position.end));
+    const endRange = vscode_languageserver_1.Range.create(
+    // </ means offset 2 characters
+    textDocument.positionAt(htmlElementNode.blockEndPosition.start + 2), textDocument.positionAt(htmlElementNode.blockEndPosition.end - 1));
+    return [startRange, endRange];
+}
+function isDanglingOpenHtmlElement(node) {
+    return (node.type === liquid_html_parser_1.NodeTypes.HtmlElement && node.blockEndPosition.start === node.blockEndPosition.end);
+}
+//# sourceMappingURL=htmlTagNames.js.map

package/dist/utils/htmlTagNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"htmlTagNames.js","sourceRoot":"","sources":["../../src/utils/htmlTagNames.ts"],"names":[],"mappings":";;AAKA,4DAiDC;AAED,8DAIC;AA5DD,uEAAwF;AACxF,iEAA0E;AAE1E,2CAAwC;AAExC,SAAgB,wBAAwB,CACtC,IAAoB,EACpB,SAA2B,EAC3B,MAAkC,EAClC,YAA0B;IAE1B,IAAI,eAAe,GAAuB,IAAI,CAAC;IAE/C,kCAAkC;IAClC,cAAc;IACd,MAAM,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,IACE,UAAU;QACV,UAAU,CAAC,IAAI,KAAK,8BAAS,CAAC,WAAW;QACzC,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAC1B,IAAA,qBAAS,EAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAChD,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK;YACxC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,QAAQ,CAAC,GAAG;SAC1C,CAAC,EACF,CAAC;QACD,eAAe,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,eAAe;IACf,IACE,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,WAAW;QACnC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QACpB,IAAA,qBAAS,EAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,EACxE,CAAC;QACD,eAAe,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,CAAC,eAAe,IAAI,yBAAyB,CAAC,eAAe,CAAC;QAAE,OAAO,IAAI,CAAC;IAEhF,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC;IACvC,MAAM,SAAS,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC;IACnC,MAAM,QAAQ,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;IACnC,MAAM,UAAU,GAAG,6BAAK,CAAC,MAAM,CAC7B,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EACjD,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC/C,CAAC;IAEF,MAAM,QAAQ,GAAG,6BAAK,CAAC,MAAM;IAC3B,+BAA+B;IAC/B,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,KAAK,GAAG,CAAC,CAAC,EACnE,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAC,CAAC,CAClE,CAAC;IAEF,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAChC,CAAC;AAED,SAAgB,yBAAyB,CAAC,IAAoB;IAC5D,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,WAAW,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,KAAK,IAAI,CAAC,gBAAgB,CAAC,GAAG,CACjG,CAAC;AACJ,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+export { ArgumentTypes, WithOptional, WithRequired, memo, memoize, parseJSON, } from '@platformos/platformos-check-common';
+export * from './debounce';
+export * from './array';
+export * from './node';
+export * from './isCovered';

package/dist/utils/index.js

@@ -0,0 +1,26 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseJSON = exports.memoize = exports.memo = void 0;
+var platformos_check_common_1 = require("@platformos/platformos-check-common");
+Object.defineProperty(exports, "memo", { enumerable: true, get: function () { return platformos_check_common_1.memo; } });
+Object.defineProperty(exports, "memoize", { enumerable: true, get: function () { return platformos_check_common_1.memoize; } });
+Object.defineProperty(exports, "parseJSON", { enumerable: true, get: function () { return platformos_check_common_1.parseJSON; } });
+__exportStar(require("./debounce"), exports);
+__exportStar(require("./array"), exports);
+__exportStar(require("./node"), exports);
+__exportStar(require("./isCovered"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+EAO6C;AAH3C,+GAAA,IAAI,OAAA;AACJ,kHAAA,OAAO,OAAA;AACP,oHAAA,SAAS,OAAA;AAEX,6CAA2B;AAC3B,0CAAwB;AACxB,yCAAuB;AACvB,8CAA4B"}

package/dist/utils/isCovered.d.ts

@@ -0,0 +1,4 @@
+export declare function isCovered(offset: number, range: {
+    start: number;
+    end: number;
+}): boolean;

package/dist/utils/isCovered.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCovered = isCovered;
+function isCovered(offset, range) {
+    return range.start <= offset && offset <= range.end;
+}
+//# sourceMappingURL=isCovered.js.map

package/dist/utils/isCovered.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCovered.js","sourceRoot":"","sources":["../../src/utils/isCovered.ts"],"names":[],"mappings":";;AAAA,8BAEC;AAFD,SAAgB,SAAS,CAAC,MAAc,EAAE,KAAqC;IAC7E,OAAO,KAAK,CAAC,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC;AACtD,CAAC"}

package/dist/utils/liquidDoc.d.ts

@@ -0,0 +1,22 @@
+import { DocDefinition, LiquidDocParameter } from '@platformos/platformos-check-common';
+export declare function formatLiquidDocParameter({ name, type, description, required }: LiquidDocParameter, heading?: boolean): string;
+export declare function formatLiquidDocTagHandle(label: string, description: string, example: string): string;
+export declare const SUPPORTED_LIQUID_DOC_TAG_HANDLES: {
+    param: {
+        description: string;
+        example: string;
+        template: string;
+    };
+    example: {
+        description: string;
+        example: string;
+        template: string;
+    };
+    description: {
+        description: string;
+        example: string;
+        template: string;
+    };
+};
+export declare function getParameterCompletionTemplate(name: string, type: string | null): string;
+export declare function formatLiquidDocContentMarkdown(name: string, docDefinition?: DocDefinition): string;

package/dist/utils/liquidDoc.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUPPORTED_LIQUID_DOC_TAG_HANDLES = void 0;
+exports.formatLiquidDocParameter = formatLiquidDocParameter;
+exports.formatLiquidDocTagHandle = formatLiquidDocTagHandle;
+exports.getParameterCompletionTemplate = getParameterCompletionTemplate;
+exports.formatLiquidDocContentMarkdown = formatLiquidDocContentMarkdown;
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+function formatLiquidDocParameter({ name, type, description, required }, heading = false) {
+    const nameStr = required ? `\`${name}\`` : `\`${name}\` (Optional)`;
+    const typeStr = type ? `: ${type}` : '';
+    if (heading) {
+        const descStr = description ? `\n\n${description}` : '';
+        return `### ${nameStr}${typeStr}${descStr}`;
+    }
+    const descStr = description ? ` - ${description}` : '';
+    return `- ${nameStr}${typeStr}${descStr}`;
+}
+function formatLiquidDocTagHandle(label, description, example) {
+    return `### @${label}\n\n${description}\n\n` + `**Example**\n\n\`\`\`liquid\n${example}\n\`\`\``;
+}
+exports.SUPPORTED_LIQUID_DOC_TAG_HANDLES = {
+    [platformos_check_common_1.SupportedDocTagTypes.Param]: {
+        description: 'Provides information about a parameter for the snippet.\n' +
+            `- The type of parameter is optional and can be ${Object.values(platformos_check_common_1.BasicParamTypes)
+                .map((type) => `\`${type}\``)
+                .join(', ')}\n` +
+            ` or liquid object that isn't exclusively a global object in our [API Docs](https://shopify.dev/docs/api/liquid/objects)\n` +
+            '- An optional parameter is denoted by square brackets around the parameter name\n' +
+            '- The description is optional Markdown text',
+        example: '{% doc %}\n' +
+            "  @param {string} name - The person's name\n" +
+            "  @param {number} [fav_num] - The person's favorite number\n" +
+            "  @param {product} prod - The person's chosen product\n" +
+            '{% enddoc %}\n',
+        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',
+        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',
+        template: `description $0`,
+    },
+};
+function getParameterCompletionTemplate(name, type) {
+    const paramDefaultValue = (0, platformos_check_common_1.getDefaultValueForType)(type);
+    const valueTemplate = paramDefaultValue === "''" ? `'$1'$0` : `\${1:${paramDefaultValue}}$0`;
+    return `${name}: ${valueTemplate}`;
+}
+function formatLiquidDocContentMarkdown(name, docDefinition) {
+    const liquidDoc = docDefinition?.liquidDoc;
+    if (!liquidDoc) {
+        return `### ${name}`;
+    }
+    const parts = [`### ${name}`];
+    if (liquidDoc.description) {
+        const description = liquidDoc.description.content;
+        parts.push('', '**Description:**', '\n', description);
+    }
+    if (liquidDoc.parameters?.length) {
+        const parameters = liquidDoc.parameters
+            .map((param) => formatLiquidDocParameter(param))
+            .join('\n');
+        parts.push('', '**Parameters:**', parameters);
+    }
+    if (liquidDoc.examples?.length) {
+        const examples = liquidDoc.examples
+            ?.map(({ content }) => `\`\`\`liquid\n${content}\n\`\`\``)
+            .join('\n');
+        parts.push('', '**Examples:**', examples);
+    }
+    return parts.join('\n');
+}
+//# sourceMappingURL=liquidDoc.js.map

package/dist/utils/liquidDoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquidDoc.js","sourceRoot":"","sources":["../../src/utils/liquidDoc.ts"],"names":[],"mappings":";;;AAQA,4DAcC;AAED,4DAEC;AAkCD,wEAMC;AAED,wEAiCC;AArGD,iFAM6C;AAE7C,SAAgB,wBAAwB,CACtC,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAsB,EACzD,UAAmB,KAAK;IAExB,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,eAAe,CAAC;IACpE,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAExC,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,OAAO,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,OAAO,OAAO,OAAO,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC;IAC9C,CAAC;IAED,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,OAAO,KAAK,OAAO,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC;AAC5C,CAAC;AAED,SAAgB,wBAAwB,CAAC,KAAa,EAAE,WAAmB,EAAE,OAAe;IAC1F,OAAO,QAAQ,KAAK,OAAO,WAAW,MAAM,GAAG,gCAAgC,OAAO,UAAU,CAAC;AACnG,CAAC;AAEY,QAAA,gCAAgC,GAAG;IAC9C,CAAC,8CAAoB,CAAC,KAAK,CAAC,EAAE;QAC5B,WAAW,EACT,2DAA2D;YAC3D,kDAAkD,MAAM,CAAC,MAAM,CAAC,yCAAe,CAAC;iBAC7E,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC;iBAC5B,IAAI,CAAC,IAAI,CAAC,IAAI;YACjB,2HAA2H;YAC3H,mFAAmF;YACnF,6CAA6C;QAC/C,OAAO,EACL,aAAa;YACb,8CAA8C;YAC9C,8DAA8D;YAC9D,yDAAyD;YACzD,gBAAgB;QAClB,QAAQ,EAAE,iBAAiB;KAC5B;IACD,CAAC,8CAAoB,CAAC,OAAO,CAAC,EAAE;QAC9B,WAAW,EAAE,gDAAgD;QAC7D,OAAO,EACL,aAAa,GAAG,yDAAyD,GAAG,gBAAgB;QAC9F,QAAQ,EAAE,YAAY;KACvB;IACD,CAAC,8CAAoB,CAAC,WAAW,CAAC,EAAE;QAClC,WAAW,EAAE,gDAAgD;QAC7D,OAAO,EACL,aAAa,GAAG,wDAAwD,GAAG,gBAAgB;QAC7F,QAAQ,EAAE,gBAAgB;KAC3B;CACF,CAAC;AAEF,SAAgB,8BAA8B,CAAC,IAAY,EAAE,IAAmB;IAC9E,MAAM,iBAAiB,GAAG,IAAA,gDAAsB,EAAC,IAAI,CAAC,CAAC;IAEvD,MAAM,aAAa,GAAG,iBAAiB,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,iBAAiB,KAAK,CAAC;IAE7F,OAAO,GAAG,IAAI,KAAK,aAAa,EAAE,CAAC;AACrC,CAAC;AAED,SAAgB,8BAA8B,CAC5C,IAAY,EACZ,aAA6B;IAE7B,MAAM,SAAS,GAAG,aAAa,EAAE,SAAS,CAAC;IAE3C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,OAAO,IAAI,EAAE,CAAC;IACvB,CAAC;IAED,MAAM,KAAK,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAE9B,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU;aACpC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;aAC/C,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,iBAAiB,EAAE,UAAU,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ;YACjC,EAAE,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,iBAAiB,OAAO,UAAU,CAAC;aACzD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/utils/node.d.ts

@@ -0,0 +1,24 @@
+import { AttrEmpty, LiquidHtmlNode, NamedTags, NodeTypes, TextNode } from '@platformos/liquid-html-parser';
+import { LiquidHtmlNodeOfType as NodeOfType } from '@platformos/platformos-check-common';
+export type HtmlElementTypes = (typeof HtmlElementTypes)[number];
+export declare const HtmlElementTypes: readonly [NodeTypes.HtmlElement, NodeTypes.HtmlDanglingMarkerClose, NodeTypes.HtmlSelfClosingElement, NodeTypes.HtmlVoidElement, NodeTypes.HtmlRawNode];
+export type NamedHtmlElementNode = NodeOfType<HtmlElementTypes>;
+export type HtmlAttributeTypes = (typeof HtmlAttributeTypes)[number];
+export type HtmlAttribute = NodeOfType<HtmlAttributeTypes>;
+export declare const HtmlAttributeTypes: readonly [NodeTypes.AttrUnquoted, NodeTypes.AttrDoubleQuoted, NodeTypes.AttrSingleQuoted, NodeTypes.AttrEmpty];
+export declare function isTextNode(node: LiquidHtmlNode): node is TextNode;
+export declare function isAttrEmpty(node: LiquidHtmlNode): node is AttrEmpty;
+export declare function isNamedHtmlElementNode(node: LiquidHtmlNode): node is NamedHtmlElementNode;
+export declare function getCompoundName(node: NamedHtmlElementNode | HtmlAttribute): string;
+export declare function isHtmlAttribute(node: LiquidHtmlNode): node is HtmlAttribute;
+type ExcludeStringMarkup<T> = T extends {
+    markup: string;
+} ? never : T;
+export declare function isNamedLiquidTag<NT extends LiquidHtmlNode, T extends NamedTags>(node: LiquidHtmlNode, name: T): node is ExcludeStringMarkup<Extract<NT, {
+    type: NodeTypes.LiquidTag;
+    name: T;
+}>>;
+export declare function isLiquidVariableOutput<NT extends LiquidHtmlNode>(node: LiquidHtmlNode): node is ExcludeStringMarkup<Extract<NT, {
+    type: NodeTypes.LiquidVariableOutput;
+}>>;
+export {};

package/dist/utils/node.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtmlAttributeTypes = exports.HtmlElementTypes = void 0;
+exports.isTextNode = isTextNode;
+exports.isAttrEmpty = isAttrEmpty;
+exports.isNamedHtmlElementNode = isNamedHtmlElementNode;
+exports.getCompoundName = getCompoundName;
+exports.isHtmlAttribute = isHtmlAttribute;
+exports.isNamedLiquidTag = isNamedLiquidTag;
+exports.isLiquidVariableOutput = isLiquidVariableOutput;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+exports.HtmlElementTypes = [
+    liquid_html_parser_1.NodeTypes.HtmlElement,
+    liquid_html_parser_1.NodeTypes.HtmlDanglingMarkerClose,
+    liquid_html_parser_1.NodeTypes.HtmlSelfClosingElement,
+    liquid_html_parser_1.NodeTypes.HtmlVoidElement,
+    liquid_html_parser_1.NodeTypes.HtmlRawNode,
+];
+exports.HtmlAttributeTypes = [
+    liquid_html_parser_1.NodeTypes.AttrUnquoted,
+    liquid_html_parser_1.NodeTypes.AttrDoubleQuoted,
+    liquid_html_parser_1.NodeTypes.AttrSingleQuoted,
+    liquid_html_parser_1.NodeTypes.AttrEmpty,
+];
+function isTextNode(node) {
+    return node.type === liquid_html_parser_1.NodeTypes.TextNode;
+}
+function isAttrEmpty(node) {
+    return node.type === liquid_html_parser_1.NodeTypes.AttrEmpty;
+}
+function isNamedHtmlElementNode(node) {
+    return exports.HtmlElementTypes.includes(node.type);
+}
+function getCompoundName(node) {
+    if (typeof node.name === 'string')
+        return node.name;
+    const names = node.name;
+    if (names.length === 0 || names.length > 1 || !isTextNode(names[0])) {
+        return 'unknown';
+    }
+    return names[0].value;
+}
+function isHtmlAttribute(node) {
+    return exports.HtmlAttributeTypes.some((type) => node.type === type);
+}
+function isNamedLiquidTag(node, name) {
+    return node.type === liquid_html_parser_1.NodeTypes.LiquidTag && node.name === name && typeof node.markup !== 'string';
+}
+function isLiquidVariableOutput(node) {
+    return node.type === liquid_html_parser_1.NodeTypes.LiquidVariableOutput && typeof node.markup !== 'string';
+}
+//# sourceMappingURL=node.js.map

package/dist/utils/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../../src/utils/node.ts"],"names":[],"mappings":";;;AA4BA,gCAEC;AAED,kCAEC;AAED,wDAEC;AAED,0CASC;AAED,0CAEC;AAID,4CAKC;AAED,wDAIC;AApED,uEAMwC;AAI3B,QAAA,gBAAgB,GAAG;IAC9B,8BAAS,CAAC,WAAW;IACrB,8BAAS,CAAC,uBAAuB;IACjC,8BAAS,CAAC,sBAAsB;IAChC,8BAAS,CAAC,eAAe;IACzB,8BAAS,CAAC,WAAW;CACb,CAAC;AAKE,QAAA,kBAAkB,GAAG;IAChC,8BAAS,CAAC,YAAY;IACtB,8BAAS,CAAC,gBAAgB;IAC1B,8BAAS,CAAC,gBAAgB;IAC1B,8BAAS,CAAC,SAAS;CACX,CAAC;AAEX,SAAgB,UAAU,CAAC,IAAoB;IAC7C,OAAO,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,QAAQ,CAAC;AAC1C,CAAC;AAED,SAAgB,WAAW,CAAC,IAAoB;IAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,SAAS,CAAC;AAC3C,CAAC;AAED,SAAgB,sBAAsB,CAAC,IAAoB;IACzD,OAAQ,wBAAyC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxE,CAAC;AAED,SAAgB,eAAe,CAAC,IAA0C;IACxE,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,IAAI,CAAC;IAEpD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;IACxB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACxB,CAAC;AAED,SAAgB,eAAe,CAAC,IAAoB;IAClD,OAAO,0BAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAC/D,CAAC;AAID,SAAgB,gBAAgB,CAC9B,IAAoB,EACpB,IAAO;IAEP,OAAO,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC;AACpG,CAAC;AAED,SAAgB,sBAAsB,CACpC,IAAoB;IAEpB,OAAO,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,oBAAoB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC;AACzF,CAAC"}

package/dist/utils/uri.d.ts

@@ -0,0 +1,12 @@
+export declare const partialName: (uri: string) => string;
+export declare const isPartial: (uri: string) => boolean;
+export declare const assetName: (uri: string) => string;
+export declare const isAsset: (uri: string) => boolean;
+export declare const blockName: (uri: string) => string;
+export declare const isBlock: (uri: string) => boolean;
+export declare const sectionName: (uri: string) => string;
+export declare const isSection: (uri: string) => boolean;
+export declare const sectionGroupName: (uri: string) => string;
+export declare const isSectionGroup: (uri: string) => boolean;
+export declare const templateName: (uri: string) => string;
+export declare const isTemplate: (uri: string) => boolean;