Support settings of custom project path in Kedro Extension

[jitu5]

Description

Resolves #19

This pull request introduces a new feature to allow setting a custom path to the Kedro project root directory through the configuration. The changes span multiple files to integrate this new feature into the existing system.

How to set Kedro project path

• In VSCode open command palette by pressing Cmd + Shift + P
• Type Kedro: Set Project Path
• Paste your absolute path to Kedro project

or

• open VScode setting by pressing cmd + ,
• Search kedro
• Set Kedro: Set Project Path field with your absolute path to Kedro project

Note

If the user-supplied Kedro project path's folder is not part of the currently open workspace in VSCode, the extension will add it to the workspace explorer as part of a multi-root workspace, alongside any existing folders.

User flow

Development notes

Refactor extension.ts:

• src/extension.ts: Refactored extension.ts by taking out runServer.ts and registerCommandsAndEvents.ts from it.

Enhancements to Kedro Project Path Handling:

• bundled/tool/lsp_server.py: Updated methods to utilize kedroProjectPath from workspace settings if available, enhancing flexibility in project path configuration. [1] [2] [3]
• package.json: Added configuration for kedro.kedroProjectPath and a new command kedro.kedroProjectPath for setting the Kedro project path. [1] [2]

Command and Event Registration:

• src/common/activationHelper.ts: Registered new commands and events, including the command to set the Kedro project path.

Utility and Helper Functions:

• src/common/commands.ts: Added a function to set the Kedro project path and updated environment selection to consider the new path setting. [1] [2]
• src/common/utilities.ts: Enhanced utility functions to check and get Kedro project paths, ensuring they respect the new configuration. [1] [2] [3] [4]

Configuration and Settings:

• src/common/settings.ts: Included kedroProjectPath in the settings interface and related functions, allowing it to be retrieved and checked for changes. [1] [2] [3] [4]

QA notes

Keep your Kedro project in below folder structure

root
│   file001.txt    
│
└───folder1
│   │   file011.txt
│   │   file012.txt
│   │
│   └───kedroProject
│       │   pyproject.toml
│       │   README.md
│       │   ...
│   
└───folder2
    │   file021.txt
    │   file022.txt

Copy your absolute path to Kedro project, /Users/Jitendra_Gundaniya/root/folder1/kedroProject

Checklist

• Opened this PR as a 'Draft Pull Request' if it is work-in-progress

[SajidAlamQB]

Hey @jitu5, I've tested this manually and it seems to work, when I use the new command and open viz it displays the kedro project but it doesn't open its workspace.

[jitu5]

If the user-supplied Kedro project path's folder is not part of the currently open workspace in VSCode, the extension will add it to the workspace explorer as part of a multi-root workspace, alongside any existing folders.

@SajidAlamQB If the user-supplied Kedro project path's folder is not part of the currently open workspace in VSCode, the extension will add it to the workspace explorer as part of a multi-root workspace, alongside any existing folders. Please re test it and let me know.

[SajidAlamQB]

Please re test it and let me know.

Hey @jitu5 I've tested this manually and its working well. If understood does it now create a new workspace with the existing and selected projects.

[jitu5]

Please re test it and let me know.

Hey @jitu5 I've tested this manually and its working well. If understood does it now create a new workspace with the existing and selected projects.

@SajidAlamQB Yes it create a new workspace with existing and selected project.

[SajidAlamQB]

Hey Jitendra, thanks for this, I've tested it out manually and it all seems to work, I understand what you mean sometimes we need to reload window for it to fully initialise. Is there a way to trigger this after successful use of setting custom project? Otherwise we can document this clearly for users.

[jitu5]

Hey Jitendra, thanks for this, I've tested it out manually and it all seems to work, I understand what you mean sometimes we need to reload window for it to fully initialise. Is there a way to trigger this after successful use of setting custom project? Otherwise we can document this clearly for users.

@SajidAlamQB I fixed this issue, now no need to use reload window after setting custom Kedro project. could you please test it again. thanks.