Giter VIP home page Giter VIP logo

rust-sourcebundler's Introduction

CI coveralls crates.io

rust-sourcebundler

Bundle the source code of a rust cargo crate in a single source file.

Very useful for sending the source code to a competitive programming site that accept only a single file (codingame, I'm looking at you) and still keeping the cargo structure locally.

Usage

Add the following snippet to your Cargo.toml:

[package]
(...)
build = "build.rs"

[build-dependencies]
rustsourcebundler = { git = "https://github.com/lpenz/rust-sourcebundler" }

And create the file build.rs with the following:

//! Bundle mybin.rs and the crate libraries into singlefile.rs

use std::path::Path;
extern crate rustsourcebundler;
use rustsourcebundler::Bundler;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut bundler: Bundler = Bundler::new(Path::new("src/bin/mybin.rs"),
                                            Path::new("src/bin/singlefile.rs"));
    bundler.crate_name("<crate name>");
    bundler.run()?;
    Ok(())
}

You can use the code inside the example directory of this repository as a starting point.

Similar Projects

rust-sourcebundler's People

Contributors

lpenz avatar matthewscholefield avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

rust-sourcebundler's Issues

Support for direct `use` import statements

this tool seems to only support extern crate xxx for including dependencies while there appears to be no support for direct use xxx statements, which is the standard for current Rust versions (2018 edition onwards). This poses a significant limitation as extern crate has become largely redundant and non-idiomatic in the latest Rust versions

use foo::* converts to use *;

If I have this in src/bin/io-main.rs:

extern crate foo;
use foo::*;
use bar::Bar;  // Submodule of foo

pub fn main() {
  // ...
}

then the generated file contains:

// ...
use *;
use bar::Bar;  // Submodule of foo

pub fn main() {
  // ...
}

And rust rightly complains:

error: expected one of `;` or `{`, found keyword `use`
   --> /tmp/Answer.rs:172:1
    |
172 | use *;
    | ^^^ unexpected token

Sensitive to files without ending empty line

Hi,

thank you for this little crate, very handy ! While trying to use it, I've seen that the bundler is particularly sensitive to files that do not have an empty last line (in lib.rs, or any module we try to import). Once known it is OK, but pretty misleading when it happens.

I do not have the time right now to fokr and make a PR? but will do as soon as I can.

Best regards

Do not issue "use <crate>::xxx" in singlefile.rs for bundled xxx modules

A bundled xxx module generates the following code in singlefile.rs:

pub mod xxx {
...
}

When rust-sourcebundle sees a use <crate>:xxx in singlefile.rs, it strips <crate>, and it becomes use xxx. That works well when the line is bringing internal entities into scope, but generates a repeated module error when a whole module is referenced.

Hypothetical solution: track the embedded modules and be smarter about stripping parts of use lines.

Does not seem to work

Hi the bundler wasn't working for me so I cloned the repo and ran the example and when looking at the output singlefile.rs it looks like the bundler doesn't work. Here were the contents:

extern crate example;
use example::example_core::example_hello;

fn main() {
    println!("{}", example_hello());
}

I was expecting to see some modules and the definition of example_hello in this file but as you can see, it just looks like the original contents of example.rs no more, no less.

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.