@platformos/platformos-check-node 0.0.9 → 0.0.11

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

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

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

@@ -10,8 +10,8 @@ const liquid_html_parser_2 = require("@platformos/liquid-html-parser");
  */
 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;
+        if (node.partial.type === liquid_html_parser_1.NodeTypes.String) {
+            return node.partial.value;
         }
         return undefined;
     }
@@ -63,11 +63,11 @@ function parseUsageKey(key) {
     };
 }
 /**
- * Collect all partial usages from a theme by visiting function, render, and include tags.
+ * Collect all partial usages from an app by visiting function, render, and include tags.
  */
-async function collectPartialUsages(theme, verbose = false, log = console.log) {
+async function collectPartialUsages(app, verbose = false, log = console.log) {
     const usageMap = new Map();
-    for (const sourceCode of theme) {
+    for (const sourceCode of app) {
         if (sourceCode.type !== platformos_check_common_1.SourceCodeType.LiquidHtml)
             continue;
         if (!(0, liquid_html_parser_2.isLiquidHtmlNode)(sourceCode.ast))

package/dist/config/load-third-party-checks.js

@@ -1,8 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadThirdPartyChecks = loadThirdPartyChecks;
 exports.findThirdPartyChecks = findThirdPartyChecks;
 const glob_1 = require("glob");
+const normalize_path_1 = __importDefault(require("normalize-path"));
 function loadThirdPartyChecks(
 /**
  * An array of require()-able paths.
@@ -39,8 +43,8 @@ modulePaths = []) {
 }
 async function findThirdPartyChecks(nodeModuleRoot) {
     const paths = [
-        globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/platformos-check-*/'),
-        globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/@*/platformos-check-*/'),
+        globJoin((0, normalize_path_1.default)(nodeModuleRoot), '/node_modules/platformos-check-*/'),
+        globJoin((0, normalize_path_1.default)(nodeModuleRoot), '/node_modules/@*/platformos-check-*/'),
     ];
     const results = await Promise.all(paths.map((path) => (0, glob_1.glob)(path)));
     return results
@@ -49,7 +53,7 @@ async function findThirdPartyChecks(nodeModuleRoot) {
         !/platformos-check-vscode/.test(x));
 }
 function globJoin(...parts) {
-    return parts.flatMap((x) => x.replace(/\\/g, '/').replace(/\/+$/, '')).join('/');
+    return parts.flatMap((x) => (0, normalize_path_1.default)(x).replace(/\/+$/, '')).join('/');
 }
 function isObjLiteral(thing) {
     return thing !== null && typeof thing === 'object';

package/dist/index.d.ts

@@ -23,5 +23,3 @@ export declare function getApp(config: Config): Promise<App>;
 export declare function getAppFilesPathPattern(rootUri: string): string;
 /** @deprecated Use appCheckRun instead */
 export declare const runCheck: typeof appCheckRun;
-/** @deprecated Use appCheckRun instead */
-export declare const themeCheckRun: typeof appCheckRun;

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.themeCheckRun = exports.runCheck = exports.loadConfig = exports.runBackfillDocsCLI = exports.NodeFileSystem = void 0;
+exports.runCheck = exports.loadConfig = exports.runBackfillDocsCLI = exports.NodeFileSystem = void 0;
 exports.toSourceCode = toSourceCode;
 exports.check = check;
 exports.checkAndAutofix = checkAndAutofix;
@@ -32,6 +32,7 @@ const promises_1 = __importDefault(require("node:fs/promises"));
 const node_path_1 = __importDefault(require("node:path"));
 const vscode_uri_1 = require("vscode-uri");
 const glob_1 = require("glob");
+const normalize_path_1 = __importDefault(require("normalize-path"));
 const autofix_1 = require("./autofix");
 const config_1 = require("./config");
 const NodeFileSystem_1 = require("./NodeFileSystem");
@@ -106,7 +107,11 @@ async function getApp(config) {
     // as mentioned in the documentation of node-glob
     // the path is normalised and '\' are replaced with '/' and then passed to the glob function
     let normalizedGlob = getAppFilesPathPattern(config.rootUri);
-    const paths = await (0, glob_1.glob)(normalizedGlob, { absolute: true }).then((result) => result.filter((filePath) => {
+    const paths = await (0, glob_1.glob)(normalizedGlob, { absolute: true }).then((result) => result
+        // Normalize backslashes to forward slashes so that isKnownLiquidFile() and
+        // isIgnored() regex/minimatch patterns (which use forward slashes) work on Windows.
+        .map(normalize_path_1.default)
+        .filter((filePath) => {
         // Global ignored paths should not be part of the app
         if ((0, platformos_check_common_1.isIgnored)(filePath, config))
             return false;
@@ -120,12 +125,8 @@ async function getApp(config) {
     return sourceCodes.filter((x) => x !== undefined);
 }
 function getAppFilesPathPattern(rootUri) {
-    return node_path_1.default
-        .normalize(node_path_1.default.join((0, node_url_1.fileURLToPath)(rootUri), '**/*.{liquid,json,graphql,yml,yaml}'))
-        .replace(/\\/g, '/');
+    return (0, normalize_path_1.default)(node_path_1.default.join((0, node_url_1.fileURLToPath)(rootUri), '**/*.{liquid,json,graphql,yml,yaml}'));
 }
 /** @deprecated Use appCheckRun instead */
 exports.runCheck = appCheckRun;
-/** @deprecated Use appCheckRun instead */
-exports.themeCheckRun = appCheckRun;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformos/platformos-check-node",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "platformOS",
@@ -33,9 +33,10 @@
     "type-check": "tsc --noEmit"
   },
   "dependencies": {
-    "@platformos/platformos-check-common": "0.0.9",
-    "@platformos/platformos-check-docs-updater": "0.0.9",
+    "@platformos/platformos-check-common": "0.0.11",
+    "@platformos/platformos-check-docs-updater": "0.0.11",
     "glob": "^13.0.0",
+    "normalize-path": "^3.0.0",
     "vscode-uri": "^3.1.0",
     "yaml": "^2.8.2"
   },

package/dist/commands/generate-docs.d.ts

@@ -1,24 +0,0 @@
-export interface GenerateDocsOptions {
-    dryRun?: boolean;
-    output?: 'inline' | 'stdout' | 'json';
-}
-export interface GenerateDocsResult {
-    uri: string;
-    relativePath: string;
-    parameters: Array<{
-        name: string;
-        type: string | null;
-        isOptional: boolean;
-    }>;
-    docBlockText: string;
-    hasExistingDocBlock: boolean;
-    updated: boolean;
-}
-/**
- * Generate doc blocks for all partials and blocks in a theme.
- */
-export declare function generateDocsCommand(root: string, options?: GenerateDocsOptions): Promise<GenerateDocsResult[]>;
-/**
- * Generate doc block for a single file.
- */
-export declare function generateDocForFile(absolutePath: string, options?: GenerateDocsOptions): Promise<GenerateDocsResult | null>;

package/dist/commands/generate-docs.js

@@ -1,136 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDocsCommand = generateDocsCommand;
-exports.generateDocForFile = generateDocForFile;
-const platformos_check_common_1 = require("@platformos/platformos-check-common");
-const platformos_check_docs_updater_1 = require("@platformos/platformos-check-docs-updater");
-const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
-const promises_1 = __importDefault(require("node:fs/promises"));
-const node_path_1 = __importDefault(require("node:path"));
-const node_util_1 = require("node:util");
-const vscode_uri_1 = require("vscode-uri");
-const glob = require("glob");
-const asyncGlob = (0, node_util_1.promisify)(glob);
-/**
- * Generate doc blocks for all partials and blocks in a theme.
- */
-async function generateDocsCommand(root, options = {}) {
-    const { dryRun = false, output = 'inline' } = options;
-    const rootUri = platformos_check_common_1.path.normalize(vscode_uri_1.URI.file(root));
-    const themeLiquidDocsManager = new platformos_check_docs_updater_1.ThemeLiquidDocsManager(console.error.bind(console));
-    // Find all liquid files that support doc blocks (partials and blocks)
-    const partialsGlob = node_path_1.default
-        .normalize(node_path_1.default.join(root, 'app/views/partials/**/*.liquid'))
-        .replace(/\\/g, '/');
-    const blocksGlob = node_path_1.default
-        .normalize(node_path_1.default.join(root, 'blocks/**/*.liquid'))
-        .replace(/\\/g, '/');
-    const [partialPaths, blockPaths] = await Promise.all([
-        asyncGlob(partialsGlob, { absolute: true }),
-        asyncGlob(blocksGlob, { absolute: true }),
-    ]);
-    const allPaths = [...partialPaths, ...blockPaths];
-    const results = [];
-    for (const absolutePath of allPaths) {
-        const uri = platformos_check_common_1.path.normalize(vscode_uri_1.URI.file(absolutePath));
-        // Double-check this file supports doc blocks
-        if (!(0, platformos_check_common_1.filePathSupportsLiquidDoc)(uri))
-            continue;
-        // Read and parse the file
-        const source = await promises_1.default.readFile(absolutePath, 'utf8');
-        const sourceCode = (0, platformos_check_common_1.toSourceCode)(uri, source);
-        if (!sourceCode || sourceCode.type !== platformos_check_common_1.SourceCodeType.LiquidHtml)
-            continue;
-        const ast = sourceCode.ast;
-        if (!(0, liquid_html_parser_1.isLiquidHtmlNode)(ast))
-            continue;
-        // Generate doc block
-        const docResult = await (0, platformos_check_common_1.generateDocBlock)(ast, uri, themeLiquidDocsManager);
-        const relativePath = node_path_1.default.relative(root, absolutePath);
-        const result = {
-            uri,
-            relativePath,
-            parameters: docResult.parameters,
-            docBlockText: docResult.docBlockText,
-            hasExistingDocBlock: docResult.hasExistingDocBlock,
-            updated: false,
-        };
-        // Skip files that already have doc blocks
-        if (docResult.hasExistingDocBlock) {
-            results.push(result);
-            continue;
-        }
-        // Skip files with no detected parameters
-        if (docResult.parameters.length === 0) {
-            results.push(result);
-            continue;
-        }
-        // If not dry run and output is inline, write the doc block to the file
-        if (!dryRun && output === 'inline') {
-            const newSource = docResult.docBlockText + '\n\n' + source;
-            await promises_1.default.writeFile(absolutePath, newSource, 'utf8');
-            result.updated = true;
-        }
-        results.push(result);
-    }
-    // Output based on mode
-    if (output === 'stdout') {
-        for (const result of results) {
-            if (result.hasExistingDocBlock) {
-                console.log(`[SKIP] ${result.relativePath} - already has doc block`);
-            }
-            else if (result.parameters.length === 0) {
-                console.log(`[SKIP] ${result.relativePath} - no parameters detected`);
-            }
-            else if (dryRun) {
-                console.log(`[DRY-RUN] ${result.relativePath}`);
-                console.log(result.docBlockText);
-                console.log('');
-            }
-            else {
-                console.log(`[UPDATED] ${result.relativePath}`);
-            }
-        }
-    }
-    else if (output === 'json') {
-        console.log(JSON.stringify(results, null, 2));
-    }
-    return results;
-}
-/**
- * Generate doc block for a single file.
- */
-async function generateDocForFile(absolutePath, options = {}) {
-    const { dryRun = false } = options;
-    const uri = platformos_check_common_1.path.normalize(vscode_uri_1.URI.file(absolutePath));
-    if (!(0, platformos_check_common_1.filePathSupportsLiquidDoc)(uri)) {
-        return null;
-    }
-    const themeLiquidDocsManager = new platformos_check_docs_updater_1.ThemeLiquidDocsManager(console.error.bind(console));
-    const source = await promises_1.default.readFile(absolutePath, 'utf8');
-    const sourceCode = (0, platformos_check_common_1.toSourceCode)(uri, source);
-    if (!sourceCode || sourceCode.type !== platformos_check_common_1.SourceCodeType.LiquidHtml)
-        return null;
-    const ast = sourceCode.ast;
-    if (!(0, liquid_html_parser_1.isLiquidHtmlNode)(ast))
-        return null;
-    const docResult = await (0, platformos_check_common_1.generateDocBlock)(ast, uri, themeLiquidDocsManager);
-    const result = {
-        uri,
-        relativePath: absolutePath,
-        parameters: docResult.parameters,
-        docBlockText: docResult.docBlockText,
-        hasExistingDocBlock: docResult.hasExistingDocBlock,
-        updated: false,
-    };
-    if (!docResult.hasExistingDocBlock && docResult.parameters.length > 0 && !dryRun) {
-        const newSource = docResult.docBlockText + '\n\n' + source;
-        await promises_1.default.writeFile(absolutePath, newSource, 'utf8');
-        result.updated = true;
-    }
-    return result;
-}
-//# sourceMappingURL=generate-docs.js.map

package/dist/commands/index.d.ts

@@ -1 +0,0 @@
-export { generateDocsCommand, generateDocForFile, GenerateDocsOptions, GenerateDocsResult, } from './generate-docs';

package/dist/commands/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDocForFile = exports.generateDocsCommand = void 0;
-var generate_docs_1 = require("./generate-docs");
-Object.defineProperty(exports, "generateDocsCommand", { enumerable: true, get: function () { return generate_docs_1.generateDocsCommand; } });
-Object.defineProperty(exports, "generateDocForFile", { enumerable: true, get: function () { return generate_docs_1.generateDocForFile; } });
-//# sourceMappingURL=index.js.map