Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(process): Workaround for arguments that contain whitespaces #129

Merged
merged 5 commits into from
Feb 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,9 @@ dist
# internal test
_test/

# emacs
emacs_backtrace.txt

# ignore generated files
*.elc

Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
* feat: Add capability to search through path (#119)
* Support DSL `package-descriptor` (#124)
* Resolve the potential symlink to the bash script (#24, #125, and #126)
* Workaround for arguments that contain whitespaces (#128 and #129)

## 0.7.x
> Released Sep 08, 2022
Expand Down
4 changes: 2 additions & 2 deletions cmds/core/emacs.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ exports.builder = async (yargs) => {
exports.handler = async (argv) => {
let _path = UTIL.el_script('core/emacs');

let default_cmd = ['-Q', '-l', _path];
let default_cmd = ['emacs', '-Q', '-l', _path];
let rest = process.argv.slice(3);
let cmd = default_cmd.concat(rest);

UTIL.setup_env();
let proc = child_process.spawn('emacs', cmd, { stdio: 'inherit' });
let proc = child_process.spawn(UTIL.cli_args(cmd), { stdio: 'inherit', shell: true });

proc.on('close', function (code) {
if (code == 0) return;
Expand Down
34 changes: 33 additions & 1 deletion cmds/core/eval.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@

"use strict";

const fs = require('fs');
const child_process = require("child_process");

exports.command = ['eval [form]'];
exports.desc = 'Evaluate lisp form with a proper PATH';
exports.builder = {
Expand All @@ -30,5 +33,34 @@ exports.builder = {
};

exports.handler = async (argv) => {
await UTIL.e_call(argv, 'core/eval', '\"' + argv.form.replace(/[\\$'"]/g, "\\$&") + '\"');
// setup environment, so Emacs can receive it
process.env.EASK_HOMEDIR = global.EASK_HOMEDIR;

await UTIL.e_call(argv, 'core/eval', argv.form);

if (!fs.existsSync(global.EASK_HOMEDIR)) {
return;
}

console.log('');

let epf = global.EASK_HOMEDIR + 'exec-path';
let lpf = global.EASK_HOMEDIR + 'load-path';

process.env.PATH = fs.readFileSync(epf, 'utf8');
process.env.EMACSLOADPATH = fs.readFileSync(lpf, 'utf8');;

let expressions = process.argv.slice(3);

// XXX: Just replace `form` property, this is combined expression
argv.form = expressions.join(' ');

let cmd = ['emacs', '--batch', '--eval', argv.form];

let proc = child_process.spawn(UTIL.cli_args(cmd), { stdio: 'inherit', shell: true });

proc.on('close', function (code) {
if (code == 0) return;
throw 'Exit with code: ' + code;
});
};
6 changes: 3 additions & 3 deletions cmds/core/exec.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ exports.handler = async (argv) => {
return;
}

console.log('');

let epf = global.EASK_HOMEDIR + 'exec-path';
let lpf = global.EASK_HOMEDIR + 'load-path';

process.env.PATH = fs.readFileSync(epf, 'utf8');
process.env.EMACSLOADPATH = fs.readFileSync(lpf, 'utf8');;

let program = cmd[0];
let rest = cmd.slice(1);
let proc = child_process.spawn(program, rest, { stdio: 'inherit', shell: true });
let proc = child_process.spawn(UTIL.cli_args(cmd), { stdio: 'inherit', shell: true });

proc.on('close', function (code) {
if (code == 0) return;
Expand Down
6 changes: 1 addition & 5 deletions cmds/core/run.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,7 @@ function startCommand(commands, count) {
let command = commands[count];

console.log('[RUN]: ' + command);
let splitted = command.split(' ');

let program = splitted[0];
let rest = splitted.slice(1);
let proc = child_process.spawn(program, rest, { stdio: 'inherit', shell: true });
let proc = child_process.spawn(command, { stdio: 'inherit', shell: true });

proc.on('close', function (code) {
if (code == 0) {
Expand Down
17 changes: 12 additions & 5 deletions lisp/core/eval.el
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,19 @@
(file-name-directory (nth 1 (member "-scriptload" command-line-args))))
nil t)

(require 'thingatpt)
(eask-load "core/exec")

(eask-start
(let ((form (eask-argv 0)))
(with-temp-buffer
(insert (thing-at-point--read-from-whole-string form))
(eval-buffer))))
(eask-defvc< 27 (eask-pkg-init)) ; XXX: remove this after we drop 26.x
(eask-setup-paths)
(ignore-errors (delete-directory eask-homedir t)) ; clean up

(if-let ((name (eask-argv 0)))
(eask-with-progress
(ansi-green "Exporting environment variables... ")
(eask--export-env)
(ansi-green "done ✓"))
(eask-info "✗ (No expression found)")
(eask-help "core/eval")))

;;; core/eval.el ends here
27 changes: 25 additions & 2 deletions src/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,28 @@
const path = require('path');
const child_process = require("child_process");

/**
* Form CLI arguments into a single string.
* @param { Array } argv - Argument vector.
*/
function cli_args(argv) {
let result = '';
let first = true;
argv.forEach(function (element) {
// XXX: We wrap double quotes if the string contains spaces
if (/\s/g.test(element)) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

element = element.replaceAll('\"', '\\"'); // escape double quotes
element = '\"' + element + '\"';
}
if (first)
result += element;
else
result += ' ' + element;
first = false;
});
return result;
}

/*
* Remove `undefined` item from the array
* @param { Array } arr - target array
Expand Down Expand Up @@ -118,7 +140,7 @@ async function e_call(argv, script, ...args) {
return new Promise(resolve => {
let _path = el_script(script);

let cmd_base = ['-Q', '--script', _path];
let cmd_base = ['emacs', '-Q', '--script', _path];
let cmd_args = args.flat();
let cmd_global = _global_options(argv).flat();
let cmd = cmd_base.concat(cmd_args).concat(cmd_global);
Expand All @@ -133,7 +155,7 @@ async function e_call(argv, script, ...args) {
console.log('[DEBUG] emacs ' + cmd.join(' '));

setup_env();
let proc = child_process.spawn('emacs', cmd, { stdio: 'inherit' });
let proc = child_process.spawn(cli_args(cmd), { stdio: 'inherit', shell: true });

proc.on('close', function (code) {
if (code == 0) {
Expand All @@ -148,6 +170,7 @@ async function e_call(argv, script, ...args) {
/*
* Module Exports
*/
module.exports.cli_args = cli_args;
module.exports.plugin_dir = plugin_dir;
module.exports.def_flag = def_flag;
module.exports.setup_env = setup_env;
Expand Down
2 changes: 1 addition & 1 deletion test/commands/local/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ eask run test
eask run -all

# Exection
eask eval '(progn (message "Hello World!~"))'
eask eval "(progn (require 'mini.emacs.pkg.1))"

# Linter
eask lint checkdoc
Expand Down