https://github.com/dev-cetera/df_generate_header_comments
A tool to generate header comments for your source files.
https://github.com/dev-cetera/df_generate_header_comments
build-runner cli code-generation comments dart header-comments library package source-gen tool
Last synced: 24 days ago
JSON representation
A tool to generate header comments for your source files.
- Host: GitHub
- URL: https://github.com/dev-cetera/df_generate_header_comments
- Owner: dev-cetera
- License: mit
- Created: 2024-10-04T04:54:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-06-02T23:36:47.000Z (about 2 months ago)
- Last Synced: 2026-06-03T00:05:39.974Z (about 2 months ago)
- Topics: build-runner, cli, code-generation, comments, dart, header-comments, library, package, source-gen, tool
- Language: Dart
- Homepage: https://pub.dev/packages/df_generate_header_comments
- Size: 102 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/df_generate_header_comments)
[](https://github.com/dev-cetera/df_generate_header_comments/tree/v0.7.0)
[](https://www.buymeacoffee.com/dev_cetera)
[](https://github.com/sponsors/dev-cetera)
[](https://www.patreon.com/robelator)
[](https://discord.gg/gEQ8y2nfyX)
[](https://www.instagram.com/dev_cetera/)
[](https://raw.githubusercontent.com/dev-cetera/df_generate_header_comments/main/LICENSE)
---
Stamps a standard comment header onto every source file in a folder.
> ⚠️ This rewrites files in place. Commit or back up first.
## Install
```sh
dart pub global activate df_generate_header_comments
```
## Use
Create a `header_template.md` with the header you want stamped:
````md
```dart
// The use of this source code is governed by the LICENSE file located in this
// project's root directory.
```
````
From the target folder, run:
```sh
df_generate_header_comments --headers -t path/to/header_template.md
```
A [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Dev-Cetera.dev-cetera-df-support-commands) is also available — right-click a folder and pick `🔹 Generate Header Comments`.
---
🔍 For more information, refer to the [API reference](https://pub.dev/documentation/df_generate_header_comments/).
---
## 💬 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_header_comments/main/LICENSE). See [LICENSE](https://raw.githubusercontent.com/dev-cetera/df_generate_header_comments/main/LICENSE) for more information.