🚀 Initial commit

Author: rodolphebarbanneau

.editorconfig

@@ -0,0 +1,19 @@
+# Top-most EditorConfig file
+root = true
+
+# Global config
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Python
+[*.{py,pyi,toml}]
+indent_size = 4
+
+# Markdown
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,2 @@
+# Set default behavior to automatically normalize line endings.
+* text=auto

.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+node_modules
+*.vsix

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit:
+  // https://code.visualstudio.com/docs/editor/debugging#_launch-configurations
+
+	"version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--folder-uri=${workspaceFolder}/tests",
+        "${workspaceFolder}/tests/google.py",
+        "${workspaceFolder}/tests/sphinx.py",
+      ]
+    }
+  ]
+}

.vscodeignore

@@ -0,0 +1,4 @@
+.vscode/**
+.vscode-test/**
+.gitignore
+vsc-extension-quickstart.md

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "python-docstring-highlighter" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+
+- Initial release

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Welcome to your VS Code Extension
+
+## What's in the folder
+
+* This folder contains all of the files necessary for the extension.
+* `package.json` - this is the manifest file in which the language support is declared and the location of the grammar files are defined.
+* `syntaxes/xxx.tmLanguage.json` - this is a Text mate grammar file that is used for tokenization.
+
+## Get up and running straight away
+
+* Press `F5` to open a new window with your extension loaded.
+* Create a new file with a file name suffix matching your language.
+* Verify that syntax highlighting works and that the language configuration settings are working.
+
+## Make changes
+
+* You can relaunch the extension from the debug toolbar after making changes to the files listed above.
+* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
+
+## Add more language features
+
+* To add features such as IntelliSense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs
+
+## Install the extension
+
+* To start using the extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code.
+* To share the extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.
+
+## Publish the extension
+
+* Install `vsce` by running `npm install -g @vscode/vsce`.
+* Run `vsce package` from the command line.
+* Run `vsce publish` and open https://marketplace.visualstudio.com and publish your extension.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Rodolphe Barbanneau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# Python Docstring Highlighter (VSCode Extension)
+
+This repository contains the source code for the Python Docstring Highlighter extension for Visual Studio Code. This extension is designed to highlight docstrings in Python code, making it easier to read and understand the code. It is optimized for the **Google** and **Sphinx** styles docstring format, but it should work partially with other formats as well.