Git Product home page Git Product logo

wish-tree's Introduction

wish-tree

A small Rust library for describing directory structures and creating them as ZIP/tar archives or directly on the file system.

Usage

Not yet published on cargo.io!

Add this to your Cargo.toml:

[dependencies]
wish-tree = "0.1.0"

In your code:

use wish_tree::*;

// 1. Describe your desired target directory structure declaratively.
let my_dir = dir! {
    "dist" => dir! {
        "empty-dir" => dir!(),
        "index.js" => "build/index.js",
        "doc" => dir("build/doc").include("**/*.md"),
    },
    "README.txt" => text("This is a README file."),
};

// 2. "Render" it.
my_dir.render_to_fs("target/my-dir");
my_dir.render_to_zip("target/my-dir.zip");
my_dir.render_to_tar_gz("target/my-dir.tar.gz");

Known issues

  • Error handling has not been thought of so far. It just panics, e.g. if a file is missing. While panicking is okay for my use case (packaging a distribution bundle), it might not be for others. Also, it doesn't which file is missing.
  • When writing a tar.gz, you can't currently customize executable bits etc.

wish-tree's People

Contributors

helgoboss avatar

Stargazers

Rahul Butani avatar annie avatar Matt Johnston avatar  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.