Skip to content
This repository has been archived by the owner on Apr 30, 2024. It is now read-only.

Add new Evidence: Template Project Url extension Setting #62

Closed
9 tasks done
RandomFractals opened this issue Jun 4, 2023 · 15 comments
Closed
9 tasks done

Add new Evidence: Template Project Url extension Setting #62

RandomFractals opened this issue Jun 4, 2023 · 15 comments
Labels
feature New Feature onboarding Onboarding feature or improvement template Template related tasks or features UX User experience feature or improvement

Comments

@RandomFractals
Copy link
Contributor

RandomFractals commented Jun 4, 2023

to allow users to set their own local or remote Evidence template Url in extension Settings.

  • add evidence.templateProjectUrl string setting to package.json
  • default it to the Evidence template github repo Url for now
  • use this new evidence.templateProjectUrl setting in project.ts when creating new projects
  • check for file:// or https:// template project Uri scheme to determine if we need to load it from local file system or github repo via cloning added in Add Evidence: New Project command and folder context menu options #48
  • test it with cloned Evidence template repo and local fs
  • update Add Evidence: New Project command and folder context menu options #48 to either copy local project folder or clone it from github based on the template Url scheme entered in the displayed template Url prompt
  • test new embedded Evidence project /template added in Use new simple Evidence /template bundled with extension to create New Project #61 by changing this setting to /template extension folder path
  • update Settings section in README.md with this new setting info
  • change this setting to use new embedded /template folder by default for faster New Evidence Project and Evidence Project from Template project creation and onboarding user experience.
@RandomFractals RandomFractals added feature New Feature UX User experience feature or improvement onboarding Onboarding feature or improvement labels Jun 4, 2023
@RandomFractals
Copy link
Contributor Author

New Evidence Template Project Url Setting displayed when you view Evidence settings using new View Settings command from #55

image

RandomFractals added a commit that referenced this issue Jun 4, 2023
and provide the local `/template` extension folder as default for that setting value. see (#61)
@RandomFractals
Copy link
Contributor Author

New Evidence Project command using this new evidence.templateProjectUrl setting with github url, and cloning that repo:

image

@RandomFractals
Copy link
Contributor Author

When invalid github url is provided in new evidence.templateProjectUrl setting:

image

@RandomFractals
Copy link
Contributor Author

Error message displayed when invalid template project Url is provided, i.e. not using https:// or file://:

image

RandomFractals added a commit that referenced this issue Jun 4, 2023
…exists (#62)

and use it in `deleteFolder` in `fsUtils.ts` too
@RandomFractals
Copy link
Contributor Author

Invalid local template project folder error message and output logging display:

image

RandomFractals added a commit that referenced this issue Jun 4, 2023
and add extra output channel logging for the valid and invalid template folders
@RandomFractals
Copy link
Contributor Author

Output view messages and prompt to open created project folder when a valid file:// template project Url is provided:

image

@RandomFractals
Copy link
Contributor Author

RandomFractals commented Jun 4, 2023

New and improved instance new Evidence project creation from a local template folder:

evidence-project-new-from-local-template

RandomFractals added a commit that referenced this issue Jun 4, 2023
…json` (#62)

to use the built-in `/template` folder added in #60 and #61
RandomFractals added a commit that referenced this issue Jun 4, 2023
@RandomFractals RandomFractals changed the title Add new Evidence Template Project Url extension setting Add new Evidence: Template Project Url extension Setting Jun 4, 2023
@RandomFractals
Copy link
Contributor Author

RandomFractals commented Jun 4, 2023

will need to finalize this for the v1.1.0 release too (#65)

@RandomFractals
Copy link
Contributor Author

Updated Settings section with new evidence.templateProjectUrl info in md table and settings.json config example in docs:

https://github.com/evidence-dev/evidence-vscode#evidence-settings

RandomFractals added a commit that referenced this issue Jun 5, 2023
and remove json language tag from the custom config example code block for the sample file path not to show in red in docs
RandomFractals added a commit that referenced this issue Jun 5, 2023
…e proj. context after project folder is created (#62)
RandomFractals added a commit to RandomFractals/evidence-dev-template that referenced this issue Jun 5, 2023
…vidence projects

and quick Evidence project scaffolding using new Evidence VSCode v1.1.0 template project Url Setting described in evidence-dev/evidence-vscode#62
@RandomFractals
Copy link
Contributor Author

Using /template folder from this repo for the default template project url and cloning to create new project:

image

@RandomFractals
Copy link
Contributor Author

We can set /template as default once we can confirm #72 works on Mac OS as expected.

RandomFractals added a commit that referenced this issue Jun 6, 2023
@RandomFractals
Copy link
Contributor Author

New evidence.templateProjectUrl default and description displayed in the built-in VS Code Settings editor:

image

@RandomFractals
Copy link
Contributor Author

File setting description v.:

image

@RandomFractals
Copy link
Contributor Author

File setting description v.:

image

@RandomFractals
Copy link
Contributor Author

RandomFractals commented Jun 6, 2023

See updated and final Settings section in docs for the v1.1.0 release:

https://github.com/evidence-dev/evidence-vscode#evidence-settings

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature New Feature onboarding Onboarding feature or improvement template Template related tasks or features UX User experience feature or improvement
Projects
None yet
Development

No branches or pull requests

1 participant