https://github.com/dtolnay/automod

Pull in every source file in a directory as a module
https://github.com/dtolnay/automod

Last synced: about 6 hours ago
JSON representation

Pull in every source file in a directory as a module

• Host: GitHub
• URL: https://github.com/dtolnay/automod
• Owner: dtolnay
• License: apache-2.0
• Created: 2019-02-28T08:43:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-25T19:12:51.000Z (3 months ago)
• Last Synced: 2024-11-06T16:38:44.211Z (7 days ago)
• Language: Rust
• Homepage:
• Size: 124 KB
• Stars: 158
• Watchers: 5
• Forks: 22
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
Automod

=======

[](https://github.com/dtolnay/automod)

[](https://crates.io/crates/automod)

[](https://docs.rs/automod)

[](https://github.com/dtolnay/automod/actions?query=branch%3Amaster)

Pull in every source file in a directory as a module.

```toml

[dependencies]

automod = "1.0"

```

## Syntax

```rust

automod::dir!("path/to/directory");

```

This macro expands to one or more `mod` items, one for each source file in the

specified directory.

The path is given relative to the directory containing Cargo.toml.

It is an error if the given directory contains no source files.

The macro takes an optional visibility to apply on the generated modules:

`automod::dir!(pub "path/to/directory")`.

## Example

Suppose that we would like to keep a directory of regression tests for

individual numbered issues:

- tests/

  - regression/

    - issue1.rs

    - issue2.rs

    - ...

    - issue128.rs

We would like to be able to toss files in this directory and have them

automatically tested, without listing them in some explicit list of modules.

Automod solves this by adding *tests/regression.rs* containing:

```rust

mod regression {

    automod::dir!("tests/regression");

}

```

The macro invocation expands to:

```rust

mod issue1;

mod issue2;

/* ... */

mod issue128;

```




#### License



Licensed under either of Apache License, Version

2.0 or MIT license at your option.








Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in this crate by you, as defined in the Apache-2.0 license, shall

be dual licensed as above, without any additional terms or conditions.