@platformos/platformos-check-node 0.0.7 → 0.0.9

package/configs/all.yml

@@ -3,91 +3,33 @@
 # 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:
+DuplicateFunctionArguments:
   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
@@ -100,39 +42,16 @@ MetadataParamsCheck:
 MissingAsset:
   enabled: true
   severity: 0
-MissingContentForArguments:
-  enabled: true
-  severity: 1
-MissingTemplate:
+MissingPartial:
   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
@@ -145,21 +64,12 @@ UndefinedObject:
 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
@@ -169,15 +79,6 @@ UnusedAssign:
 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
@@ -187,27 +88,9 @@ ValidHTMLTranslation:
 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

package/configs/recommended.yml

@@ -3,69 +3,33 @@
 # 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:
+DuplicateFunctionArguments:
   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
@@ -78,39 +42,16 @@ MetadataParamsCheck:
 MissingAsset:
   enabled: true
   severity: 0
-MissingContentForArguments:
-  enabled: true
-  severity: 1
-MissingTemplate:
+MissingPartial:
   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
@@ -123,21 +64,12 @@ UndefinedObject:
 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
@@ -147,15 +79,6 @@ UnusedAssign:
 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
@@ -165,27 +88,9 @@ ValidHTMLTranslation:
 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

package/dist/autofix.d.ts

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

package/dist/autofix.js

