https://github.com/dev-cetera/df_generate_dart_indexes
A tool to generate index/exports files also known as barrel files for all Dart files in a directory.
https://github.com/dev-cetera/df_generate_dart_indexes
barrel-file build-runner cli code-generation codegen dart index index-files tool
Last synced: 2 months ago
JSON representation
A tool to generate index/exports files also known as barrel files for all Dart files in a directory.
- Host: GitHub
- URL: https://github.com/dev-cetera/df_generate_dart_indexes
- Owner: dev-cetera
- License: mit
- Created: 2024-08-03T10:45:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-20T06:42:06.000Z (about 1 year ago)
- Last Synced: 2025-01-20T07:34:13.922Z (about 1 year ago)
- Topics: barrel-file, build-runner, cli, code-generation, codegen, dart, index, index-files, tool
- Language: Dart
- Homepage: https://pub.dev/packages/df_generate_dart_indexes
- Size: 86.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/dev-cetera)
[](https://pub.dev/packages/df_generate_dart_indexes)
[](https://github.com/dev-cetera/df_generate_dart_indexes/tree/v0.6.3)
[](https://www.buymeacoffee.com/dev_cetera)
[](https://github.com/sponsors/dev-cetera)
[](https://www.patreon.com/t0mb3rr)
[](https://discord.gg/gEQ8y2nfyX)
[](https://www.instagram.com/dev_cetera/)
[](https://raw.githubusercontent.com/dev-cetera/df_generate_dart_indexes/main/LICENSE)
---
A tool to generate index/exports files also known as barrel files for all Dart files in a directory.
## How to Use
### With Visual Studio Code
1. Install the extension here: https://marketplace.visualstudio.com/items?itemName=Dev-Cetera.dev-cetera-df-support-commands
2. Right-click on any folder in your project and select `🔹 Generate Dart Barrel File`.
3. Alternatively, right-click a folder and select `"Open in Integrated Terminal"` then run `--barrel` in the terminal.
4. This will generate a barrel file matching the folder’s base name, e.g. `_src.g.dart`.
### Without Visual Studio Code
1. Install this tool by running: `dart pub global activate df_generate_dart_indexes`.
2. In your project, open a terminal at the desired folder, e.g. `cd src`.
3. Run `--barrel` to generate a barrel file matching the folder’s base name, e.g. `_src.g.dart`.
### Note
Files that start with an underscore, files in folders that start with an underscore, and generated files (those with the `.g.dart` extension) will be omitted from the generated barrel file.
### Generated File Example
The file barrel file will look something like this, and is generated from [this default template file](https://github.com/dev-cetera/df_generate_dart_indexes/blob/main/templates/template.dart.md):
```dart
//.title
// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
//
// GENERATED - DO NOT MODIFY BY HAND
// See: https://github.com/dev-cetera/df_generate_dart_indexes
//
// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
//.title~
export './screens/welcome_screen/widget.dart';
export './screens/home_screen/widget.dart';
export './widgets/my_button.dart';
export './widgets/my_title_text.dart';
```
---
🔍 For more information, refer to the [API reference](https://pub.dev/documentation/df_generate_dart_indexes/).
---
## 💬 Contributing and Discussions
This is an open-source project, and we warmly welcome contributions from everyone, regardless of experience level. Whether you're a seasoned developer or just starting out, contributing to this project is a fantastic way to learn, share your knowledge, and make a meaningful impact on the community.
### ☝️ Ways you can contribute
- **Find us on Discord:** Feel free to ask questions and engage with the community here: https://discord.gg/gEQ8y2nfyX.
- **Share your ideas:** Every perspective matters, and your ideas can spark innovation.
- **Help others:** Engage with other users by offering advice, solutions, or troubleshooting assistance.
- **Report bugs:** Help us identify and fix issues to make the project more robust.
- **Suggest improvements or new features:** Your ideas can help shape the future of the project.
- **Help clarify documentation:** Good documentation is key to accessibility. You can make it easier for others to get started by improving or expanding our documentation.
- **Write articles:** Share your knowledge by writing tutorials, guides, or blog posts about your experiences with the project. It's a great way to contribute and help others learn.
No matter how you choose to contribute, your involvement is greatly appreciated and valued!
### ☕ We drink a lot of coffee...
If you're enjoying this package and find it valuable, consider showing your appreciation with a small donation. Every bit helps in supporting future development. You can donate here: https://www.buymeacoffee.com/dev_cetera
## LICENSE
This project is released under the [MIT License](https://raw.githubusercontent.com/dev-cetera/df_generate_dart_indexes/main/LICENSE). See [LICENSE](https://raw.githubusercontent.com/dev-cetera/df_generate_dart_indexes/main/LICENSE) for more information.