Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/koog1000/vscode-fossil

Integrated Fossil source control for Visual Studio Code
https://github.com/koog1000/vscode-fossil

fossil fossil-scm scm visual-studio-code vscode vscode-extension

Last synced: 4 months ago
JSON representation

Integrated Fossil source control for Visual Studio Code

Host: GitHub
URL: https://github.com/koog1000/vscode-fossil
Owner: koog1000
License: other
Created: 2019-08-10T00:43:02.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-01T07:12:12.000Z (8 months ago)
Last Synced: 2024-04-01T21:25:07.801Z (8 months ago)
Topics: fossil, fossil-scm, scm, visual-studio-code, vscode, vscode-extension
Language: TypeScript
Homepage:
Size: 2.98 MB
Stars: 60
Watchers: 5
Forks: 8
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # Integrated Fossil source control for Visual Studio Code

### Prerequisites

> This extension leverages your machine's Fossil installation,

so you need to

[install Fossil](https://www.fossil-scm.org/fossil/doc/trunk/www/quickstart.wiki)

first. Also read the [cloning](/docs/cloning.md) documentation for info

about cloning from the extension.

![Fossil](images/fossil.png)

# Features

* Add files and commit from the source control panel

  (i.e. where git normally appears).

* All the basics: commit, add, revert, update, push and pull.

* See changes inline within text editor.

* Interactive log for basic file history and diff.

* Branch, merge, resolve files.

* Praise

* Quickly switch branches, push and pull via status bar.

* Supports named-branches workflows.

* Automatic incoming/outgoing counters.

* Undo/Redo.

* Preview `md`, `wiki` and `pikchr` files

* Syntax highlighting for `pikchr` language

* Use command palette `Ctrl-Shift-P` >> `fossil:` to see all commands. (Not everything has a UI control.)

## View file changes

![View changes](images/fossil-diff.gif)

  * Click a file see the diff view

  * Or open a file by using context menu

## Initialize a new repo

![Init a repo](images/init.gif)

  * Just click the Fossil icon from the source control title area

    * Follow prompts

## Update to a branch/tag

![Change branches](images/change-branch.gif)

  * The current branch name is shown in the bottom-left corner.

  * Click it to see a list of branches and tags that you can update to.

# How to

* **Checkout by hash?**

  Use branch menu in the status bar.

* **Create a new branch?**

  Create a branch with "Commit Creating New Branch..." action in SCM menu or in command palette.

* **Modify commit message?**

  Use "Fossil log" from command palette and navigate the options till specific checkout.

* **Get current checkout hash or tags?**

  Hover over current branch name in the status bar

* **Close/reopen a branch?**

  Use 'Close branch...' and 'Reopen branch...' actions from command palette.

* **Commit partially**

  1. Run `Stash Snapshot` command

  2. Manually remove lines that you don't want in the commit

  3. Make a commit

  4. Run `Stash Pop`

* **Blame**

  Use `Fossil: praise` command from command palette

# Settings

`fossil.autoRefresh { boolean }`

  * Enables automatic refreshing of Source Control tab and badge counter

  when files within the project change:

  `"true"` — enabled

  `"false"` — disabled, manual refresh still available.

`fossil.path { string }`

  * Specifies an explicit `fossil` file path to use.

  * This should only be used if `fossil` cannot be found automatically.

  * The default behaviour is to search for `fossil` on the PATH.

  * Takes effect immediately.

`fossil.username { string }`

  * Specifies an explicit user to use for fossil commits.

  * This should only be used if the user is different than the fossil default user.

# Troubleshooting

In general, Fossil designers maintain an abundance of

[documentation](https://fossil-scm.org/home/doc/trunk/www/permutedindex.html).

Reference that documentation as much as possible.

| Issue | Resolution

--------|----------------------------------------------------------------

| Unknown certificate authority | Read the [Fossil SSL Documentation](https://fossil-scm.org/home/doc/trunk/www/ssl.wiki#certs) to update fossil with the correct CA |

| inputBox prompt difficult to read | Run the same fossil command on the built-in terminal (Ctrl+`). Unfortunately VS Code strips newlines and tabs from inputBox prompts. |

# Feedback & Contributing

* Please report any bugs, suggestions or documentation requests via the

[Github issues](https://github.com/koog1000/vscode-fossil/issues)

(_yes_, I see the irony).

* Feel free to submit

[pull requests](https://github.com/koog1000/vscode-fossil/pulls).

### For developers

* [Building and debugging](docs/dev/build.md)

* [Api behavior](docs/dev/api.md)

* [Releasing](docs/dev/release.md)

# Acknowledgements

[Ben Crowl](https://github.com/mrcrowl),

[koog1000](https://github.com/koog1000),

[senyai](https://github.com/senyai),

[ajansveld](https://github.com/ajansveld), [hoffmael](https://github.com/hoffmael), [nioh-wiki](https://github.com/nioh-wiki), [joaomoreno](https://github.com/joaomoreno), [nsgundy](https://github.com/nsgundy)