mirror of
https://github.com/AikidoSec/safe-chain.git
synced 2026-05-26 12:10:49 +00:00
Fix more documentation issues
This commit is contained in:
parent
2accf954ca
commit
f7e08bbea8
3 changed files with 2 additions and 13 deletions
|
|
@ -21,6 +21,7 @@ const ecosystemSettings = {
|
||||||
ecoSystem: ECOSYSTEM_JS,
|
ecoSystem: ECOSYSTEM_JS,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** @returns {string} - The current ecosystem setting (ECOSYSTEM_JS or ECOSYSTEM_PY) */
|
||||||
export function getEcoSystem() {
|
export function getEcoSystem() {
|
||||||
return ecosystemSettings.ecoSystem;
|
return ecosystemSettings.ecoSystem;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -19,11 +19,9 @@ import { hasDryRunArg } from "../utils/pipCommands.js";
|
||||||
* @property {(args: string[]) => boolean} shouldScan
|
* @property {(args: string[]) => boolean} shouldScan
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {{ ignoreDryRun?: boolean }} [options]
|
|
||||||
*/
|
|
||||||
/**
|
/**
|
||||||
* @param {ScannerOptions} [options]
|
* @param {ScannerOptions} [options]
|
||||||
|
*
|
||||||
* @returns {CommandArgumentScanner}
|
* @returns {CommandArgumentScanner}
|
||||||
*/
|
*/
|
||||||
export function commandArgumentScanner(options = {}) {
|
export function commandArgumentScanner(options = {}) {
|
||||||
|
|
@ -36,9 +34,6 @@ export function commandArgumentScanner(options = {}) {
|
||||||
return shouldScanDependencies(args, ignoreDryRun);
|
return shouldScanDependencies(args, ignoreDryRun);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string[]} args
|
|
||||||
*/
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
* @returns {Promise<ScanResult[]> | ScanResult[]}
|
* @returns {Promise<ScanResult[]> | ScanResult[]}
|
||||||
|
|
@ -61,9 +56,6 @@ function shouldScanDependencies(args, ignoreDryRun) {
|
||||||
return ignoreDryRun || !hasDryRunArg(args);
|
return ignoreDryRun || !hasDryRunArg(args);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string[]} args
|
|
||||||
*/
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
* @returns {Promise<ScanResult[]> | ScanResult[]}
|
* @returns {Promise<ScanResult[]> | ScanResult[]}
|
||||||
|
|
@ -72,9 +64,6 @@ function scanDependencies(args) {
|
||||||
return checkChangesFromArgs(args);
|
return checkChangesFromArgs(args);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string[]} args
|
|
||||||
*/
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
* @returns {Promise<ScanResult[]> | ScanResult[]}
|
* @returns {Promise<ScanResult[]> | ScanResult[]}
|
||||||
|
|
|
||||||
|
|
@ -72,7 +72,6 @@ export function parsePackagesFromInstallArgs(args) {
|
||||||
function isPipOptionWithParameter(arg) {
|
function isPipOptionWithParameter(arg) {
|
||||||
|
|
||||||
// Check if a pip flag takes a parameter
|
// Check if a pip flag takes a parameter
|
||||||
// TODO it would be better to query pip itself for this info
|
|
||||||
const optionsWithParameters = [
|
const optionsWithParameters = [
|
||||||
// Install options
|
// Install options
|
||||||
"-r",
|
"-r",
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue