Code Monkey home page Code Monkey logo

bundle-rs's Introduction

bundle-rs

The main purpose of this crate is to bundle Rust projects in a single file. The target use case for this is submitting code to https://www.codingame.com/ where their sync tool requires the code to be in a single file which is very inconvenient when working on a complex algorithm

Example:

Let consider we have source code in 2 files

main.rs

mod common;

use common:*;

pub fn main() {
    let result = reusable_function();

    match result {
        MyType::Value1 => todo!(),
        MyType::Value2 => todo!()
    }
    /*
    Program entry point .....
    .....
    ...
    */
}

common.rs

pub enum MyType {
    Value1,
    Value2
}

pub fn reusable_function() -> MyType {
    todo!()
}
/*....*/

This crate allows to bundle this project consisting of 2 files into functionally equivalent single file that looks like this: output.rs

mod common {
    pub enum MyType {
        Value1,
        Value2
    }

    pub fn reusable_function() -> MyType {
        todo!()
    }
}

use common:*;

pub fn main() {
    let result = reusable_function();

    match result {
        MyType::Value1 => todo!(),
        MyType::Value2 => todo!()
    }
    /*
    Program entry point .....
    .....
    ...
    */
}

Which in it's turn is linked to Coding Game Sync App that uploads it to the Coding Game platform.

Usage

Add build.rs file your cargo project with the following content:

use bundle_rs::{Bundle, ModuleFileSystem};

fn main() -> std::io::Result<()> {
    let mut bundle = Bundle::new("main", ModuleFileSystem::new(vec!["./src"]));
    bundle.load()?;
    return bundle.write(&mut std::fs::File::create("./dist/singlefile.rs")?);
}

(_Note: you can link to any executable you want not specifically main _ ) Add the following to the Cargo.toml of your project

[package]
build = "build/build.rs" #path to build.rs where you decided to put it
#....

[build-dependencies]
bundle-rs = {git = "https://github.com/VladimirMakaev/bundle-rs.git", branch = "main"}

Now when you build your project a single file with bundled source code will be placed to ./dist/singlefile.rs

bundle-rs's People

Contributors

vladimirmakaev avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.