Download the PHP package iamsabbiralam/ghost-notes without Composer
On this page you can find all versions of the php package iamsabbiralam/ghost-notes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download iamsabbiralam/ghost-notes
More information about iamsabbiralam/ghost-notes
Files in iamsabbiralam/ghost-notes
Package ghost-notes
Short Description A Laravel package to generate a dev-diary from @ghost tags in your code.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ghost-notes
👻 GhostNotes - Transform Code Comments into a Dev Diary
GhostNotes is a powerful Laravel utility that scans your codebase for hidden tags like @ghost, @todo, or @fixme and compiles them into a beautiful, organized developer diary, multi-format reports, and a modern Web Dashboard.
✨ Features
- 🔍 Advanced Tag Scanning: Automatically finds
@ghost,@todo,@fixme, and@notewith optional Priority Levels (high|medium|low). - 🎨 Modern Dashboard: A sleek, Tailwind-powered dashboard with Search, Priority Badges, and Source Code Snippets.
- 📊 Multi-Format Export: Export your dev-diary into Markdown, JSON, or CSV (Excel compatible).
- 🏆 Resolved Graveyard: Track resolved notes in the "Resolved Ghosts" history after clearing them from your code.
- 🚀 VS Code & GitHub Integration: Open files directly in VS Code from the dashboard or view them on GitHub with line-specific links.
- 👤 Git Context: Automatically identifies the author using
git blame. - 🧹 Code Cleanup: Use the
--clearflag to safely remove tags from source code once they are logged. - 🔒 Safe for Devs: Dashboard and routes are automatically disabled in production.
🚀 Installation
Install the package via composer:
Set up everything with a single command:
This command publishes the config file and prepares the internal storage.
🛠 Usage
-
Adding Tags in Code You can now add priority levels to your tags:
-
Generating the Diary Run the command to scan files and update the dashboard cache:
-
Exporting Reports Generate reports in your preferred format:
- Clearing and Archiving Log the notes to the Resolved History and remove them from your code:
🖥 Web Dashboard
Visit the interactive dashboard at: http://your-app.test/ghost-notes
In the Dashboard you can:
- 🔍 Search through notes by author, message, or file name.
- 🖱️ One-click Open files directly in VS Code.
- 📦 Download reports as CSV, JSON, or Markdown.
- 🖨️ Print a clean PDF report of your technical debt.
- 📜 View History of all resolved/cleared notes.
⚙️ Configuration
The configuration file allows you to customize:
🤝 Contributing
Contributions are welcome! If you have any ideas, feel free to open an issue or submit a pull request.
📄 License
The MIT License (MIT). Please see License File for more information.
Developed by Sabbir Alam
