@platformos/platformos-check-node 0.0.2

package/README.md

@@ -0,0 +1,9 @@
+# `@platformos/theme-check-node`
+
+This is the Node.js wrapper of the runtime-agnostic [`@platformos/theme-check-common`](https://npm.im/@platformos/theme-check-common) package. It comes with batteries included.
+
+See the [@platformos/theme-check-common README](../theme-check-common) for more details.
+
+## License
+
+MIT.

package/configs/all.yml

@@ -0,0 +1,214 @@
+# WARNING:
+# This file was generated automatically by running "scripts/generate-factory-configs"
+# Do not modify manually. Your changes will be overwritten.
+ignore:
+  - node_modules/**
+AppBlockMissingSchema:
+  enabled: false
+  severity: 0
+AppBlockValidTags:
+  enabled: false
+  severity: 0
+AssetPreload:
+  enabled: true
+  severity: 1
+AssetSizeAppBlockCSS:
+  enabled: false
+  severity: 0
+  thresholdInBytes: 100000
+AssetSizeAppBlockJavaScript:
+  enabled: false
+  severity: 0
+  thresholdInBytes: 10000
+AssetSizeCSS:
+  enabled: true
+  severity: 0
+  thresholdInBytes: 100000
+AssetSizeJavaScript:
+  enabled: true
+  severity: 0
+  thresholdInBytes: 10000
+BlockIdUsage:
+  enabled: true
+  severity: 1
+CdnPreconnect:
+  enabled: true
+  severity: 0
+ContentForHeaderModification:
+  enabled: true
+  severity: 0
+DeprecateBgsizes:
+  enabled: true
+  severity: 1
+DeprecateLazysizes:
+  enabled: true
+  severity: 1
+DeprecatedFilter:
+  enabled: true
+  severity: 1
+DeprecatedFontsOnSectionsAndBlocks:
+  enabled: true
+  severity: 1
+DeprecatedFontsOnSettingsSchema:
+  enabled: true
+  severity: 1
+DeprecatedTag:
+  enabled: true
+  severity: 1
+DuplicateContentForArguments:
+  enabled: true
+  severity: 1
+DuplicateRenderPartialArguments:
+  enabled: true
+  severity: 1
+EmptyBlockContent:
+  enabled: true
+  severity: 1
+GraphQLCheck:
+  enabled: true
+  severity: 0
+GraphQLVariablesCheck:
+  enabled: true
+  severity: 0
+HardcodedRoutes:
+  enabled: true
+  severity: 1
+ImgWidthAndHeight:
+  enabled: true
+  severity: 0
+InvalidHashAssignTarget:
+  enabled: true
+  severity: 0
+JSONMissingBlock:
+  enabled: true
+  severity: 0
+JSONSyntaxError:
+  enabled: true
+  severity: 0
+LiquidFreeSettings:
+  enabled: true
+  severity: 1
+LiquidHTMLSyntaxError:
+  enabled: true
+  severity: 0
+MatchingTranslations:
+  enabled: true
+  severity: 0
+MetadataParamsCheck:
+  enabled: true
+  severity: 0
+MissingAsset:
+  enabled: true
+  severity: 0
+MissingContentForArguments:
+  enabled: true
+  severity: 1
+MissingTemplate:
+  enabled: true
+  severity: 0
+  ignoreMissing: []
+OrphanedPartial:
+  enabled: true
+  severity: 1
+PaginationSize:
+  enabled: true
+  severity: 1
+  minSize: 1
+  maxSize: 250
+ParserBlockingScript:
+  enabled: true
+  severity: 0
+RemoteAsset:
+  enabled: true
+  severity: 1
+ReservedDocParamNames:
+  enabled: true
+  severity: 0
+SchemaPresetsBlockOrder:
+  enabled: true
+  severity: 1
+SchemaPresetsStaticBlocks:
+  enabled: true
+  severity: 0
+StaticStylesheetAndJavascriptTags:
+  enabled: true
+  severity: 0
+TranslationKeyExists:
+  enabled: true
+  severity: 0
+UnclosedHTMLElement:
+  enabled: true
+  severity: 1
+UndefinedObject:
+  enabled: true
+  severity: 1
+UniqueDocParamNames:
+  enabled: true
+  severity: 0
+UniqueSettingId:
+  enabled: true
+  severity: 0
+UniqueStaticBlockId:
+  enabled: true
+  severity: 0
+UnknownFilter:
+  enabled: true
+  severity: 0
+UnknownProperty:
+  enabled: true
+  severity: 0
+UnrecognizedContentForArguments:
+  enabled: true
+  severity: 1
+UnrecognizedRenderPartialArguments:
+  enabled: true
+  severity: 1
+UnusedAssign:
+  enabled: true
+  severity: 1
+UnusedDocParam:
+  enabled: true
+  severity: 1
+ValidBlockTarget:
+  enabled: true
+  severity: 0
+ValidContentForArgumentTypes:
+  enabled: true
+  severity: 1
+ValidContentForArguments:
+  enabled: true
+  severity: 0
+ValidDocParamTypes:
+  enabled: true
+  severity: 0
+ValidHTMLTranslation:
+  enabled: true
+  severity: 1
+ValidJSON:
+  enabled: true
+  severity: 0
+ValidLocalBlocks:
+  enabled: true
+  severity: 0
+ValidRenderPartialArgumentTypes:
+  enabled: true
+  severity: 1
+ValidSchema:
+  enabled: true
+  severity: 0
+ValidSchemaName:
+  enabled: true
+  severity: 0
+ValidSettingsKey:
+  enabled: true
+  severity: 0
+ValidStaticBlockType:
+  enabled: true
+  severity: 0
+ValidVisibleIf:
+  enabled: true
+  severity: 0
+VariableName:
+  enabled: true
+  severity: 1
+  format: snake_case

package/configs/nothing.yml

@@ -0,0 +1,3 @@
+extends: []
+ignore:
+  - node_modules/**

package/configs/recommended.yml

@@ -0,0 +1,192 @@
+# WARNING:
+# This file was generated automatically by running "scripts/generate-factory-configs"
+# Do not modify manually. Your changes will be overwritten.
+ignore:
+  - node_modules/**
+AssetPreload:
+  enabled: true
+  severity: 1
+BlockIdUsage:
+  enabled: true
+  severity: 1
+CdnPreconnect:
+  enabled: true
+  severity: 0
+ContentForHeaderModification:
+  enabled: true
+  severity: 0
+DeprecateBgsizes:
+  enabled: true
+  severity: 1
+DeprecateLazysizes:
+  enabled: true
+  severity: 1
+DeprecatedFilter:
+  enabled: true
+  severity: 1
+DeprecatedFontsOnSectionsAndBlocks:
+  enabled: true
+  severity: 1
+DeprecatedFontsOnSettingsSchema:
+  enabled: true
+  severity: 1
+DeprecatedTag:
+  enabled: true
+  severity: 1
+DuplicateContentForArguments:
+  enabled: true
+  severity: 1
+DuplicateRenderPartialArguments:
+  enabled: true
+  severity: 1
+EmptyBlockContent:
+  enabled: true
+  severity: 1
+GraphQLCheck:
+  enabled: true
+  severity: 0
+GraphQLVariablesCheck:
+  enabled: true
+  severity: 0
+HardcodedRoutes:
+  enabled: true
+  severity: 1
+ImgWidthAndHeight:
+  enabled: true
+  severity: 0
+InvalidHashAssignTarget:
+  enabled: true
+  severity: 0
+JSONMissingBlock:
+  enabled: true
+  severity: 0
+JSONSyntaxError:
+  enabled: true
+  severity: 0
+LiquidFreeSettings:
+  enabled: true
+  severity: 1
+LiquidHTMLSyntaxError:
+  enabled: true
+  severity: 0
+MatchingTranslations:
+  enabled: true
+  severity: 0
+MetadataParamsCheck:
+  enabled: true
+  severity: 0
+MissingAsset:
+  enabled: true
+  severity: 0
+MissingContentForArguments:
+  enabled: true
+  severity: 1
+MissingTemplate:
+  enabled: true
+  severity: 0
+  ignoreMissing: []
+OrphanedPartial:
+  enabled: true
+  severity: 1
+PaginationSize:
+  enabled: true
+  severity: 1
+  minSize: 1
+  maxSize: 250
+ParserBlockingScript:
+  enabled: true
+  severity: 0
+RemoteAsset:
+  enabled: true
+  severity: 1
+ReservedDocParamNames:
+  enabled: true
+  severity: 0
+SchemaPresetsBlockOrder:
+  enabled: true
+  severity: 1
+SchemaPresetsStaticBlocks:
+  enabled: true
+  severity: 0
+StaticStylesheetAndJavascriptTags:
+  enabled: true
+  severity: 0
+TranslationKeyExists:
+  enabled: true
+  severity: 0
+UnclosedHTMLElement:
+  enabled: true
+  severity: 1
+UndefinedObject:
+  enabled: true
+  severity: 1
+UniqueDocParamNames:
+  enabled: true
+  severity: 0
+UniqueSettingId:
+  enabled: true
+  severity: 0
+UniqueStaticBlockId:
+  enabled: true
+  severity: 0
+UnknownFilter:
+  enabled: true
+  severity: 0
+UnknownProperty:
+  enabled: true
+  severity: 0
+UnrecognizedContentForArguments:
+  enabled: true
+  severity: 1
+UnrecognizedRenderPartialArguments:
+  enabled: true
+  severity: 1
+UnusedAssign:
+  enabled: true
+  severity: 1
+UnusedDocParam:
+  enabled: true
+  severity: 1
+ValidBlockTarget:
+  enabled: true
+  severity: 0
+ValidContentForArgumentTypes:
+  enabled: true
+  severity: 1
+ValidContentForArguments:
+  enabled: true
+  severity: 0
+ValidDocParamTypes:
+  enabled: true
+  severity: 0
+ValidHTMLTranslation:
+  enabled: true
+  severity: 1
+ValidJSON:
+  enabled: true
+  severity: 0
+ValidLocalBlocks:
+  enabled: true
+  severity: 0
+ValidRenderPartialArgumentTypes:
+  enabled: true
+  severity: 1
+ValidSchema:
+  enabled: true
+  severity: 0
+ValidSchemaName:
+  enabled: true
+  severity: 0
+ValidSettingsKey:
+  enabled: true
+  severity: 0
+ValidStaticBlockType:
+  enabled: true
+  severity: 0
+ValidVisibleIf:
+  enabled: true
+  severity: 0
+VariableName:
+  enabled: true
+  severity: 1
+  format: snake_case

package/dist/NodeFileSystem.d.ts

@@ -0,0 +1,2 @@
+import { AbstractFileSystem } from '@platformos/platformos-common';
+export declare const NodeFileSystem: AbstractFileSystem;

package/dist/NodeFileSystem.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeFileSystem = void 0;
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+const platformos_common_1 = require("@platformos/platformos-common");
+const promises_1 = __importDefault(require("node:fs/promises"));
+exports.NodeFileSystem = {
+    async readFile(uri) {
+        // I'm intentionally leaving these comments here for debugging purposes :)
+        // console.error('fs/readFile', uri);
+        return promises_1.default.readFile(platformos_check_common_1.path.fsPath(uri), 'utf8');
+    },
+    async readDirectory(uri) {
+        // console.error('fs/readDirectory', uri);
+        const files = await promises_1.default.readdir(platformos_check_common_1.path.fsPath(uri), { withFileTypes: true });
+        return files.map((file) => {
+            return [platformos_check_common_1.path.join(uri, file.name), file.isDirectory() ? platformos_common_1.FileType.Directory : platformos_common_1.FileType.File];
+        });
+    },
+    async stat(uri) {
+        // console.error('fs/stat', uri);
+        try {
+            const stats = await promises_1.default.stat(platformos_check_common_1.path.fsPath(uri));
+            return {
+                type: stats.isDirectory() ? platformos_common_1.FileType.Directory : platformos_common_1.FileType.File,
+                size: stats.size,
+            };
+        }
+        catch (e) {
+            throw new Error(`Failed to get file stat: ${e}`);
+        }
+    },
+};
+//# sourceMappingURL=NodeFileSystem.js.map

package/dist/autofix.d.ts

@@ -0,0 +1,6 @@
+import { Offense, Theme, FixApplicator } from '@platformos/platformos-check-common';
+export declare const saveToDiskFixApplicator: FixApplicator;
+/**
+ * Apply and save to disk the safe fixes for a set of offenses on a theme.
+ */
+export declare function autofix(sourceCodes: Theme, offenses: Offense[]): Promise<void>;

package/dist/autofix.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveToDiskFixApplicator = void 0;
+exports.autofix = autofix;
+const promises_1 = require("fs/promises");
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+const saveToDiskFixApplicator = async (sourceCode, fix) => {
+    const updatedSource = (0, platformos_check_common_1.applyFixToString)(sourceCode.source, fix);
+    await (0, promises_1.writeFile)(platformos_check_common_1.path.fsPath(sourceCode.uri), updatedSource, 'utf8');
+};
+exports.saveToDiskFixApplicator = saveToDiskFixApplicator;
+/**
+ * Apply and save to disk the safe fixes for a set of offenses on a theme.
+ */
+async function autofix(sourceCodes, offenses) {
+    await (0, platformos_check_common_1.autofix)(sourceCodes, offenses, exports.saveToDiskFixApplicator);
+}
+//# sourceMappingURL=autofix.js.map

package/dist/backfill-docs/argument-collector.d.ts

@@ -0,0 +1,6 @@
+import { Theme } from '@platformos/platformos-check-common';
+import { PartialUsage } from './types';
+/**
+ * Collect all partial usages from a theme by visiting function, render, and include tags.
+ */
+export declare function collectPartialUsages(theme: Theme, verbose?: boolean, log?: (message: string) => void): Promise<Map<string, PartialUsage>>;

package/dist/backfill-docs/argument-collector.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.collectPartialUsages = collectPartialUsages;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+const liquid_html_parser_2 = require("@platformos/liquid-html-parser");
+/**
+ * Extract the partial name from a RenderMarkup or FunctionMarkup node.
+ * Returns undefined if the partial path is dynamic (VariableLookup).
+ */
+function getPartialName(node) {
+    if (node.type === liquid_html_parser_1.NodeTypes.RenderMarkup) {
+        if (node.snippet.type === liquid_html_parser_1.NodeTypes.String) {
+            return node.snippet.value;
+        }
+        return undefined;
+    }
+    if (node.type === liquid_html_parser_1.NodeTypes.FunctionMarkup) {
+        if (node.partial.type === liquid_html_parser_1.NodeTypes.String) {
+            return node.partial.value;
+        }
+        return undefined;
+    }
+    return undefined;
+}
+/**
+ * Merge a new argument into the existing usage map.
+ * When the same argument has different types across calls, use 'object'.
+ */
+function mergeArgument(existingArgs, arg) {
+    const inferredType = (0, platformos_check_common_1.inferArgumentType)(arg.value);
+    const existing = existingArgs.get(arg.name);
+    if (existing) {
+        existing.usageCount++;
+        // If types differ, use 'object' as the fallback
+        if (existing.inferredType !== inferredType) {
+            existing.inferredType = platformos_check_common_1.BasicParamTypes.Object;
+        }
+    }
+    else {
+        existingArgs.set(arg.name, {
+            name: arg.name,
+            inferredType,
+            usageCount: 1,
+        });
+    }
+}
+/**
+ * Create a unique key for a partial that includes its tag type.
+ * This is needed because 'function' and 'render' tags search different directories.
+ */
+function makeUsageKey(partialPath, tagType) {
+    return `${tagType}:${partialPath}`;
+}
+/**
+ * Parse a usage key back into its components.
+ */
+function parseUsageKey(key) {
+    const colonIndex = key.indexOf(':');
+    return {
+        tagType: key.slice(0, colonIndex),
+        partialPath: key.slice(colonIndex + 1),
+    };
+}
+/**
+ * Collect all partial usages from a theme by visiting function, render, and include tags.
+ */
+async function collectPartialUsages(theme, verbose = false, log = console.log) {
+    const usageMap = new Map();
+    for (const sourceCode of theme) {
+        if (sourceCode.type !== platformos_check_common_1.SourceCodeType.LiquidHtml)
+            continue;
+        if (!(0, liquid_html_parser_2.isLiquidHtmlNode)(sourceCode.ast))
+            continue;
+        const ast = sourceCode.ast;
+        await (0, platformos_check_common_1.visit)(ast, {
+            async LiquidTag(node) {
+                // Handle function tags
+                if (node.name === 'function' && node.markup && typeof node.markup === 'object') {
+                    const markup = node.markup;
+                    if (markup.type !== liquid_html_parser_1.NodeTypes.FunctionMarkup)
+                        return;
+                    const partialPath = getPartialName(markup);
+                    if (!partialPath) {
+                        if (verbose) {
+                            log(`  [skip] Dynamic function path in ${sourceCode.uri}`);
+                        }
+                        return;
+                    }
+                    const key = makeUsageKey(partialPath, 'function');
+                    let usage = usageMap.get(key);
+                    if (!usage) {
+                        usage = {
+                            partialPath,
+                            tagType: 'function',
+                            arguments: new Map(),
+                        };
+                        usageMap.set(key, usage);
+                    }
+                    for (const arg of markup.args) {
+                        if (arg.type === liquid_html_parser_1.NodeTypes.NamedArgument) {
+                            mergeArgument(usage.arguments, arg);
+                        }
+                    }
+                }
+                // Handle render tags
+                if (node.name === 'render' && node.markup && typeof node.markup === 'object') {
+                    const markup = node.markup;
+                    if (markup.type !== liquid_html_parser_1.NodeTypes.RenderMarkup)
+                        return;
+                    const partialPath = getPartialName(markup);
+                    if (!partialPath) {
+                        if (verbose) {
+                            log(`  [skip] Dynamic render path in ${sourceCode.uri}`);
+                        }
+                        return;
+                    }
+                    const key = makeUsageKey(partialPath, 'render');
+                    let usage = usageMap.get(key);
+                    if (!usage) {
+                        usage = {
+                            partialPath,
+                            tagType: 'render',
+                            arguments: new Map(),
+                        };
+                        usageMap.set(key, usage);
+                    }
+                    for (const arg of markup.args) {
+                        if (arg.type === liquid_html_parser_1.NodeTypes.NamedArgument) {
+                            mergeArgument(usage.arguments, arg);
+                        }
+                    }
+                }
+                // Handle include tags (same markup type as render)
+                if (node.name === 'include' && node.markup && typeof node.markup === 'object') {
+                    const markup = node.markup;
+                    if (markup.type !== liquid_html_parser_1.NodeTypes.RenderMarkup)
+                        return;
+                    const partialPath = getPartialName(markup);
+                    if (!partialPath) {
+                        if (verbose) {
+                            log(`  [skip] Dynamic include path in ${sourceCode.uri}`);
+                        }
+                        return;
+                    }
+                    const key = makeUsageKey(partialPath, 'include');
+                    let usage = usageMap.get(key);
+                    if (!usage) {
+                        usage = {
+                            partialPath,
+                            tagType: 'include',
+                            arguments: new Map(),
+                        };
+                        usageMap.set(key, usage);
+                    }
+                    for (const arg of markup.args) {
+                        if (arg.type === liquid_html_parser_1.NodeTypes.NamedArgument) {
+                            mergeArgument(usage.arguments, arg);
+                        }
+                    }
+                }
+            },
+        });
+    }
+    return usageMap;
+}
+//# sourceMappingURL=argument-collector.js.map

package/dist/backfill-docs/doc-generator.d.ts

@@ -0,0 +1,18 @@
+import { BasicParamTypes } from '@platformos/platformos-check-common';
+/**
+ * Generate a single @param line for a doc tag.
+ *
+ * @param name - The parameter name
+ * @param type - The inferred type
+ * @param isOptional - Whether to mark as optional with brackets
+ * @returns A formatted @param line like "@param {string} [name]" or "@param {string} name"
+ */
+export declare function generateParamLine(name: string, type: BasicParamTypes, isOptional?: boolean): string;
+/**
+ * Generate a complete doc tag with param lines.
+ *
+ * @param params - Array of param line strings (without leading whitespace)
+ * @param indentation - The indentation to use for each line (default: 2 spaces)
+ * @returns A complete doc tag string
+ */
+export declare function generateDocTag(params: string[], indentation?: string): string;