@platformos/platformos-check-node 0.0.6 → 0.0.7

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

@@ -1,13 +1,8 @@
 "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 = __importDefault(require("glob"));
-const node_util_1 = require("node:util");
-const asyncGlob = (0, node_util_1.promisify)(glob_1.default);
+const glob_1 = require("glob");
 function loadThirdPartyChecks(
 /**
  * An array of require()-able paths.
@@ -47,7 +42,7 @@ async function findThirdPartyChecks(nodeModuleRoot) {
         globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/theme-check-*/'),
         globJoin(nodeModuleRoot.replace(/\\/g, '/'), '/node_modules/@*/theme-check-*/'),
     ];
-    const results = await Promise.all(paths.map((path) => asyncGlob(path)));
+    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) &&

package/dist/index.js

@@ -30,15 +30,13 @@ const platformos_check_docs_updater_1 = require("@platformos/platformos-check-do
 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 glob_1 = require("glob");
 const autofix_1 = require("./autofix");
 const config_1 = require("./config");
 const NodeFileSystem_1 = require("./NodeFileSystem");
 Object.defineProperty(exports, "NodeFileSystem", { enumerable: true, get: function () { return NodeFileSystem_1.NodeFileSystem; } });
 const node_url_1 = require("node:url");
-const asyncGlob = (0, node_util_1.promisify)(glob);
 __exportStar(require("@platformos/platformos-check-common"), exports);
 __exportStar(require("./config/types"), exports);
 var backfill_docs_1 = require("./backfill-docs");
@@ -146,7 +144,7 @@ async function getTheme(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 = getThemeFilesPathPattern(config.rootUri);
-    const paths = await asyncGlob(normalizedGlob, { absolute: true }).then((result) => 
+    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)));
     const sourceCodes = await Promise.all(paths.map(toSourceCode));

package/dist/test/test-helpers.js

@@ -1,37 +1,4 @@
 "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;
-    };
-})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -42,7 +9,6 @@ exports.removeTmpFolder = removeTmpFolder;
 exports.createMockConfigFile = createMockConfigFile;
 exports.createMockNodeModule = createMockNodeModule;
 exports.makeTempWorkspace = makeTempWorkspace;
-const mktemp = __importStar(require("mktemp"));
 const promises_1 = __importDefault(require("node:fs/promises"));
 const node_os_1 = __importDefault(require("node:os"));
 const node_path_1 = __importDefault(require("node:path"));
@@ -91,7 +57,7 @@ async function createMockNodeModule(tempDir, moduleName, moduleContent = exports
     return nodeModuleRoot;
 }
 async function makeTempWorkspace(structure) {
-    const root = await mktemp.createDir(node_path_1.default.join(__dirname, '..', '.XXXXX'));
+    const root = await promises_1.default.mkdtemp(node_path_1.default.join(__dirname, '..', '.'));
     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.6",
+  "version": "0.0.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "platformOS",
@@ -33,13 +33,11 @@
     "type-check": "tsc --noEmit"
   },
   "dependencies": {
-    "@platformos/platformos-check-common": "0.0.6",
-    "@platformos/platformos-check-docs-updater": "0.0.6",
-    "glob": "^8.0.3",
-    "vscode-uri": "^3.0.7",
-    "yaml": "^2.3.0"
+    "@platformos/platformos-check-common": "0.0.7",
+    "@platformos/platformos-check-docs-updater": "0.0.7",
+    "glob": "^13.0.0",
+    "vscode-uri": "^3.1.0",
+    "yaml": "^2.8.2"
   },
-  "devDependencies": {
-    "@types/glob": "^8.0.0"
-  }
+  "devDependencies": {}
 }

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