# pijul-vscode README

# Pijul for VS Code

This is the README for your extension "pijul-vscode". After writing up a brief description, we recommend including the following sections.

Pijul for VS Code is an extension for Visual Studio Code which adds integration with Pijul as a source control management system.

## Features

Why develop my own extension instead of contributing to the existing one? It didn't even occur to me to check if one already existed
when I started, and when I did my own extension had enough distinct features to set it apart.

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

## Features

For example if there is an image subfolder under your extension project workspace:

At present, this extension offers *most* of the basic features necessary for local Pijul development on a single channel. It includes basic
commands for initializing a repository in a VS Code workspace.

\!\[feature X\]\(images/feature-x.png\)

- Add, Reset, or Record one, some, or all of the files in the Pijul Repository.
- Decorations in the file tree indicating the current state of each file.

> 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.

Everything else still needs to be done on the command line.

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

Requires an existing Pijul installation. [Instructions for installing Pijul can be found here](https://pijul.org/manual/installing.html).

For example:
This extension contributes the following settings:
* `myExtension.enable`: enable/disable this extension
* `myExtension.thing`: set to `blah` to do something

Calling out known issues can help limit users opening duplicate issues against your extension.

I don't know of any major issues, but I will keep this section updated if any are reported.

## Release Notes

## Installation

Users appreciate release notes as you update your extension.
### 1.0.0
Initial release of ...
### 1.0.1
Fixed issue #.
### 1.1.0

Pijul for VS Code hasn't been published on the extension marketplace yet, so it needs to be built and installed from the source.
To do so, folloow these steps:

Added features X, Y, and Z.

1. Clone the repository
2. Install Visual Studio Code Extensions (VSCE)
```
npm install -g vsce
```
3. Package the extension
```
vcse package
```
4. In VS Code, open the Command Palette (Ctrl + Shift + P) and run the "Extensions: Install from VSIX..." to install the VSIX file you created in the last step 

-----------------------------------------------------------------------------------------------------------

## Roadmap

## Working with Markdown

With the eventual goal of releasing on the Extension Marketplace with the same level of quality as other source control extensions,
there are a number of areas which will require a great deal of further refinement:
- Proper handling of VS Code workspaces with multiple folders
- Automatic detection of Pijul installations
- More robust .ignore file handling
- Greater configurability

**Note:** You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:

There are also a number of Pijul features which still need implementation to reach a publishable minimum viable product, suitable for local Pijul development:
- Amending changes
- Moving and removing files
- Ignore file mangagement
- Basic change log
- Basic channel management

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets

In the long term, I would like to offer more in-depth Pijul integration, with the goal of providing a better experience than can be offered on the command line:
- Remote management
- Inline `pijul credit` annotations
- Inline `pijul diff` comparison
- IntelliJ style changeset system
- Splitting/Combining existing changes

### For more information

Each category probably could probably fit a couple more points that I haven't thought of.

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

## Contributing

**Enjoy!**

Pijul for VS Code welcomes all contributions. Before contributing, please be sure to add the following hook to your Pijul config file:
```
[hooks]
record = ["yarn run lint --fix"]
```