@@ -10,7 +10,7 @@ const saveToDiskFixApplicator = async (sourceCode, fix) => {
 };
 exports.saveToDiskFixApplicator = saveToDiskFixApplicator;
 /**
- * Apply and save to disk the safe fixes for a set of offenses on a theme.
+ * Apply and save to disk the safe fixes for a set of offenses on an app.
  */
 async function autofix(sourceCodes, offenses) {
     await (0, platformos_check_common_1.autofix)(sourceCodes, offenses, exports.saveToDiskFixApplicator);

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

@@ -1,6 +1,6 @@
-import { Theme } from '@platformos/platformos-check-common';
+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.
  */
-export declare function collectPartialUsages(theme: Theme, verbose?: boolean, log?: (message: string) => void): Promise<Map<string, PartialUsage>>;
+export declare function collectPartialUsages(theme: App, verbose?: boolean, log?: (message: string) => void): Promise<Map<string, PartialUsage>>;

package/dist/backfill-docs/index.js

@@ -55,11 +55,10 @@ async function backfillDocs(options, log = console.log) {
         errors: [],
     };
     log('Scanning for partial usages (function, render, include)...');
-    // Load theme configuration
     const config = await (0, index_1.loadConfig)(undefined, rootPath);
-    const theme = await (0, index_1.getTheme)(config);
-    // Collect all partial usages from the theme
-    const usageMap = await (0, argument_collector_1.collectPartialUsages)(theme, verbose, log);
+    const app = await (0, index_1.getApp)(config);
+    // Collect all partial usages from the app
+    const usageMap = await (0, argument_collector_1.collectPartialUsages)(app, verbose, log);
     const totalCalls = Array.from(usageMap.values()).reduce((sum, usage) => sum + Array.from(usage.arguments.values()).reduce((s, a) => s + a.usageCount, 0), 0);
     log(`Found ${totalCalls} partial calls referencing ${usageMap.size} partials\n`);
     if (usageMap.size === 0) {
@@ -210,7 +209,7 @@ async function runBackfillDocsCLI(args) {
 }
 function printHelp() {
     console.log(`
-Usage: theme-check backfill-docs [path] [options]
+Usage: platformos-check backfill-docs [path] [options]
 
 Scans a platformOS project for partial usages (function, render, include tags)
 and backfills or updates {% doc %} tags in the corresponding partial files.
@@ -225,9 +224,9 @@ Options:
   --help, -h        Show this help message
 
 Examples:
-  theme-check backfill-docs
-  theme-check backfill-docs ./my-project --dry-run
-  theme-check backfill-docs --verbose --required
+  platformos-check backfill-docs
+  platformos-check backfill-docs ./my-project --dry-run
+  platformos-check backfill-docs --verbose --required
 `);
 }
 //# sourceMappingURL=index.js.map

package/dist/cli.js

@@ -6,23 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("./index");
 const backfill_docs_1 = require("./backfill-docs");
 const node_path_1 = __importDefault(require("node:path"));
-async function runThemeCheck(args) {
+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 { theme, config, offenses } = await (0, index_1.themeCheckRun)(root, configPath, console.error.bind(console));
+    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(theme.map((x) => x.uri), null, 2));
+    console.log(JSON.stringify(app.map((x) => x.uri), null, 2));
 }
 function printUsage() {
     console.log(`
-Usage: theme-check [command] [options]
+Usage: platformos-check [command] [options]
 
 Commands:
-  <path>              Run theme 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
 
-Run 'theme-check <command> --help' for more information on a command.
+Run 'platformos-check <command> --help' for more information on a command.
 `);
 }
 async function main() {
@@ -40,8 +40,8 @@ async function main() {
         await (0, backfill_docs_1.runBackfillDocsCLI)(args.slice(1));
         return;
     }
-    // Default: run theme check
-    await runThemeCheck(args);
+    // Default: run platformos check
+    await runCheck(args);
 }
 main();
 //# sourceMappingURL=cli.js.map

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/load-config-description.js

@@ -33,7 +33,6 @@ async function loadConfigDescription(configDescription, root) {
     const rootUri = vscode_uri_1.URI.file(root);
     return {
         settings: unaliasedSettings(configDescription.checkSettings, checks),
-        context: configDescription.context ?? 'theme',
         checks,
         ignore: configDescription.ignore,
         rootUri: resolveRoot(rootUri, configDescription.root),

package/dist/config/load-third-party-checks.d.ts

@@ -6,7 +6,7 @@ export declare function loadThirdPartyChecks(
  * An array of require()-able paths.
  * @example
  * [
- *   '@acme/theme-check-extension',
+ *   '@acme/platformos-check-extension',
  *   '/absolute/path/to/checks.js',
  *   './lib/checks.js',
  * ]

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

@@ -8,7 +8,7 @@ function loadThirdPartyChecks(
  * An array of require()-able paths.
  * @example
  * [
- *   '@acme/theme-check-extension',
+ *   '@acme/platformos-check-extension',
  *   '/absolute/path/to/checks.js',
  *   './lib/checks.js',
  * ]
@@ -39,14 +39,14 @@ modulePaths = []) {
 }
 async function findThirdPartyChecks(nodeModuleRoot) {
     const paths = [
-        globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/theme-check-*/'),
-        globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/@*/theme-check-*/'),
+        globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/platformos-check-*/'),
+        globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/@*/platformos-check-*/'),
     ];
     const results = await Promise.all(paths.map((path) => (0, glob_1.glob)(path)));
     return results
         .flat()
-        .filter((x) => !/\@shopify\/theme-check-(node|common|browser|docs-updater)/.test(x) &&
-        !/theme-check-vscode/.test(x));
+        .filter((x) => !/\@platformos\/platformos-check-(node|common|browser|docs-updater)/.test(x) &&
+        !/platformos-check-vscode/.test(x));
 }
 function globJoin(...parts) {
     return parts.flatMap((x) => x.replace(/\\/g, '/').replace(/\/+$/, '')).join('/');

package/dist/config/resolve/merge-fragments.js

@@ -25,8 +25,6 @@ function mergeFragments(baseConfigs, config) {
             .map((b) => b.checkSettings)
             .concat(config.checkSettings)
             .reduce(mergeDeep),
-        // We use the last one defined, or default to 'theme'
-        context: selectLatest(baseConfigs.map((b) => b.context), config.context) ?? 'theme',
     };
 }
 function selectLatest(base, curr) {

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

@@ -81,12 +81,6 @@ isRootConfig = false) {
     else if (isRootConfig) {
         config.extends = [resolveExtends(root, 'platformos-check:recommended')];
     }
-    if (yamlFile.context) {
-        if (platformos_check_common_1.Modes.includes(yamlFile.context)) {
-            config.context = yamlFile.context;
-        }
-        delete yamlFile.context;
-    }
     // legacy settings that screw up assumptions
     if (yamlFile.include_categories)
         delete yamlFile.include_categories;
@@ -143,7 +137,7 @@ pathLike) {
     if (pathLike.startsWith('.')) {
         return node_path_1.default.resolve(root, pathLike);
     }
-    return (0, node_fs_1.realpathSync)(require.resolve(pathLike, { paths: getAncestorNodeModules(root) }));
+    return (0, node_fs_1.realpathSync)(require.resolve(/* webpackIgnore: true */ pathLike, { paths: getAncestorNodeModules(root) }));
 }
 /**
  * Resolves the check settings. Will also camelCase the snake_case settings

package/dist/config/types.d.ts

@@ -1,4 +1,4 @@
-import { ChecksSettings, Mode, Severity } from '@platformos/platformos-check-common';
+import { ChecksSettings, Severity } from '@platformos/platformos-check-common';
 /**
  * The pipeline goes like this:
  *
@@ -6,7 +6,7 @@ import { ChecksSettings, Mode, Severity } from '@platformos/platformos-check-com
  * -> ConfigFragment      # an intermediate representation of the file
  * -> ConfigFragment[]    # the file and its extends
  * -> ConfigDescription   # the flattened config (no extends)
- * -> Config              # the theme check config
+ * -> Config              # the platformos-check config
  *
  * Our goal is to support more than one config file format, so what we'll
  * do is have one adapter per file format that outputs a ConfigFragment.
@@ -20,12 +20,10 @@ export interface ConfigFragment {
     extends: string[];
     require: string[];
     checkSettings: ChecksSettings;
-    context?: Mode;
 }
 /** A ConfigDescription is a ConfigFragment that doesn't extend anything. */
-export type ConfigDescription = Omit<ConfigFragment, 'extends' | 'context'> & {
+export type ConfigDescription = Omit<ConfigFragment, 'extends'> & {
     extends: [];
-    context: Mode;
 };
 export declare const ModernIdentifiers: readonly ["platformos-check:nothing", "platformos-check:recommended", "platformos-check:all"];
 export type ModernIdentifier = (typeof ModernIdentifiers)[number];

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Config, GraphQLSourceCode, JSONSourceCode, LiquidSourceCode, Offense, Theme } from '@platformos/platformos-check-common';
+import { Config, GraphQLSourceCode, JSONSourceCode, LiquidSourceCode, Offense, App, YAMLSourceCode } from '@platformos/platformos-check-common';
 import { loadConfig as resolveConfig } from './config';
 import { NodeFileSystem } from './NodeFileSystem';
 export * from '@platformos/platformos-check-common';
@@ -6,18 +6,22 @@ export * from './config/types';
 export { NodeFileSystem };
 export { runBackfillDocsCLI } from './backfill-docs';
 export declare const loadConfig: typeof resolveConfig;
-export type ThemeCheckRun = {
-    theme: Theme;
+export type AppCheckRun = {
+    app: App;
     config: Config;
     offenses: Offense[];
 };
-export declare function toSourceCode(absolutePath: string): Promise<LiquidSourceCode | JSONSourceCode | GraphQLSourceCode | undefined>;
+export declare function toSourceCode(absolutePath: string): Promise<LiquidSourceCode | JSONSourceCode | GraphQLSourceCode | YAMLSourceCode | undefined>;
 export declare function check(root: string, configPath?: string): Promise<Offense[]>;
 export declare function checkAndAutofix(root: string, configPath?: string): Promise<void>;
-export declare function themeCheckRun(root: string, configPath?: string, log?: (message: string) => void): Promise<ThemeCheckRun>;
-export declare function getThemeAndConfig(root: string, configPath?: string): Promise<{
-    theme: Theme;
+export declare function appCheckRun(root: string, configPath?: string, log?: (message: string) => void): Promise<AppCheckRun>;
+export declare function getAppAndConfig(root: string, configPath?: string): Promise<{
+    app: App;
     config: Config;
 }>;
-export declare function getTheme(config: Config): Promise<Theme>;
-export declare function getThemeFilesPathPattern(rootUri: string): string;
+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,14 +17,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfig = exports.runBackfillDocsCLI = exports.NodeFileSystem = void 0;
+exports.themeCheckRun = exports.runCheck = exports.loadConfig = exports.runBackfillDocsCLI = exports.NodeFileSystem = void 0;
 exports.toSourceCode = toSourceCode;
 exports.check = check;
 exports.checkAndAutofix = checkAndAutofix;
-exports.themeCheckRun = themeCheckRun;
-exports.getThemeAndConfig = getThemeAndConfig;
-exports.getTheme = getTheme;
-exports.getThemeFilesPathPattern = getThemeFilesPathPattern;
+exports.appCheckRun = appCheckRun;
+exports.getAppAndConfig = getAppAndConfig;
+exports.getApp = getApp;
+exports.getAppFilesPathPattern = getAppFilesPathPattern;
 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");
@@ -56,50 +56,18 @@ async function toSourceCode(absolutePath) {
     }
 }
 async function check(root, configPath) {
-    const run = await themeCheckRun(root, configPath);
+    const run = await appCheckRun(root, configPath);
     return run.offenses;
 }
 async function checkAndAutofix(root, configPath) {
-    const { theme, offenses } = await themeCheckRun(root, configPath);
-    await (0, autofix_1.autofix)(theme, offenses);
+    const { app, offenses } = await appCheckRun(root, configPath);
+    await (0, autofix_1.autofix)(app, offenses);
 }
-async function themeCheckRun(root, configPath, log = () => { }) {
-    const { theme, config } = await getThemeAndConfig(root, configPath);
-    const themeLiquidDocsManager = new platformos_check_docs_updater_1.ThemeLiquidDocsManager(log);
-    // This does feel a bit heavy handed, but I'm in a rush.
-    //
-    // Ultimately, I want to be able to have type safety on the parsed content
-    // of the {% schema %} tags if the schema is known to be valid. This should make
-    // {% schema %} related theme checks much easier to write than having to write visitor
-    // code and doing null checks all over the place. `ThemeBlock.Schema` is much more specific
-    // than `any` ever could be.
-    //
-    // I also want to have the option of passing down the getSectionSchema &
-    // getBlockSchema functions as dependencies. This will enable me to cache the
-    // results in the language server and avoid redoing validation between runs if
-    // we know the schema of a file that didn't change is valid.
-    //
-    // The crux of my problem is that I want to be passing down the json validation set
-    // as dependencies and not a full blown language service. But the easiest way
-    // is to have a `isValidSchema` is to have the language service do the
-    // validation of the JSON schema... We're technically going to have two
-    // JSONValidator running in theme check (node). We already have two in the
-    // language server.
-    const validator = await platformos_check_common_1.JSONValidator.create(themeLiquidDocsManager, config);
-    const isValidSchema = validator?.isValid;
-    // We can assume that all files are loaded when running themeCheckRun
-    const schemas = theme.map((source) => (0, platformos_check_common_1.toSchema)(config.context, source.uri, source, isValidSchema));
-    // prettier-ignore
-    const blockSchemas = new Map(theme.filter(source => (0, platformos_check_common_1.isBlock)(source.uri)).map((source) => [
-        node_path_1.default.basename(source.uri, '.liquid'),
-        (0, platformos_check_common_1.memo)(async () => (0, platformos_check_common_1.toSchema)(config.context, source.uri, source, isValidSchema))
-    ]));
-    // prettier-ignore
-    const sectionSchemas = new Map(theme.filter(source => (0, platformos_check_common_1.isSection)(source.uri)).map((source) => [
-        node_path_1.default.basename(source.uri, '.liquid'),
-        (0, platformos_check_common_1.memo)(async () => (0, platformos_check_common_1.toSchema)(config.context, source.uri, source, isValidSchema))
-    ]));
-    const docDefinitions = new Map(theme.map((file) => [
+async function appCheckRun(root, configPath, log = () => { }) {
+    const { app, config } = await getAppAndConfig(root, configPath);
+    const platformOSLiquidDocsManager = new platformos_check_docs_updater_1.PlatformOSLiquidDocsManager(log);
+    const validator = await platformos_check_common_1.JSONValidator.create(platformOSLiquidDocsManager, config);
+    const docDefinitions = new Map(app.map((file) => [
         node_path_1.default.relative(vscode_uri_1.URI.file(root).toString(), file.uri),
         (0, platformos_check_common_1.memo)(async () => {
             const ast = file.ast;
@@ -112,47 +80,52 @@ async function themeCheckRun(root, configPath, log = () => { }) {
             return (0, platformos_check_common_1.extractDocDefinition)(file.uri, ast);
         }),
     ]));
-    const offenses = await (0, platformos_check_common_1.check)(theme, config, {
+    const offenses = await (0, platformos_check_common_1.check)(app, config, {
         fs: NodeFileSystem_1.NodeFileSystem,
-        themeDocset: themeLiquidDocsManager,
-        jsonValidationSet: themeLiquidDocsManager,
-        // This is kind of gross, but we want those things to be lazy and called by name so...
-        // In the language server, this is memo'ed in DocumentManager, but we don't have that kind
-        // of luxury in CLI-mode.
-        getSectionSchema: async (name) => sectionSchemas.get(name)?.(),
-        getBlockSchema: async (name) => blockSchemas.get(name)?.(),
-        getAppBlockSchema: async (name) => blockSchemas.get(name)?.(), // cheating... but TODO
+        platformosDocset: platformOSLiquidDocsManager,
+        jsonValidationSet: platformOSLiquidDocsManager,
         getDocDefinition: async (relativePath) => docDefinitions.get(relativePath)?.(),
     });
     return {
-        theme,
+        app,
         config,
         offenses,
     };
 }
-async function getThemeAndConfig(root, configPath) {
+async function getAppAndConfig(root, configPath) {
     const config = await (0, exports.loadConfig)(configPath, root);
-    const theme = await getTheme(config);
+    const app = await getApp(config);
     return {
-        theme,
+        app,
         config,
     };
 }
-async function getTheme(config) {
+async function getApp(config) {
     // On windows machines - the separator provided by path.join is '\'
     // however the glob function fails silently since '\' is used to escape glob charater
     // 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 = getThemeFilesPathPattern(config.rootUri);
-    const paths = await (0, glob_1.glob)(normalizedGlob, { absolute: true }).then((result) => 
-    // Global ignored paths should not be part of the theme
-    result.filter((filePath) => !(0, platformos_check_common_1.isIgnored)(filePath, config)));
+    let normalizedGlob = getAppFilesPathPattern(config.rootUri);
+    const paths = await (0, glob_1.glob)(normalizedGlob, { absolute: true }).then((result) => result.filter((filePath) => {
+        // Global ignored paths should not be part of the app
+        if ((0, platformos_check_common_1.isIgnored)(filePath, config))
+            return false;
+        // Only lint .liquid files that belong to a recognized platformOS directory.
+        // Generator templates, build artifacts, etc. are excluded.
+        if (filePath.endsWith('.liquid') && !(0, platformos_check_common_1.isKnownLiquidFile)(filePath))
+            return false;
+        return true;
+    }));
     const sourceCodes = await Promise.all(paths.map(toSourceCode));
     return sourceCodes.filter((x) => x !== undefined);
 }
-function getThemeFilesPathPattern(rootUri) {
+function getAppFilesPathPattern(rootUri) {
     return node_path_1.default
-        .normalize(node_path_1.default.join((0, node_url_1.fileURLToPath)(rootUri), '**/*.{liquid,json,graphql}'))
+        .normalize(node_path_1.default.join((0, node_url_1.fileURLToPath)(rootUri), '**/*.{liquid,json,graphql,yml,yaml}'))
         .replace(/\\/g, '/');
 }
+/** @deprecated Use appCheckRun instead */
+exports.runCheck = appCheckRun;
+/** @deprecated Use appCheckRun instead */
+exports.themeCheckRun = appCheckRun;
 //# sourceMappingURL=index.js.map

package/dist/test/test-helpers.js

@@ -21,7 +21,7 @@ async function makeTmpFolder() {
 async function removeTmpFolder(tempDir) {
     return promises_1.default.rm(tempDir, { recursive: true, force: true });
 }
-async function createMockConfigFile(tempDir, contents = 'dummy content', relativePath = '.theme-check.yml') {
+async function createMockConfigFile(tempDir, contents = 'dummy content', relativePath = '.platformos-check.yml') {
     const filePath = node_path_1.default.join(tempDir, relativePath);
     await promises_1.default.writeFile(filePath, contents, 'utf8');
     return filePath;
@@ -57,7 +57,7 @@ async function createMockNodeModule(tempDir, moduleName, moduleContent = exports
     return nodeModuleRoot;
 }
 async function makeTempWorkspace(structure) {
-    const root = await promises_1.default.mkdtemp(node_path_1.default.join(__dirname, '..', '.'));
+    const root = await promises_1.default.mkdtemp(node_path_1.default.join(node_os_1.default.tmpdir(), 'platformos-check-'));
     if (!root)
         throw new Error('Could not create temp dir for temp workspace');
     await createFiles(structure, [root]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformos/platformos-check-node",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "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.7",
-    "@platformos/platformos-check-docs-updater": "0.0.7",
+    "@platformos/platformos-check-common": "0.0.9",
+    "@platformos/platformos-check-docs-updater": "0.0.9",
     "glob": "^13.0.0",
     "vscode-uri": "^3.1.0",
     "yaml": "^2.8.2"