@squidcloud/cli 1.0.339 → 1.0.341

package/dist/index.js

@@ -981,13 +981,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports["default"] = default_1;
-const shell_runner_1 = __webpack_require__(5699);
 const fs = __importStar(__webpack_require__(1943));
 const process_utils_1 = __webpack_require__(8251);
 const resolve_1 = __webpack_require__(412);
 const path_1 = __importDefault(__webpack_require__(6928));
 const validate_1 = __webpack_require__(2246);
 const logging_1 = __webpack_require__(443);
+const shell_runner_1 = __webpack_require__(3089);
 async function default_1() {
     const packageJson = await (0, validate_1.validateSquidProject)();
     console.log((0, logging_1.primary)('Please note:'), 'to debug your application, you need to run the "start" npm script in your IDE in debug mode');
@@ -2363,7 +2363,7 @@ const fs = __importStar(__webpack_require__(9896));
 const fsPromises = __importStar(__webpack_require__(1943));
 const path = __importStar(__webpack_require__(6928));
 const resolve_1 = __webpack_require__(412);
-const shell_runner_1 = __webpack_require__(3344);
+const shell_runner_1 = __webpack_require__(3089);
 class TsoaUtils {
     constructor() { }
     static async generateAllSpecs(verbose = false, supportsDefault = true) {
@@ -2447,7 +2447,7 @@ class TsoaUtils {
                 console.log(`Running: ${routesCmd}`);
             }
             try {
-                await Promise.all([(0, shell_runner_1.runInShell)(specCmd, process.cwd()), (0, shell_runner_1.runInShell)(routesCmd, process.cwd())]);
+                await Promise.all([(0, shell_runner_1.runInShell)(specCmd, true, process.cwd()), (0, shell_runner_1.runInShell)(routesCmd, true, process.cwd())]);
             }
             catch (e) {
                 const errorMessage = e?.stderr || e;
@@ -2470,9 +2470,10 @@ class TsoaUtils {
             const routesOutput = path.join(outputDir, 'routes.ts');
             try {
                 const swaggerContent = await fsPromises.readFile(swaggerOutput, { encoding: 'utf8' });
+                const modifiedSwaggerContent = await TsoaUtils.attachCodeSamples(swaggerContent);
                 const routesContent = await fsPromises.readFile(routesOutput, { encoding: 'utf8' });
                 specsMap[specName] = {
-                    openApiSpecStr: swaggerContent,
+                    openApiSpecStr: modifiedSwaggerContent,
                     openApiControllersStr: routesContent,
                 };
             }
@@ -2509,6 +2510,85 @@ class TsoaUtils {
             return namePart || 'default';
         }
     }
+    static async attachCodeSamples(swaggerContent) {
+        const parsedSpec = JSON.parse(swaggerContent);
+        const paths = parsedSpec.paths;
+        for (const route in paths) {
+            // renamed to avoid conflict with Node's "path" module
+            const methods = paths[route];
+            for (const method in methods) {
+                const operation = methods[method];
+                const originalDescription = operation['description'] || '';
+                // Split description into individual lines
+                const lines = originalDescription.split('\n');
+                // Find lines that contain the directive
+                const directiveLines = lines.filter(line => line.includes('--squidCodeSampleFile'));
+                // Remove the directive lines from the description
+                operation['description'] = lines
+                    .filter(line => !line.includes('--squidCodeSampleFile'))
+                    .join('\n')
+                    .trim();
+                // Prepare an array to hold the code samples
+                const codeSamples = [];
+                for (const line of directiveLines) {
+                    // Find the directive in the line and extract the remainder
+                    const index = line.indexOf('--squidCodeSampleFile');
+                    const directiveContent = line.slice(index + '--squidCodeSampleFile'.length).trim();
+                    // Expecting format: "<file-path>,<label>"
+                    const parts = directiveContent.split(',').map(item => item.trim());
+                    if (parts.length < 2) {
+                        console.warn(`Directive format invalid: ${line}`);
+                        continue;
+                    }
+                    const [codeSampleFilePath, codeSampleLabel] = parts;
+                    // Determine language based on file extension
+                    let lang = 'Text';
+                    if (codeSampleFilePath.endsWith('.ts')) {
+                        lang = 'TypeScript';
+                    }
+                    else if (codeSampleFilePath.endsWith('.js')) {
+                        lang = 'JavaScript';
+                    }
+                    else if (codeSampleFilePath.endsWith('.py')) {
+                        lang = 'Python';
+                    }
+                    // Construct the full file path
+                    const fullCodeSamplePath = path.join(process.cwd(), codeSampleFilePath);
+                    let codeSampleContent;
+                    try {
+                        codeSampleContent = await fsPromises.readFile(fullCodeSamplePath, { encoding: 'utf8' });
+                        // Remove lines with '@ignore' and also remove the line immediately after each ignore line
+                        const codeLines = codeSampleContent.split('\n');
+                        const filteredLines = [];
+                        for (let i = 0; i < codeLines.length; i++) {
+                            if (codeLines[i].trim().includes('@ignore')) {
+                                // Skip this line and the next line
+                                i++;
+                                continue;
+                            }
+                            filteredLines.push(codeLines[i]);
+                        }
+                        codeSampleContent = filteredLines.join('\n').trim();
+                    }
+                    catch (e) {
+                        console.error(`Error reading code sample file ${codeSampleFilePath}:`, e);
+                        throw e;
+                    }
+                    // Add the code sample to the array
+                    codeSamples.push({
+                        lang,
+                        label: codeSampleLabel,
+                        source: codeSampleContent,
+                    });
+                }
+                // Attach the x-codeSamples entry if any directives were found
+                if (codeSamples.length > 0) {
+                    operation['x-codeSamples'] = codeSamples;
+                }
+            }
+        }
+        return JSON.stringify(parsedSpec, null, 2);
+    }
 }
 exports.TsoaUtils = TsoaUtils;
 
@@ -5869,7 +5949,7 @@ async function validateSquidProject() {
         const packageJson = await promises_1.default.readFile('package.json', 'utf8');
         const parsedJson = JSON.parse(packageJson);
         const { scripts } = parsedJson;
-        if (!scripts?.['start-squid'] && !scripts?.['start'].startsWith('squid start')) {
+        if (!scripts?.['start-squid'] && !scripts?.['start'].includes('squid start')) {
             (0, process_utils_1.exitWithError)(exports.INVALID_PROJECT_ERROR);
         }
         return parsedJson;
@@ -8113,6 +8193,78 @@ async function reportLocalBackendInitialized(appId, apiKey, appRegion, verbose)
 }
 
 
+/***/ }),
+
+/***/ 3089:
+/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
+
+"use strict";
+
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.runInShell = runInShell;
+exports.printCombinedOutput = printCombinedOutput;
+const child_process_1 = __webpack_require__(5317);
+const process_1 = __importDefault(__webpack_require__(932));
+function runInShell(command, printMessages = true, cwd = process_1.default.cwd(), envVars) {
+    return new Promise((resolve, reject) => {
+        const execution = (0, child_process_1.spawn)(command, {
+            cwd,
+            shell: true,
+            stdio: 'pipe',
+            env: envVars ? { ...process_1.default.env, ...envVars } : undefined,
+        });
+        const combinedOutput = [];
+        execution.stdout.on('data', data => {
+            const str = data.toString();
+            combinedOutput.push({ level: 'info', message: str });
+            if (printMessages)
+                stdoutLog(str);
+        });
+        execution.stderr.on('data', data => {
+            const str = data.toString();
+            combinedOutput.push({ level: 'error', message: str });
+            if (printMessages)
+                stderrLog(str);
+        });
+        execution.on('error', error => {
+            reject(error);
+        });
+        execution.on('exit', code => {
+            if (code === 0) {
+                resolve({ combinedOutput });
+            }
+            else {
+                const errorMessage = `The command exited with code ${code}`;
+                if (printMessages) {
+                    printCombinedOutput(combinedOutput);
+                }
+                const processError = { errorMessage, combinedOutput };
+                reject(processError);
+            }
+        });
+    });
+}
+function printCombinedOutput(combinedOutput) {
+    for (const line of combinedOutput) {
+        if (line.level === 'error') {
+            stderrLog(line.message);
+        }
+        else {
+            stdoutLog(line.message);
+        }
+    }
+}
+function stdoutLog(message) {
+    process_1.default.stdout.write(message);
+}
+function stderrLog(message) {
+    process_1.default.stderr.write(message);
+}
+
+
 /***/ }),
 
 /***/ 3106:
