|
1 | | -# laravel-logs README |
| 1 | +# Laravel Logs |
2 | 2 |
|
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. |
4 | 4 |
|
5 | 5 | ## Features |
6 | 6 |
|
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. |
8 | 10 |
|
9 | | -For example if there is an image subfolder under your extension project workspace: |
| 11 | +## Installation |
10 | 12 |
|
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 |
12 | 17 |
|
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 |
14 | 19 |
|
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 |
20 | 21 |
|
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: |
22 | 23 |
|
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 |
24 | 28 |
|
25 | | -This extension contributes the following settings: |
| 29 | +When opened, the log file will automatically scroll to the last line. |
26 | 30 |
|
27 | | -* `myExtension.enable`: Enable/disable this extension. |
28 | | -* `myExtension.thing`: Set to `blah` to do something. |
| 31 | +### Adding Log Code |
29 | 32 |
|
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: |
33 | 34 |
|
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) |
35 | 38 |
|
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. |
37 | 40 |
|
38 | | -### 1.0.0 |
| 41 | +## Configuration |
39 | 42 |
|
40 | | -Initial release of ... |
| 43 | +You can configure the default log level used when inserting log statements: |
41 | 44 |
|
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) |
43 | 48 |
|
44 | | -Fixed issue #. |
45 | | - |
46 | | -### 1.1.0 |
47 | | - |
48 | | -Added features X, Y, and Z. |
| 49 | +## Requirements |
49 | 50 |
|
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. |
51 | 53 |
|
52 | | -## Following extension guidelines |
| 54 | +## Known Issues |
53 | 55 |
|
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. |
55 | 57 |
|
56 | | -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
| 58 | +## Release Notes |
57 | 59 |
|
58 | | -## Working with Markdown |
| 60 | +### 0.0.1 |
59 | 61 |
|
60 | | -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
| 62 | +Initial release of Laravel Logs extension. |
61 | 63 |
|
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 |
65 | 65 |
|
66 | | -## For more information |
| 66 | +Contributions are welcome! Please feel free to submit a Pull Request. |
67 | 67 |
|
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 |
70 | 69 |
|
71 | | -**Enjoy!** |
| 70 | +This extension is licensed under the [MIT License](LICENSE). |
0 commit comments