@platformos/platformos-check-node 0.0.11 → 0.0.13

package/configs/all.yml

@@ -42,10 +42,19 @@ MetadataParamsCheck:
 MissingAsset:
   enabled: true
   severity: 0
+MissingPage:
+  enabled: true
+  severity: 1
 MissingPartial:
   enabled: true
   severity: 0
   ignoreMissing: []
+MissingRenderPartialArguments:
+  enabled: true
+  severity: 0
+NestedGraphQLQuery:
+  enabled: true
+  severity: 1
 OrphanedPartial:
   enabled: true
   severity: 1

package/configs/recommended.yml

@@ -42,10 +42,19 @@ MetadataParamsCheck:
 MissingAsset:
   enabled: true
   severity: 0
+MissingPage:
+  enabled: true
+  severity: 1
 MissingPartial:
   enabled: true
   severity: 0
   ignoreMissing: []
+MissingRenderPartialArguments:
+  enabled: true
+  severity: 0
+NestedGraphQLQuery:
+  enabled: true
+  severity: 1
 OrphanedPartial:
   enabled: true
   severity: 1

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

@@ -28,6 +28,8 @@ function getPartialName(node) {
  * When the same argument has different types across calls, use 'object'.
  */
 function mergeArgument(existingArgs, arg) {
+    if (arg.value.type === liquid_html_parser_1.NodeTypes.NamedArgument)
+        return;
     const inferredType = (0, platformos_check_common_1.inferArgumentType)(arg.value);
     const existing = existingArgs.get(arg.name);
     if (existing) {

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

@@ -1,4 +1,4 @@
-import { BasicParamTypes } from '@platformos/platformos-check-common';
+import { InferredParamType } from '@platformos/platformos-check-common';
 /**
  * Generate a single @param line for a doc tag.
  *
@@ -7,7 +7,7 @@ import { BasicParamTypes } from '@platformos/platformos-check-common';
  * @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;
+export declare function generateParamLine(name: string, type: InferredParamType, isOptional?: boolean): string;
 /**
  * Generate a complete doc tag with param lines.
  *

package/dist/backfill-docs/types.d.ts

@@ -1,8 +1,8 @@
-import { BasicParamTypes } from '@platformos/platformos-check-common';
+import { InferredParamType } from '@platformos/platformos-check-common';
 export type TagType = 'function' | 'render' | 'include';
 export interface ArgumentInfo {
     name: string;
-    inferredType: BasicParamTypes;
+    inferredType: InferredParamType;
     usageCount: number;
 }
 export interface PartialUsage {

package/dist/cli.js

@@ -4,24 +4,65 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("./index");
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
 const backfill_docs_1 = require("./backfill-docs");
 const node_path_1 = __importDefault(require("node:path"));
+const validCheckNames = new Set(platformos_check_common_1.allChecks.map((c) => c.meta.code));
+function parseCheckArgs(args) {
+    const checks = [];
+    const positional = [];
+    for (let i = 0; i < args.length; i++) {
+        if (args[i] === '--check' || args[i] === '-c') {
+            i++;
+            if (i < args.length)
+                checks.push(args[i]);
+        }
+        else {
+            positional.push(args[i]);
+        }
+    }
+    return {
+        root: node_path_1.default.resolve(positional[0] || '.'),
+        configPath: positional[1] ? node_path_1.default.resolve(positional[1]) : undefined,
+        checks: checks.length > 0 ? checks : undefined,
+    };
+}
 async function runCheck(args) {
-    const root = node_path_1.default.resolve(args[0] || '.');
-    const configPath = args[1] ? node_path_1.default.resolve(args[1]) : undefined;
+    const { root, configPath, checks } = parseCheckArgs(args);
+    if (checks) {
+        const unknown = checks.filter((name) => !validCheckNames.has(name));
+        if (unknown.length > 0) {
+            const available = Array.from(validCheckNames).sort().join(', ');
+            console.error(`Unknown check${unknown.length > 1 ? 's' : ''}: ${unknown.join(', ')}`);
+            console.error(`Available checks: ${available}`);
+            process.exit(1);
+        }
+    }
     const { app, config, offenses } = await (0, index_1.appCheckRun)(root, configPath, console.error.bind(console));
-    console.log(JSON.stringify(offenses, null, 2));
-    console.log(JSON.stringify(config, null, 2));
-    console.log(JSON.stringify(app.map((x) => x.uri), null, 2));
+    const filtered = checks ? offenses.filter((o) => checks.includes(o.check)) : offenses;
+    console.log(JSON.stringify(filtered, null, 2));
+    if (!checks) {
+        console.log(JSON.stringify(config, null, 2));
+        console.log(JSON.stringify(app.map((x) => x.uri), null, 2));
+    }
 }
 function printUsage() {
     console.log(`
-Usage: platformos-check [command] [options]
+Usage: platformos-check [command] [options] [path] [configPath]
 
 Commands:
-  <path>              Run platformos checks on the specified path (default)
+  <path>              Run platformos checks on the specified path (default: .)
   backfill-docs       Backfill doc tags in partial files based on usage
 
+Options:
+  --check, -c <name>  Only show offenses from the named check (repeatable)
+  --help, -h          Show this help message
+
+Examples:
+  platformos-check .
+  platformos-check . --check MissingPage
+  platformos-check . -c MissingPage -c UnknownFilter
+
 Run 'platformos-check <command> --help' for more information on a command.
 `);
 }

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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,136 @@
+"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

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

package/dist/commands/index.js

@@ -0,0 +1,7 @@
+"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

package/dist/config/resolve/read-yaml.js

@@ -115,6 +115,11 @@ pathLike) {
     if (pathLike.startsWith('platformos-check:')) {
         return pathLike;
     }
+    // Support legacy shorthand YAML-symbol style: ':nothing', ':recommended', ':all'
+    const expanded = `platformos-check${pathLike}`;
+    if (pathLike.startsWith(':') && types_1.ModernIdentifiers.includes(expanded)) {
+        return expanded;
+    }
     return resolvePath(root, pathLike);
 }
 /**

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from '@platformos/platformos-check-common';
 export * from './config/types';
 export { NodeFileSystem };
 export { runBackfillDocsCLI } from './backfill-docs';
+export declare function updateDocs(log?: (msg: string) => void): Promise<void>;
 export declare const loadConfig: typeof resolveConfig;
 export type AppCheckRun = {
     app: App;

package/dist/index.js

@@ -18,6 +18,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runCheck = exports.loadConfig = exports.runBackfillDocsCLI = exports.NodeFileSystem = void 0;
+exports.updateDocs = updateDocs;
 exports.toSourceCode = toSourceCode;
 exports.check = check;
 exports.checkAndAutofix = checkAndAutofix;
@@ -42,6 +43,9 @@ __exportStar(require("@platformos/platformos-check-common"), exports);
 __exportStar(require("./config/types"), exports);
 var backfill_docs_1 = require("./backfill-docs");
 Object.defineProperty(exports, "runBackfillDocsCLI", { enumerable: true, get: function () { return backfill_docs_1.runBackfillDocsCLI; } });
+async function updateDocs(log = () => { }) {
+    await (0, platformos_check_docs_updater_1.downloadPlatformOSLiquidDocs)(platformos_check_docs_updater_1.root, log);
+}
 const loadConfig = async (configPath, root) => {
     configPath ??= await (0, config_1.findConfigPath)(root);
     return (0, config_1.loadConfig)(configPath, root);
@@ -119,6 +123,10 @@ async function getApp(config) {
         // Generator templates, build artifacts, etc. are excluded.
         if (filePath.endsWith('.liquid') && !(0, platformos_check_common_1.isKnownLiquidFile)(filePath))
             return false;
+        // Only lint .graphql files that belong to a recognized platformOS GraphQL directory.
+        // Schema files, generator templates (e.g. ERB .graphql), etc. are excluded.
+        if (filePath.endsWith('.graphql') && !(0, platformos_check_common_1.isKnownGraphQLFile)(filePath))
+            return false;
         return true;
     }));
     const sourceCodes = await Promise.all(paths.map(toSourceCode));

package/package.json

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