@@ -8366,41 +8518,6 @@ module.exports = require("string_decoder");
 "use strict";
 module.exports = require("module");
 
-/***/ }),
-
-/***/ 3344:
-/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.runInShell = runInShell;
-const child_process_1 = __webpack_require__(5317);
-/** @internal */
-function runInShell(command, cwd = process.cwd()) {
-    return new Promise((resolve, reject) => {
-        const process = (0, child_process_1.spawn)(command, { cwd, shell: true, stdio: 'pipe' });
-        let stdout = '';
-        let stderr = '';
-        process.stdout.on('data', data => {
-            stdout += data.toString();
-        });
-        process.stderr.on('data', data => {
-            stderr += data.toString();
-        });
-        process.on('error', error => reject(error));
-        process.on('exit', code => {
-            if (code === 0) {
-                resolve({ stdout, stderr });
-            }
-            else {
-                reject({ err: new Error(`The command exited with code ${code}`), stdout, stderr });
-            }
-        });
-    });
-}
-
-
 /***/ }),
 
 /***/ 3367:
@@ -11757,12 +11874,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports["default"] = initSample;
 const promises_1 = __importDefault(__webpack_require__(1943));
-const shell_runner_1 = __webpack_require__(5699);
 const path_1 = __importDefault(__webpack_require__(6928));
 const report_utils_1 = __webpack_require__(3066);
 const process_utils_1 = __webpack_require__(8251);
 const git_utils_1 = __webpack_require__(954);
 const logging_1 = __webpack_require__(443);
