Skip to content

Commit

Permalink
chore: refactor documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jjjermiah committed Jun 1, 2024
1 parent a541966 commit e40b427
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 21 deletions.
52 changes: 31 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,6 @@ The prefix team is working on a [contribution to the official Python VSCode exte

## Features

**TODO List**

- [ ] Need to create a testing suite for the extension.
- [ ] Implement a logging system for the extension.
- [ ] Implement CI/CD to:
- [ ] Run tests
- [ ] Semantic versioning
- [ ] Change log generation
- [ ] Implement release process:
- [ ] Build and package the extension
- [ ] Publish the extension to the marketplace
- [x] Initialize a new Pixi project
- [x] Add channels to an existing Pixi project
- [x] Add packages to an existing Pixi project
- [x] Set Python interpreter for a Pixi project
- [ ] refactor to check for installed environments and if the python binary exists.
- [ ] Add platforms to an existing Pixi project
- [ ] Run tasks via cmd palette
- [ ] Add pypi packages to a Pixi project
- [ ] Install an environment from a Pixi project.
- [ ] Add functionality to handle `pixi.toml` and `pyproject.toml` files with [tool.pixi]

| Command Palette Command | Context Menu (right-click on folder)| Pixi Command | Description |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -92,3 +71,34 @@ Given an opened Pixi project, choose from the project's environments to set the
> This comman also requires for each environment to be installed with
> `pixi install -e <environment name>`.
> If you have not installed the environment, the command will behave unexpectedly.

### ROADMAP

- [ ] Need to create a testing suite for the extension.
- [ ] Implement a logging system for the extension.
- [ ] Implement CI/CD to:
- [ ] Run tests
- [ ] Semantic versioning
- [ ] Change log generation
- [ ] Implement release process:
- [ ] Build and package the extension
- [ ] Publish the extension to the marketplace
- [x] Initialize a new Pixi project
- [x] Add channels to an existing Pixi project
- [x] Add packages to an existing Pixi project
- [x] Set Python interpreter for a Pixi project
- [ ] refactor to check for installed environments and if the python binary exists.
- [ ] Add platforms to an existing Pixi project
- [ ] Run tasks via cmd palette
- [x] Add pypi packages to a Pixi project
- [ ] Install an environment from a Pixi project.
- [ ] Add functionality to handle `pixi.toml` and `pyproject.toml` files with [tool.pixi]

#### Syntax Highlighting
**Not implemented yet**
A lot more work is needed but it would be really cool to have some syntax
highlighting + recognizing syntax for features within the `pixi.toml` and `pyproject.toml` files.

Proof of concept highlighting the tasks and dependencies in a `pixi.toml` file:
![poc-syntax-highlighting](assets/preview_highlight.png)
Binary file added assets/preview_highlight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e40b427

Please sign in to comment.