Skip to content

Commit d2fc8f7

Browse files
updated package.json
1 parent 3b3199c commit d2fc8f7

File tree

5 files changed

+81
-48
lines changed

5 files changed

+81
-48
lines changed

CHANGELOG.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Change Log
22

3-
All notable changes to the "laravel-logs" extension will be documented in this file.
43

5-
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
4+
### [1.0.0] - 2024-09-23
65

7-
## [Unreleased]
8-
9-
- Initial release
6+
## Added
7+
- Insert log snippet command
8+
- View Laravel log file command
9+
- Context menu options for accessing log commands
10+
- Settings to configure default log type

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Jerome George
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 41 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,70 @@
1-
# laravel-logs README
1+
# Laravel Logs
22

3-
This is the README for your extension "laravel-logs". After writing up a brief description, we recommend including the following sections.
3+
Laravel Logs is a Visual Studio Code extension designed to enhance the logging experience for Laravel developers. It provides quick access to log files and simplifies the process of adding log statements to your code.
44

55
## Features
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
1. **Open Latest Log**: Quickly open and view the most recent Laravel log file.
8+
2. **Add Log Code**: Easily insert log statements into your PHP files.
9+
3. **Configurable Log Level**: Set your preferred default log level for inserted log statements.
810

9-
For example if there is an image subfolder under your extension project workspace:
11+
## Installation
1012

11-
\!\[feature X\]\(images/feature-x.png\)
13+
1. Open Visual Studio Code
14+
2. Press `Ctrl+P` (or `Cmd+P` on macOS) to open the Quick Open dialog
15+
3. Type `ext install laravel-logs` and press Enter
16+
4. Click the Install button to install the extension
1217

13-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
18+
## Usage
1419

15-
## Requirements
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20+
### Opening the Latest Log
2021

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22+
There are four ways to open the latest log file:
2223

23-
For example:
24+
1. Use the keyboard shortcut: `Ctrl+Shift+L` (or `Cmd+Shift+L` on macOS)
25+
2. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`), then type and select "Laravel Logs: Open Latest Log"
26+
3. Right-click anywhere in the editor and select "Laravel Logs: Open Latest Log" from the context menu
27+
4. Click on the "Laravel Logs: Open Latest Log" option in the explorer view title menu
2428

25-
This extension contributes the following settings:
29+
When opened, the log file will automatically scroll to the last line.
2630

27-
* `myExtension.enable`: Enable/disable this extension.
28-
* `myExtension.thing`: Set to `blah` to do something.
31+
### Adding Log Code
2932

30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33+
To add a log statement to your PHP file:
3334

34-
## Release Notes
35+
1. Place your cursor where you want to insert the log statement
36+
2. Use the keyboard shortcut: `Ctrl+Shift+I` (or `Cmd+Shift+I` on macOS)
37+
3. Alternatively, right-click and select "Laravel Logs: Add Log Code" from the context menu (only available in PHP files)
3538

36-
Users appreciate release notes as you update your extension.
39+
The extension will automatically add the necessary `use` statement if it's not already present in the file.
3740

38-
### 1.0.0
41+
## Configuration
3942

40-
Initial release of ...
43+
You can configure the default log level used when inserting log statements:
4144

42-
### 1.0.1
45+
1. Open VS Code settings (`Ctrl+,` or `Cmd+,`)
46+
2. Search for "Laravel Logs"
47+
3. Set the "Default Log Level" to your preferred level (info, warning, or error)
4348

44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49+
## Requirements
4950

50-
---
51+
- This extension requires a Laravel project structure to function correctly.
52+
- The project must have a `storage/logs` directory for log file access.
5153

52-
## Following extension guidelines
54+
## Known Issues
5355

54-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
56+
- The extension currently only supports single-workspace environments.
5557

56-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
58+
## Release Notes
5759

58-
## Working with Markdown
60+
### 0.0.1
5961

60-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
62+
Initial release of Laravel Logs extension.
6163

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

66-
## For more information
66+
Contributions are welcome! Please feel free to submit a Pull Request.
6767

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

71-
**Enjoy!**
70+
This extension is licensed under the [MIT License](LICENSE).

media/icon.png

145 KB
Loading

package.json

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,25 @@
22
"name": "laravel-logs",
33
"displayName": "Laravel Logs",
44
"description": "Laravel log viewer and log code insertion tool",
5-
"version": "0.0.1",
5+
"version": "1.0.0",
6+
"publisher": "dreamcatcher45",
7+
"homepage": "https://github.com/dreamcatcher45/laravel-logs-vscode-extension",
8+
"repository": {
9+
"type": "git",
10+
"url": "https://github.com/dreamcatcher45/laravel-logs-vscode-extension"
11+
},
612
"engines": {
713
"vscode": "^1.93.0"
814
},
915
"categories": [
1016
"Other"
1117
],
18+
"tags": [
19+
"Laravel",
20+
"laravelLogs",
21+
"logs","laravel-logs","dreamcatcher45"
22+
],
23+
"icon": "media/icon.png",
1224
"activationEvents": [
1325
"onLanguage:php"
1426
],

0 commit comments

Comments
 (0)