+const shell_runner_1 = __webpack_require__(3089);
 const ORG = 'squid-cloud-samples';
 async function initSample(dirPath, appId, apiKey, environmentId, squidDeveloperId, region, templateName, verbose = false) {
     try {
@@ -15722,69 +15839,6 @@ module.exports = () => input => {
 };
 
 
-/***/ }),
-
-/***/ 5699:
-/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.runInShell = runInShell;
-exports.printCombinedOutput = printCombinedOutput;
-const child_process_1 = __webpack_require__(5317);
-function runInShell(command, printMessages = true, cwd = process.cwd()) {
-    return new Promise((resolve, reject) => {
-        const process = (0, child_process_1.spawn)(command, { cwd, shell: true, stdio: 'pipe' });
-        const combinedOutput = [];
-        process.stdout.on('data', data => {
-            const str = data.toString();
-            combinedOutput.push({ level: 'info', message: str });
-            if (printMessages)
-                stdoutLog(str);
-        });
-        process.stderr.on('data', data => {
-            const str = data.toString();
-            combinedOutput.push({ level: 'error', message: str });
-            if (printMessages)
-                stderrLog(str);
-        });
-        process.on('error', error => {
-            reject(error);
-        });
-        process.on('exit', code => {
-            if (code === 0) {
-                resolve({ combinedOutput });
-            }
-            else {
-                const errorMessage = `The command exited with code ${code}`;
-                if (printMessages) {
-                    printCombinedOutput(combinedOutput);
-                }
-                const processError = { errorMessage, combinedOutput };
-                reject(processError);
-            }
-        });
-    });
-}
-function printCombinedOutput(combinedOutput) {
-    for (const line of combinedOutput) {
-        if (line.level === 'error') {
-            stderrLog(line.message);
-        }
-        else {
-            stdoutLog(line.message);
-        }
-    }
-}
-function stdoutLog(message) {
-    process.stdout.write(message);
-}
-function stderrLog(message) {
-    process.stderr.write(message);
-}
-
-
 /***/ }),
 
 /***/ 5704:
