Skip to content

Commit d94d855

Browse files
committed
Update CHANGELOG and README for version 1.2.0: add bug report and feature request templates, change settings to workspace-specific
1 parent 60f3311 commit d94d855

File tree

4 files changed

+35
-32
lines changed

4 files changed

+35
-32
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ All notable changes to the "magento-log-viewer" extension will be documented in
55
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
66

77
## [Unreleased]
8+
9+
## [1.2.0] - 2024-11-17
810
### Added
911
- Comprehensive bug report template
1012
- Detailed feature request template
13+
### Changed
14+
- Settings are now saved in the workspace instead of globally in the USER.
1115

1216
## [1.1.0] - 2024-11-16
1317
### Added

README.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,36 @@
11
# Magento Log Viewer
22

3-
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.
4-
5-
![Magento Log Viewer Screenshot](resources/screenshot.png)
3+
The Magento Log Viewer extension for Visual Studio Code provides a convenient way to view and manage Magento log files directly in your workspace.
64

75
## Features
86

9-
- **View Log Files**: Displays a tree view of log files in the `var/log` directory of your Magento project.
10-
- **Open Log Files**: Open log files directly in the editor by clicking on them in the tree view.
11-
- **Collapsible Log Lines**: Each log file can be expanded to view individual lines.
12-
- **Clear Log Files**: Clear all log files with a single command.
13-
- **Status Bar Item**: Shows the number of log entries in the status bar.
14-
15-
## Requirements
7+
- Tree view of log files from Magento's `var/log` directory
8+
- Grouped log entries by severity level (ERROR, WARN, DEBUG, INFO)
9+
- Direct file opening with line highlighting
10+
- One-click log file clearing
11+
- Status bar showing total log entries
12+
- Real-time log file monitoring
1613

17-
- Visual Studio Code version 1.95.0 or higher.
18-
- A Magento project with log files located in the `var/log` directory.
14+
## Setup
1915

20-
## Getting Started
16+
1. Install the extension from VS Code marketplace
17+
2. Open your Magento project workspace
18+
3. When prompted, confirm it's a Magento project
19+
4. Select your Magento root directory
20+
5. The extension will now load your log files
2121

22-
1. **Install the extension**: Install the Magento Log Viewer extension from the Visual Studio Code marketplace.
23-
2. **Open your Magento project**: Open your Magento project in Visual Studio Code.
24-
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.
25-
4. **View log files**: The log files will be displayed in the tree view under the "Magento Log Viewer" activity bar.
26-
5. **Open log files**: Click on any log file in the tree view to open it in the editor.
27-
6. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines.
28-
7. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory.
22+
Note: Settings are workspace-specific, allowing different configurations for each Magento project.
2923

3024
## Usage
3125

32-
1. **Install the extension**: Install the Magento Log Viewer extension from the Visual Studio Code marketplace.
33-
2. **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.
34-
3. **View log files**: The log files will be displayed in the tree view under the "Magento Log Viewer" activity bar.
35-
4. **Open log files**: Click on any log file in the tree view to open it in the editor.
36-
5. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines.
37-
6. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory.
26+
- **View Logs**: Open the Magento Log Viewer sidebar (M logo)
27+
- **Clear Logs**: Click the trash icon in the view header
28+
- **Refresh**: Click the refresh icon or wait for auto-update
29+
- **Navigate**: Click on log entries to jump to specific lines
30+
- **Filter**: Expand log files to see entries grouped by severity
31+
32+
## Requirements
33+
34+
- VS Code 1.95.0+
3835

3936
**Enjoy!**

package.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "magento-log-viewer",
33
"displayName": "Magento Log Viewer",
44
"description": "A Visual Studio Code extension to view and manage Magento log files.",
5-
"version": "1.1.0",
5+
"version": "1.2.0",
66
"publisher": "MathiasElle",
77
"icon": "resources/logo.png",
88
"repository": {
@@ -44,12 +44,14 @@
4444
"type": "string",
4545
"enum": ["Yes", "No", "Please select"],
4646
"default": "Please select",
47-
"description": "This is a Magento project"
47+
"description": "This is a Magento project",
48+
"scope": "resource"
4849
},
4950
"magentoLogViewer.magentoRoot": {
5051
"type": "string",
5152
"default": "",
52-
"description": "Path to the Magento root folder"
53+
"description": "Path to the Magento root folder",
54+
"scope": "resource"
5355
}
5456
}
5557
},

src/extension.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ export function activate(context: vscode.ExtensionContext) {
1616
const defaultUri = workspaceFolders && workspaceFolders.length > 0 ? workspaceFolders[0].uri : undefined;
1717
vscode.window.showOpenDialog({ defaultUri, canSelectFolders: true, canSelectMany: false, openLabel: 'Select Magento Root Folder' }).then(folderUri => {
1818
if (folderUri && folderUri[0]) {
19-
config.update('magentoLogViewer.magentoRoot', folderUri[0].fsPath, vscode.ConfigurationTarget.Global).then(() => {
19+
config.update('magentoLogViewer.magentoRoot', folderUri[0].fsPath, vscode.ConfigurationTarget.Workspace).then(() => {
2020
vscode.window.showInformationMessage('Magento root folder successfully saved!');
21-
config.update('magentoLogViewer.isMagentoProject', 'Yes', vscode.ConfigurationTarget.Global);
21+
config.update('magentoLogViewer.isMagentoProject', 'Yes', vscode.ConfigurationTarget.Workspace);
2222
activateExtension(context, folderUri[0].fsPath);
2323
});
2424
}
2525
});
2626
}
2727
});
2828
} else {
29-
config.update('magentoLogViewer.isMagentoProject', selection, vscode.ConfigurationTarget.Global);
29+
config.update('magentoLogViewer.isMagentoProject', selection, vscode.ConfigurationTarget.Workspace);
3030
}
3131
});
3232
} else if (isMagentoProject === 'Yes') {

0 commit comments

Comments
 (0)