https://github.com/limelight-mint/minty-starstyling
[✨] Starstyling | VS Code Extension for OOP-like simple and clear formatting that is 'breathing'.
https://github.com/limelight-mint/minty-starstyling
extension extensions visual-studio-code vscode vscode-extension
Last synced: 6 months ago
JSON representation
[✨] Starstyling | VS Code Extension for OOP-like simple and clear formatting that is 'breathing'.
- Host: GitHub
- URL: https://github.com/limelight-mint/minty-starstyling
- Owner: limelight-mint
- License: gpl-3.0
- Created: 2025-07-12T19:00:35.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-07-13T07:03:21.000Z (6 months ago)
- Last Synced: 2025-07-13T09:09:45.005Z (6 months ago)
- Topics: extension, extensions, visual-studio-code, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=limelight-mint.minty-starstyling
- Size: 74.2 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨ | Starstyling
VS Code extension to format your code into simple cosy and spacious OOP style in JS and TS files. 🍃
## Features
- **OOP-style formatting** for JavaScript and TypeScript files 🍃
- **Auto-format on save** (`"starstyling.isFormatOnSave": true`)
- **Manual formatting** (`"starstyling.styleKey": "ctrl+shift+f"`)
- **Project formatting** (`"starstyling.styleKeyEntireProject": "ctrl+shift+a"`)
- **Works with Vue**: Skips `{{ }}` (e.g., `{{ user.Name }}`)
- **Smart exclusions** for build files and dependencies
## Usage
### Automatic Formatting (default: true)
The extension automatically formats your JS/TS files when you save (`Ctrl+S`).
> To enable manual formatting use setting: `"starstyling.isFormatOnSave": false`
>
> Default key for manual format is: `"starstyling.styleKey": "ctrl+shift+f"`
> [!NOTE]
> All commands starts with `✨ | Starstyle...` in Command Palette.
## Working Example
**Before:**
```javascript
function test(){if(true){console.log("hello");}else{console.log("world");}}
```
**After:**
```javascript
function test()
{
if(true)
{
console.log("hello");
}
else
{
console.log("world");
}
}
```
## Settings Example
> No configuration needed to get started! 🌿✨
> [!TIP]
> Open VS Code settings (`Ctrl+,`) and search for "starstyling" to customize. Or use `.vscode/settings.json` file to exclude folders or singular files.
Default `.vscode/settings.json` customization (already applied, but u can customize if u want):
```
{
"starstyling.isFormatOnSave": true,
"starstyling.styleKey": "ctrl+shift+s",
"starstyling.styleKeyEntireProject": "ctrl+shift+a",
"starstyling.howManyLinesToAddBeforeFunctions": "2",
"starstyling.howManyLinesToAddBeforeConstructor": "1",
"starstyling.howManyLinesToAddAfterImports": "2",
"starstyling.howManyLinesToAddBeforeClasses": "1",
"starstyling.excludeFiles": [
"*.min.js",
"*.bundle.js",
"bundle.js",
"vendor.js"
],
"starstyling.excludeFolders": [
"node_modules",
"dist",
"build",
".git"
]
}
```
## Contribute and Bugfix
To test the repo clone it (green button up right), open with VS Code, install packages via `npm install`, and press F5 to open dev VS Code.
To build the repo and check your changes type `npm run compile`. Ready for publishing? Type `vsce package` and run the created package.
> This project welcomes any PRs and issues with reasonable comments and same code style. To open an issue please add your code and the result after formatting. (BEFORE:/AFTER: or screenshots)
___
[](https://github.com/limelight-mint/minty-starstyling)
[](https://github.com/limelight-mint/minty-starstyling/issues)
[](https://minty.bar/)