milliways-infosec/AikidoSec-safe-chain
7
0
Fork 0
mirror of https://github.com/AikidoSec/safe-chain.git synced 2026-05-26 12:10:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #63 from AikidoSec/bash-zsh-fish-always-use-linefeed-lineending

Browse source 
Always use \n line endings for bash, zsh and fish
This commit is contained in:
Sander Declerck 2025-09-18 10:23:47 +02:00 • committed by GitHub
commit b1a09b471c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 42 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

19
packages/safe-chain/src/shell-integration/helpers.js
View file

@ -22,15 +22,17 @@ export function doesExecutableExistOnSystem(executableName) {
}
}
export function removeLinesMatchingPattern(filePath, pattern) {
export function removeLinesMatchingPattern(filePath, pattern, eol) {
if (!fs.existsSync(filePath)) {
return;
}
eol = eol || os.EOL;
const fileContent = fs.readFileSync(filePath, "utf-8");
const lines = fileContent.split(/[\r\n\u2028\u2029]+/);
const updatedLines = lines.filter((line) => !shouldRemoveLine(line, pattern));
fs.writeFileSync(filePath, updatedLines.join(os.EOL), "utf-8");
fs.writeFileSync(filePath, updatedLines.join(eol), "utf-8");
}
const maxLineLength = 100;
@ -48,7 +50,12 @@ function shouldRemoveLine(line, pattern) {
return false;
}
if (line.includes("\n") || line.includes("\r") || line.includes("\u2028") || line.includes("\u2029")) {
if (
line.includes("\n") ||
line.includes("\r") ||
line.includes("\u2028") ||
line.includes("\u2029")
) {
// If the line contains newlines, something has gone wrong in splitting
// \u2028 and \u2029 are Unicode line separator characters (line and paragraph separators)
return false;
@ -57,12 +64,14 @@ function shouldRemoveLine(line, pattern) {
return true;
}
export function addLineToFile(filePath, line) {
export function addLineToFile(filePath, line, eol) {
if (!fs.existsSync(filePath)) {
fs.writeFileSync(filePath, "", "utf-8");
}
eol = eol || os.EOL;
const fileContent = fs.readFileSync(filePath, "utf-8");
const updatedContent = fileContent + os.EOL + line;
const updatedContent = fileContent + eol + line;
fs.writeFileSync(filePath, updatedContent, "utf-8");
}

13
packages/safe-chain/src/shell-integration/supported-shells/bash.js
View file

@ -9,6 +9,7 @@ import * as os from "os";
const shellName = "Bash";
const executableName = "bash";
const startupFileCommand = "echo ~/.bashrc";
const eol = "\n"; // When bash runs on Windows (e.g., Git Bash or WSL), it expects LF line endings.
function isInstalled() {
return doesExecutableExistOnSystem(executableName);
@ -19,13 +20,18 @@ function teardown(tools) {
for (const { tool } of tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`));
removeLinesMatchingPattern(
startupFile,
new RegExp(`^alias\\s+${tool}=`),
eol
);
}
// Removes the line that sources the safe-chain bash initialization script (~/.aikido/scripts/init-posix.sh)
removeLinesMatchingPattern(
startupFile,
/^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/
/^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/,
eol
);
return true;
@ -36,7 +42,8 @@ function setup() {
addLineToFile(
startupFile,
`source ~/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script`
`source ~/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script`,
eol
);
return true;

10
packages/safe-chain/src/shell-integration/supported-shells/fish.js
View file

@ -8,6 +8,7 @@ import { execSync } from "child_process";
const shellName = "Fish";
const executableName = "fish";
const startupFileCommand = "echo ~/.config/fish/config.fish";
const eol = "\n"; // When fish runs on Windows (e.g., Git Bash or WSL), it expects LF line endings.
function isInstalled() {
return doesExecutableExistOnSystem(executableName);
@ -20,14 +21,16 @@ function teardown(tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(
startupFile,
new RegExp(`^alias\\s+${tool}\\s+`)
new RegExp(`^alias\\s+${tool}\\s+`),
eol
);
}
// Removes the line that sources the safe-chain fish initialization script (~/.safe-chain/scripts/init-fish.fish)
removeLinesMatchingPattern(
startupFile,
/^source\s+~\/\.safe-chain\/scripts\/init-fish\.fish/
/^source\s+~\/\.safe-chain\/scripts\/init-fish\.fish/,
eol
);
return true;
@ -38,7 +41,8 @@ function setup() {
addLineToFile(
startupFile,
`source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script`
`source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script`,
eol
);
return true;

13
packages/safe-chain/src/shell-integration/supported-shells/zsh.js
View file

@ -8,6 +8,7 @@ import { execSync } from "child_process";
const shellName = "Zsh";
const executableName = "zsh";
const startupFileCommand = "echo ${ZDOTDIR:-$HOME}/.zshrc";
const eol = "\n"; // When zsh runs on Windows (e.g., Git Bash or WSL), it expects LF line endings.
function isInstalled() {
return doesExecutableExistOnSystem(executableName);
@ -18,13 +19,18 @@ function teardown(tools) {
for (const { tool } of tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`));
removeLinesMatchingPattern(
startupFile,
new RegExp(`^alias\\s+${tool}=`),
eol
);
}
// Removes the line that sources the safe-chain zsh initialization script (~/.aikido/scripts/init-posix.sh)
removeLinesMatchingPattern(
startupFile,
/^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/
/^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/,
eol
);
return true;
@ -35,7 +41,8 @@ function setup() {
addLineToFile(
startupFile,
`source ~/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script`
`source ~/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script`,
eol
);
return true;