df_generate_dart_indexes 0.5.5

df_generate_dart_indexes: ^0.5.5 copied to clipboard

Dart & Flutter Packages by DevCetra.com & contributors.

Summary #

A tool to generate index/exports files also known as barrel files for all Dart files in a directory.

Usage Instructions #

1. You do not need to add this package to your pubspec.yaml file.
2. Activate the tool by running: dart pub global activate df_generate_dart_indexes.
3. Navigate to a folder in your project using the terminal (Tip: If you're using VS Code, you can right-click on a folder and select "Open in Integrated Terminal").
4. Run gen-indexes to generate an _index.g.dart file at the current location.
5. Or run gen-indexes-ts to generate an index files for TypeScript.

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 _index.g.dart.

Generated File Example: #

The file barrel file will look something like this, and is generated from this default template file:

//.title
// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
//
// GENERATED - DO NOT MODIFY BY HAND
// See: https://github.com/DevCetra/df_generate_dart_indexes
//
// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
//.title~

export 'hello_world.dart';
export 'some_folder/some_file.dart';

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: #

• Buy me a coffee: If you'd like to support the project financially, consider buying me a coffee. Your support helps cover the costs of development and keeps the project growing.
• Share your ideas: Every perspective matters, and your ideas can spark innovation.
• 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!

Chief Maintainer: #

📧 Email Robert Mollentze at robmllze@gmail.com

Dontations: #

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/robmllze

License #

This project is released under the MIT License. See LICENSE for more information.