Skip to content

Commit

Permalink
Add vscode settings json for types.
Browse files Browse the repository at this point in the history
  • Loading branch information
robinjhuang committed Dec 31, 2024
1 parent 07aef11 commit 37aca5c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 5 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,3 @@ python_boilerplate/
cookiecutter-pypackage-env/

# vscode settings
.vscode/
.history/
*.code-workspace
1 change: 0 additions & 1 deletion {{cookiecutter.project_slug}}/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,5 @@ python_boilerplate/
cookiecutter-pypackage-env/

# vscode settings
.vscode/
.history/
*.code-workspace
8 changes: 8 additions & 0 deletions {{cookiecutter.project_slug}}/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
// Required - change /PATH/TO to the absolute path to ComfyUI. Windows e.g.: D:/My Folder/ComfyUI/
// This pulls in ComfyUI Python types for the extension.
"python.analysis.extraPaths": [
"/PATH/TO/ComfyUI/",
"/PATH/TO/ComfyUI/custom_nodes/"
],
}
9 changes: 8 additions & 1 deletion {{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The `-e` flag above will result in a "live" install, in the sense that any chang

## Using Github

Install Github Desktop or follow these [instructions] (https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for ssh.
Install Github Desktop or follow these [instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for ssh.

1. Create a Github repository that matches the directory name.
2. Push the files to Git
Expand All @@ -36,6 +36,13 @@ git push
## comfy_types
ComfyUI exposes types that are very helpful when developing custom nodes.

> 💡 **Hint:** To get the types in your modern IDE, you need to add your ComfyUI directory to the include paths. This repo has a [settings.json](.vscode/settings.json) with a template that you can use. Replace the ComfyUI path with your own.
## Tests

- [build-pipeline.yml](.github/workflows/build-pipeline.yml) will run pytest and linter
- [validate.yml](.github/workflows/validate.yml) will run [node-diff](https://github.com/Comfy-Org/node-diff) to check for breaking changes

## Publishing to Registry

If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in `pyproject.toml` under `tool.comfy`, but please double-check if they are correct.
Expand Down

0 comments on commit 37aca5c

Please sign in to comment.