#shell #batch #conversion

shell2batch

Coverts simple basic shell scripts to windows batch scripts

40 releases

0.4.5 Nov 1, 2022
0.4.4 Feb 6, 2022
0.4.3 Nov 19, 2021
0.4.2 Sep 28, 2019
0.1.6 Nov 3, 2017

#148 in Text processing

Download history 4580/week @ 2023-11-18 4412/week @ 2023-11-25 5288/week @ 2023-12-02 5918/week @ 2023-12-09 5211/week @ 2023-12-16 2706/week @ 2023-12-23 4647/week @ 2023-12-30 6425/week @ 2024-01-06 7419/week @ 2024-01-13 7465/week @ 2024-01-20 6423/week @ 2024-01-27 6736/week @ 2024-02-03 5609/week @ 2024-02-10 6961/week @ 2024-02-17 7071/week @ 2024-02-24 5005/week @ 2024-03-02

25,636 downloads per month
Used in 10 crates (via cargo-make)

Apache-2.0

1MB
853 lines

shell2batch

crates.io CI codecov
license Libraries.io for GitHub Documentation downloads
Built with cargo-make

Coverts simple basic shell scripts to windows batch scripts.

Overview

While it is not really possible to take every shell script and automatically convert it to a windows batch file, this library provides a way to convert simple basic shell commands to windows batch commands.
The original goal of this library is to provide users of cargo-make a way to write simple tasks with shell scripts without duplicating their code for each platform.

It is possible to provide custom conversion hints by using the # shell2batch: prefix (see below example).

Usage

Simply include the library and invoke the convert function as follows:

fn main() {
    let script = shell2batch::convert(
        r#"
        set -x

        export FILE1=file1
        export FILE2=file2

        #this is some test code
        cp ${FILE1} $FILE2
        cp -r ${DIR1} $DIR2

        #another
        mv file2 file3

        export MY_DIR=directory

        #flags are supported
        rm -Rf ${MY_DIR}

        unset MY_DIR

        touch ./file3

        #provide custom windows command for specific shell command
        complex_bash_command --flag1 value2 # shell2batch: complex_windows_command /flag10 windows_value
        "#,
    );

    assert_eq!(
        script,
        r#"
@echo on

set FILE1=file1
set FILE2=file2

@REM this is some test code
copy %FILE1% %FILE2%
xcopy /E %DIR1% %DIR2%

@REM another
move file2 file3

set MY_DIR=directory

@REM flags are supported
rmdir /S /Q %MY_DIR%

set MY_DIR=

copy /B .\file3+,, .\file3

@REM provide custom windows command for specific shell command
complex_windows_command /flag10 windows_value
"#
    );

    println!("Script: {}", script);
}

Installation

In order to use this library, just add it as a dependency:

[dependencies]
shell2batch = "^0.4.5"

API Documentation

See full docs at: API Docs

Contributing

See contributing guide

Release History

See Changelog

License

Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.

Dependencies

~2.1–3MB
~53K SLoC