@@ -22712,7 +22766,7 @@ function exitWithError(...messages) {
 /***/ ((module) => {
 
 "use strict";
-module.exports = /*#__PURE__*/JSON.parse('{"name":"@squidcloud/cli","version":"1.0.339","description":"The Squid CLI","main":"dist/index.js","scripts":{"start":"node dist/index.js","start-ts":"ts-node -r tsconfig-paths/register src/index.ts","prebuild":"rimraf dist","build":"webpack --mode=production","build:dev":"webpack --mode=development","build:prod":"webpack --mode=production","lint":"eslint","link":"npm run build && chmod 755 dist/index.js && npm link","watch":"webpack --watch","deploy":"npm run build && npm pack --silent | xargs -I {} mv {} package.tgz && npm install -g package.tgz && rm -rf package.tgz","publish:public":"npm run build && npm publish --access public"},"files":["dist/**/*"],"bin":{"squid":"dist/index.js"},"keywords":[],"author":"","license":"ISC","engines":{"node":">=18.0.0"},"dependencies":{"@squidcloud/local-backend":"^1.0.339","copy-webpack-plugin":"^12.0.2","decompress":"^4.2.1","nodemon":"^3.1.3","terser-webpack-plugin":"^5.3.10","ts-loader":"^9.5.1","ts-node":"^10.9.2","tsconfig-paths":"^4.2.0","tsconfig-paths-webpack-plugin":"^4.1.0","webpack":"^5.96.0","zip-webpack-plugin":"^4.0.1"},"devDependencies":{"@types/decompress":"^4.2.7","@types/node":"^20.16.10","terminal-link":"^3.0.0"}}');
+module.exports = /*#__PURE__*/JSON.parse('{"name":"@squidcloud/cli","version":"1.0.341","description":"The Squid CLI","main":"dist/index.js","scripts":{"start":"node dist/index.js","start-ts":"ts-node -r tsconfig-paths/register src/index.ts","prebuild":"rimraf dist","build":"webpack --mode=production","build:dev":"webpack --mode=development","build:prod":"webpack --mode=production","lint":"eslint","link":"npm run build && chmod 755 dist/index.js && npm link","watch":"webpack --watch","deploy":"npm run build && npm pack --silent | xargs -I {} mv {} package.tgz && npm install -g package.tgz && rm -rf package.tgz","publish:public":"npm run build && npm publish --access public"},"files":["dist/**/*"],"bin":{"squid":"dist/index.js"},"keywords":[],"author":"","license":"ISC","engines":{"node":">=18.0.0"},"dependencies":{"@squidcloud/local-backend":"^1.0.341","copy-webpack-plugin":"^12.0.2","decompress":"^4.2.1","nodemon":"^3.1.3","terser-webpack-plugin":"^5.3.10","ts-loader":"^9.5.1","ts-node":"^10.9.2","tsconfig-paths":"^4.2.0","tsconfig-paths-webpack-plugin":"^4.1.0","webpack":"^5.96.0","zip-webpack-plugin":"^4.0.1"},"devDependencies":{"@types/decompress":"^4.2.7","@types/node":"^20.16.10","terminal-link":"^3.0.0"}}');
 
 /***/ }),
 
@@ -23566,12 +23620,12 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports["default"] = default_1;
 const environment_1 = __webpack_require__(722);
 const process_utils_1 = __webpack_require__(8251);
-const shell_runner_1 = __webpack_require__(5699);
 const fs = __importStar(__webpack_require__(1943));
 const http_1 = __webpack_require__(866);
 const communication_types_1 = __webpack_require__(3443);
 const console_app_utils_1 = __webpack_require__(7580);
 const assertic_1 = __webpack_require__(5036);
+const shell_runner_1 = __webpack_require__(3089);
 async function default_1(stage, appId, bundlePath, apiKey, verbose, direct, isUserSpecifiedPath, skipBuild, internalApiKey, environmentId) {
     if (!direct && !isUserSpecifiedPath && !skipBuild) {
         console.log('Building code bundle...');

package/dist/{cli → internal-common}/src/utils/shell-runner.d.ts

@@ -6,7 +6,7 @@ export interface ProcessError {
     errorMessage: string;
     combinedOutput: Array<ErrorLine>;
 }
-export declare function runInShell(command: string, printMessages?: boolean, cwd?: string): Promise<{
+export declare function runInShell(command: string, printMessages?: boolean, cwd?: string, envVars?: Record<string, string>): Promise<{
     combinedOutput: Array<ErrorLine>;
 }>;
 export declare function printCombinedOutput(combinedOutput: Array<ErrorLine>): void;

package/dist/internal-common/src/utils/tsoa-utils.d.ts

@@ -6,4 +6,5 @@ export declare class TsoaUtils {
     constructor();
     static generateAllSpecs(verbose?: boolean, supportsDefault?: boolean): Promise<OpenApiSpecAndControllers>;
     private static extractTsoaName;
+    private static attachCodeSamples;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/cli",
-  "version": "1.0.339",
+  "version": "1.0.341",
   "description": "The Squid CLI",
   "main": "dist/index.js",
   "scripts": {
@@ -29,7 +29,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@squidcloud/local-backend": "^1.0.339",
+    "@squidcloud/local-backend": "^1.0.341",
     "copy-webpack-plugin": "^12.0.2",
     "decompress": "^4.2.1",
     "nodemon": "^3.1.3",

package/dist/local-backend/src/utils/shell-runner.d.ts

@@ -1,5 +0,0 @@
-/** @internal */
-export declare function runInShell(command: string, cwd?: string): Promise<{
-    stdout: string;
-    stderr: string;
-}>;