feat: add req subcommands for managing requirements.txt (#5)
* feat: add req subcommands for managing requirements.txt * bump: version 2.1.9 * fix: address codex review comments (flag consistency, regex-based pkg parsing, error handling) --------- Co-authored-by: Luna <clawy@reversed.dev>
This commit is contained in:
@@ -53,6 +53,9 @@ this will check the health, and if not setup, it will prompt you to set up the C
|
|||||||
- `shsf remote pull --id <id> --into <path> [--force]`: Pull files from a function into a local directory.
|
- `shsf remote pull --id <id> --into <path> [--force]`: Pull files from a function into a local directory.
|
||||||
- `shsf remote push --id <id> --from <path> [--force]`: Push files from a local directory to a function.
|
- `shsf remote push --id <id> --from <path> [--force]`: Push files from a local directory to a function.
|
||||||
|
|
||||||
|
- `shsf req add <package> --id <functionid>`: Add a package to the requirements.txt of a function.
|
||||||
|
- `shsf req remove <package> --id <functionid>`: Remove a package from the requirements.txt of a function.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
Use these commands for when you need to interact with shsf from the command line. Its faster than using the ui for almost all ops.
|
Use these commands for when you need to interact with shsf from the command line. Its faster than using the ui for almost all ops.
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "shsf-cli",
|
"name": "shsf-cli",
|
||||||
"version": "2.1.8",
|
"version": "2.1.9",
|
||||||
"description": "",
|
"description": "",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"files": [
|
"files": [
|
||||||
|
|||||||
@@ -0,0 +1,99 @@
|
|||||||
|
import chalk from "chalk";
|
||||||
|
import { getApiClient } from "../../api.js";
|
||||||
|
|
||||||
|
interface ShsfFile {
|
||||||
|
name: string;
|
||||||
|
content: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const reqAddDefinition = {
|
||||||
|
name: "add <package>",
|
||||||
|
description: "Add a package to the requirements.txt of a function.",
|
||||||
|
options: [
|
||||||
|
{ name: "--to <id>", description: "The ID of the function (deprecated alias for --id)." },
|
||||||
|
{ name: "--id <id>", description: "The ID of the function.", required: true },
|
||||||
|
],
|
||||||
|
action: async (pkg: string, options: { to?: string; id?: string }) => {
|
||||||
|
const functionId = options.id ?? options.to;
|
||||||
|
if (!functionId) {
|
||||||
|
console.error(`${chalk.red("✗")} Error: Function ID is required. Use ${chalk.cyan("--id <id>")}.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const client = await getApiClient();
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 1. Get current files of the function
|
||||||
|
const response = await client.get(`/api/function/${functionId}/files`);
|
||||||
|
let files: ShsfFile[] = response.data.data;
|
||||||
|
if (!Array.isArray(files)) files = [];
|
||||||
|
|
||||||
|
let requirementsFile = files.find(f => f.name === "requirements.txt");
|
||||||
|
let content = requirementsFile ? requirementsFile.content : "";
|
||||||
|
|
||||||
|
// 2. Add the package
|
||||||
|
const lines = content.split("\n");
|
||||||
|
|
||||||
|
// Robust package name extraction
|
||||||
|
const getPkgName = (line: string) => {
|
||||||
|
const withoutComment = line.trim().split("#", 1)[0];
|
||||||
|
const basePart = withoutComment.split(";", 1)[0].trim();
|
||||||
|
if (!basePart) return null;
|
||||||
|
return basePart.split(/[!=>~<]/)[0].trim().toLowerCase();
|
||||||
|
};
|
||||||
|
|
||||||
|
const pkgToAddName = getPkgName(pkg);
|
||||||
|
if (!pkgToAddName) {
|
||||||
|
console.error(`${chalk.red("✗")} Invalid package format.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const exists = lines.some(line => {
|
||||||
|
const lineName = getPkgName(line);
|
||||||
|
return lineName === pkgToAddName;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (exists) {
|
||||||
|
console.log(`${chalk.yellow("!")} Package ${chalk.cyan(pkgToAddName)} is already in requirements.txt.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Preserve existing content structure
|
||||||
|
if (content && !content.endsWith("\n")) {
|
||||||
|
content += "\n";
|
||||||
|
}
|
||||||
|
content += pkg + "\n";
|
||||||
|
|
||||||
|
// 3. Get function details to find storageId
|
||||||
|
const funcResponse = await client.get(`/api/function/${functionId}`);
|
||||||
|
const func = funcResponse.data.data;
|
||||||
|
if (!func || !func.namespace || !func.namespace.storageId) {
|
||||||
|
throw new Error("Could not determine storage ID for function.");
|
||||||
|
}
|
||||||
|
const storageId = func.namespace.storageId;
|
||||||
|
|
||||||
|
// 4. Overwrite/Create requirements.txt
|
||||||
|
await client.put(`/api/storage/${storageId}/files`, {
|
||||||
|
path: "requirements.txt",
|
||||||
|
content: content
|
||||||
|
});
|
||||||
|
|
||||||
|
console.log(`${chalk.green("✓")} Added ${chalk.cyan(pkg)} to requirements.txt for function ${chalk.yellow(functionId)}.`);
|
||||||
|
} catch (error: any) {
|
||||||
|
handleError(error, "add package");
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
function handleError(error: any, task: string) {
|
||||||
|
if (error.response) {
|
||||||
|
console.error(`${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(error.response.data?.message || error.message)}`);
|
||||||
|
} else if (error.request) {
|
||||||
|
console.error(
|
||||||
|
`${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(
|
||||||
|
"No response received from server. Please check your network connection and try again."
|
||||||
|
)}`
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
console.error(`${chalk.red("✗")} Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
import chalk from "chalk";
|
||||||
|
import { getApiClient } from "../../api.js";
|
||||||
|
|
||||||
|
interface ShsfFile {
|
||||||
|
name: string;
|
||||||
|
content: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const reqRemoveDefinition = {
|
||||||
|
name: "remove <package>",
|
||||||
|
description: "Remove a package from the requirements.txt of a function.",
|
||||||
|
options: [
|
||||||
|
{ name: "--from <id>", description: "The ID of the function (deprecated alias for --id)." },
|
||||||
|
{ name: "--id <id>", description: "The ID of the function.", required: true },
|
||||||
|
],
|
||||||
|
action: async (pkgToRemove: string, options: { from?: string; id?: string }) => {
|
||||||
|
const functionId = options.id ?? options.from;
|
||||||
|
if (!functionId) {
|
||||||
|
console.error(`${chalk.red("✗")} Error: Function ID is required. Use ${chalk.cyan("--id <id>")}.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const client = await getApiClient();
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 1. Get current files of the function
|
||||||
|
const response = await client.get(`/api/function/${functionId}/files`);
|
||||||
|
let files: ShsfFile[] = response.data.data;
|
||||||
|
if (!Array.isArray(files)) files = [];
|
||||||
|
|
||||||
|
const requirementsFile = files.find(f => f.name === "requirements.txt");
|
||||||
|
if (!requirementsFile) {
|
||||||
|
console.log(`${chalk.yellow("!")} No requirements.txt found for function ${chalk.yellow(functionId)}.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const content = requirementsFile.content;
|
||||||
|
const lines = content.split("\n");
|
||||||
|
|
||||||
|
const targetPkgName = pkgToRemove.trim().toLowerCase();
|
||||||
|
let removed = false;
|
||||||
|
|
||||||
|
const newLines = lines.filter(line => {
|
||||||
|
const trimmedLine = line.trim();
|
||||||
|
// Preserve empty/whitespace-only lines
|
||||||
|
if (!trimmedLine) return true;
|
||||||
|
|
||||||
|
// Strip inline comments and environment markers for matching purposes
|
||||||
|
const withoutComment = trimmedLine.split("#", 1)[0];
|
||||||
|
const basePart = withoutComment.split(";", 1)[0].trim();
|
||||||
|
|
||||||
|
// If there's no actual requirement (e.g., comment-only line), keep the line
|
||||||
|
if (!basePart) return true;
|
||||||
|
|
||||||
|
// Robust extraction (handles != <= >= ~= == and < >)
|
||||||
|
const currentPkgName = basePart.split(/[!=>~<]/)[0].trim().toLowerCase();
|
||||||
|
|
||||||
|
if (currentPkgName === targetPkgName) {
|
||||||
|
removed = true;
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!removed) {
|
||||||
|
console.log(`${chalk.yellow("!")} Package ${chalk.cyan(pkgToRemove)} was not found in requirements.txt.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const newContent = newLines.join("\n");
|
||||||
|
|
||||||
|
// 2. Get function details to find storageId
|
||||||
|
const funcResponse = await client.get(`/api/function/${functionId}`);
|
||||||
|
const func = funcResponse.data.data;
|
||||||
|
if (!func || !func.namespace || !func.namespace.storageId) {
|
||||||
|
throw new Error("Could not determine storage ID for function.");
|
||||||
|
}
|
||||||
|
const storageId = func.namespace.storageId;
|
||||||
|
|
||||||
|
// 3. Overwrite requirements.txt
|
||||||
|
await client.put(`/api/storage/${storageId}/files`, {
|
||||||
|
path: "requirements.txt",
|
||||||
|
content: newContent
|
||||||
|
});
|
||||||
|
|
||||||
|
console.log(`${chalk.green("✓")} Removed ${chalk.cyan(pkgToRemove)} from requirements.txt for function ${chalk.yellow(functionId)}.`);
|
||||||
|
} catch (error: any) {
|
||||||
|
handleError(error, "remove package");
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
function handleError(error: any, task: string) {
|
||||||
|
if (error.response) {
|
||||||
|
console.error(`${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(error.response.data?.message || error.message)}`);
|
||||||
|
} else if (error.request) {
|
||||||
|
console.error(
|
||||||
|
`${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(
|
||||||
|
"No response received from server. Please check your network connection and try again."
|
||||||
|
)}`
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
console.error(`${chalk.red("✗")} Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user