Merge pull request #1 from maxzirps/dev

v1.0.0

CHANGELOG.md

@@ -1,9 +1,9 @@
-# Change Log
+# Changelog
 
 All notable changes to the "image-search" extension will be documented in this file.
 
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+<!-- Check [Keep a Changelog](https://keepachangelog.com/) for recommendations on how to structure this file. -->
 
-## [Unreleased]
+## [1.0.0]
 
-- Initial release
+Released

README.md

@@ -1,47 +1,53 @@
 # ![Banner](images/banner.png)
 
-This extension allows you to search for images on Pixabay directly from within VS Code and download them to your workspace.
+Search and download images from Pixabay directly in VS Code
 
-While the preview images are low resolution, the downloaded images are medium sized.
+![Feature Screenshot](images/feature.gif)
 
 Using the [Pixabay API](https://pixabay.com/api/)
 
 Check their [Content license](https://pixabay.com/service/terms/)
 
-## Features
+While the preview images are low resolution, the downloaded images are medium-sized, ready for web development.
 
-- **Search Images**: Enter a description to search for images on Pixabay.
-- **View Results**: Display search results with thumbnails in a webview.
-- **Download Images**: Click on an image to download it directly to your workspace.
+## Requirements
 
-![Feature Screenshot](images/feature.gif)
+- **API Key Required**: The extension requires a valid Pixabay API key.
 
-## Requirements
+## Commands
 
-- **VS Code**: Ensure you are using the latest version of Visual Studio Code.
-- **Internet Connection**: Required to fetch images from the Pixabay API.
+- **Image-Search: Set Pixabay API key**: Set your Pixabay API key for image searches.
+- **Image-Search: Set resolution of downloaded images**: Choose the resolution for the images you download.
+- **Image-Search: Search Image**: Search for images on Pixabay.
 
 ## Extension Settings
 
-This extension uses the following settings:
+- **`image-search.pixabayAPIKey`**:
 
-- `image-search.pixabayAPIKey`: Your Pixabay API key for accessing image search functionality. You can set this using the command `Image Search: Set Pixabay API Key`.
+  - **Type**: `string`
+  - **Default**: `""`
+  - **Description**: Your Pixabay API key for searching images.
+
+- **`image-search.downloadedImageResolution`**:
+  - **Type**: `string`
+  - **Enum**:
+    - `"webformat"`: Medium sized image with a maximum width or height of 640 px (webformatWidth x webformatHeight).
+    - `"largeImage"`: Scaled image with a maximum width/height of 1280px.
+    - `"fullHD"`: Full HD scaled image with a maximum width/height of 1920px.
+    - `"image"`: URL to the original image (imageWidth x imageHeight).
+  - **Default**: `"webformat"`
+  - **Description**: You can choose between 4 predefined resolutions. FullHD and Image only work if your account has been approved for full access. Check their website for more information.
 
 ## Known Issues
 
 - **Needs caching**
 - **Needs Testing**
 - **No Workspace Folder Open**: If no workspace folder is open, the extension will not be able to save downloaded images.
-- **API Key Required**: The extension requires a valid Pixabay API key. Ensure you set it before attempting to search for images.
-
-## Release Notes
 
-### 0.0.1
+## License
 
-Still working on it
+This extension is licensed under the [MIT License](LICENSE).
 
 ---
 
-### Icon
-
 Icon generated with Microsoft Bing ∙ 17 September 2024 at 8:55 pm

eslint.config.mjs

@@ -17,7 +17,7 @@ export default [
     },
 
     rules: {
-      "@typescript-eslint/no-explicit-any": "warn",
+      "@typescript-eslint/no-explicit-any": "error",
       "@typescript-eslint/naming-convention": [
         "warn",
         {