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: 2 months 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 (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-07-12T23:12:03.000Z (8 months ago)
• Last Synced: 2025-10-21T11:48:18.612Z (5 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: 77.1 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

          




Dart & Flutter Packages by dev-cetera.com & contributors.

[![sponsor](https://img.shields.io/badge/sponsor-grey?logo=github-sponsors)](https://github.com/sponsors/dev-cetera)

[![patreon](https://img.shields.io/badge/patreon-grey?logo=patreon)](https://www.patreon.com/c/RobertMollentze)

[![pub](https://img.shields.io/pub/v/df_generate_header_comments.svg)](https://pub.dev/packages/df_generate_header_comments)

[![tag](https://img.shields.io/badge/tag-v0.6.0-purple?logo=github)](https://github.com/dev-cetera/df_generate_header_comments/tree/v0.6.0)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/dev-cetera/df_generate_header_comments/main/LICENSE)

---

[![banner](https://github.com/dev-cetera/df_safer_dart/blob/v0.6.0/doc/assets/banner.png?raw=true)](https://github.com/dev-cetera)

This tool automatically adds standardized comment headers to your source files, enhancing protection, consistency, and authenticity across your codebase.

## 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. Create a template file in your project's directory and call it `header_template.md`:

   ````md

   ```dart

   // The use of this source code is governed by the LICENSE file located in this

   // project's root directory.

   ```

   ````

3. Back up your source code!

4. Right-click on any folder in your project and select `🔹 Generate Header Comments`.

5. Alternatively, right-click a folder and select `"Open in Integrated Terminal"` then run `--headers -t path/to/header_template.md` in the terminal.

6. This will modify source files in the folder and add the header comments.

### Without Visual Studio Code

1. Install this tool by running: `dart pub global activate df_generate_header_comments`.

2. Back up your source code!

3. Create a template file and call it something like `header_template.md`:

   ````md

   ```dart

   // The use of this source code is governed by the LICENSE file located in this

   // project's root directory.

   ```

   ````

4. Open a terminal at a desired folder then run `--headers -t path/to/header_template.md` in the terminal. This will modify source files in the folder and add the header comments.

---

☝️ Please refer to the [API reference](https://pub.dev/documentation/df_generate_header_comments/) for more information.

---

## 💬 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](https://www.buymeacoffee.com/dev_cetera). Your support helps cover the costs of development and keeps the project growing.

- **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.