Skip to content

Commit

Permalink
Update changelog and README for v1.0.1 release; add extension logo, s…
Browse files Browse the repository at this point in the history
…creenshot, and "Getting Started" section
  • Loading branch information
dermatz committed Nov 16, 2024
1 parent 8089570 commit f5796bf
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 37 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,22 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how

## [Unreleased]


## v1.0.1
### Added
- Extension Logo
- Screenshot in the README file.
- Added a "Getting Started" section to the README.

## v1.0.0
### Added
- View log files in the `var/log` directory of your Magento project.
- Open log files directly in the editor by clicking on them in the tree view.
- Expand log files to view individual lines.
- Clear all log files with a single command.
- Status bar item showing the number of log entries.
- Badge in the tree view showing the total number of log entries.
- Repository field in `package.json`.

### Changed
- Status bar item now shows the total number of log entries instead of the number of log files.
Expand Down
46 changes: 10 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

The Magento Log Viewer extension for Visual Studio Code allows you to easily view and manage log files in your Magento project. This extension provides a tree view of log files, the ability to open and clear log files, and a status bar item showing the number of log entries.

![Magento Log Viewer Screenshot](resources/screenshot.png)

## Features

- **View Log Files**: Displays a tree view of log files in the `var/log` directory of your Magento project.
Expand All @@ -15,12 +17,15 @@ The Magento Log Viewer extension for Visual Studio Code allows you to easily vie
- Visual Studio Code version 1.95.0 or higher.
- A Magento project with log files located in the `var/log` directory.

## Extension Settings

This extension contributes the following settings:
## Getting Started

- `magentoLogViewer.isMagentoProject`: Indicates whether the current workspace is a Magento project. Options are "Yes", "No", and "Please select".
- `magentoLogViewer.magentoRoot`: The path to the Magento root folder.
1. **Install the extension**: Install the Magento Log Viewer extension from the Visual Studio Code marketplace.
2. **Open your Magento project**: Open your Magento project in Visual Studio Code.
3. **Configure the extension**: When you open a workspace, the extension will prompt you to specify if it is a Magento project. If you select "Yes", you will be prompted to select the Magento root folder.
4. **View log files**: The log files will be displayed in the tree view under the "Magento Log Viewer" activity bar.
5. **Open log files**: Click on any log file in the tree view to open it in the editor.
6. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines.
7. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory.

## Usage

Expand All @@ -31,35 +36,4 @@ This extension contributes the following settings:
5. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines.
6. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory.

## Known Issues

- None at the moment. Please report any issues you encounter.

## Release Notes

### 0.0.1

- Initial release of Magento Log Viewer.

---

## Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

## Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.

## For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

**Enjoy!**
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
"name": "magento-log-viewer",
"displayName": "Magento Log Viewer",
"description": "A Visual Studio Code extension to view and manage Magento log files.",
"version": "1.0.0",
"version": "1.0.1",
"publisher": "MathiasElle",
"icon": "resources/logo.png"
"repository": {
"type": "git",
"url": "https://github.com/dermatz/vscode-ext-magento-log-viewer"
Expand Down
Binary file added resources/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f5796bf

Please sign in to comment.