https://github.com/rubyatscale/packwerk-vscode
Packwerk extension for Visual Studio Code
https://github.com/rubyatscale/packwerk-vscode
Last synced: 3 months ago
JSON representation
Packwerk extension for Visual Studio Code
- Host: GitHub
- URL: https://github.com/rubyatscale/packwerk-vscode
- Owner: rubyatscale
- License: mit
- Created: 2022-01-05T13:37:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T19:48:26.000Z (over 1 year ago)
- Last Synced: 2024-11-22T20:32:04.097Z (over 1 year ago)
- Language: TypeScript
- Size: 503 KB
- Stars: 21
- Watchers: 9
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Packwerk for Visual Studio Code
This extension provides an interface to packwerk for vscode.
[packwerk](https://github.com/Shopify/packwerk/) helps modularize large Rails monoliths
[packwerk-vscode in Code Market Place](https://marketplace.visualstudio.com/items?itemName=Gusto.packwerk-vscode)
## Stability
This is an alpha extension that is not guaranteed to work. We encourage you to experiment with it and provide feedback!
## Configuration
Specify configuration (via navigating to `File > Preferences > Workspace Settings` and editing file `settings.json):`
```javascript
{
// If not specified, uses `bin/packwerk check` (default and recommended, as this is what the packwerk setup guide recommends for executing packwerk)
// You may want to change this if, for example, you have a remote development environment that executes packwerk in a remote box.
"ruby.packwerk.executable": "",
// default true
"ruby.packwerk.onSave": true
}
```
# Contribute with this extension
Please install packages with yarn.
yarn install
You could install TSLint extension for .ts files.
Please format code using prettier.
```
yarn prettier src/* test/* --write
```
# License
This software is released under the MIT License, see [LICENSE.txt](LICENSE.txt).
# Kudos
Thanks to https://github.com/misogi/vscode-ruby-rubocop which this was modeled off of.