-
Notifications
You must be signed in to change notification settings - Fork 2.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[V15] Updated dotnet template for Umbraco Packages with Bellisima #17108
base: v15/dev
Are you sure you want to change the base?
[V15] Updated dotnet template for Umbraco Packages with Bellisima #17108
Conversation
Hi there @warrenbuckley, thank you for this contribution! 👍 While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:
Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution. If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request. Thanks, from your friendly Umbraco GitHub bot 🤖 🙂 |
This is because the RCL based one will be the only one going forward
If you were extending/customising the backoffice of a project in v13 and earlier, you could just add your code into a folder in App_Plugins - there was no need for front-end build steps as you deployed the source files. This package template really was a (very simple) start to people building actual packages: it wasn't needed by people looking to just customise a specific Umbraco backoffice. In v14+ you definitely do not want to have your source files for your own extensions in App_Plugins, and so I think that the template being proposed here is arguably a template for extending the backoffice, not for building a package. So in light of that would renaming the template from
It would also differentiate this template from community templates that are designed for developing packages - that come with test sites, and a head-start on publishing to nuget etc. Whereas this core template is showing good practise for extending the backoffice. That extension might turn into a package to be distributed, but equally it might just be for a specific Umbraco project. |
@LottePitcher the rename of the dotnet new template makes total sense to me. |
@warrenbuckley I think the tooling setup (Vite etc) is still a good idea as it gets you started a good way, and it's the approach that backend devs with less front-end experience will need more help with. I don't think anyone would recommend using VanillaJS unless you were just building something incredibly simple. |
As this will only scaffold an extension and not other bits for a package such as Nuget, Github Actions & other things needed to be done to ship out a package
… can differ between Windows, Linux/OSX
Will allow us to ignore the folder if or when doing a dotnet pack with a rule in CSProj
…sion for completions in VSCode
@umbraco/packages-team take a look at this PR please gang |
I would also appreciate any opinions from the front end gang @leekelleher @nielslyngsoe @madsrasmussen @iOvergaard as well to ensure this is a-okay or needs stuff doing. |
…n with the --name
Should be .json not a .ts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jemayn and I have been looking at this today. Other than what we've put in this review we think it's good to go!
Co-authored-by: Lotte Pitcher <[email protected]>
Sets a default value of https://localhost:5000 We have no way of knowing what URL/domain the site is running at for the Umbraco website project
Checks if it can connect to it first and prompts user to ensure Umbraco site running or perhaps they need to change the URL in package.json for the node script
…renbuckley/Umbraco-CMS into v15/dotnet-package-bellisima
…ore examples based on switch/flag
safeNamespace uses the one built in and then safeName, depends on the cleaned namespace to then use a custom transform (forms) to then use a regex replace on . and _ to ensure we have a nicer name still for namespaces, class names, URL/routes for the swagger etc...
Just putting a note here that I'm currently working on this template so hold off on any reviews right now please! |
…ig\readme.md for 'placeholder' guidance
Summary
umbraco-package
toumbraco-extension
This PR is to rework & reopen the work that @leekelleher done from the previous years community teams day
#14975
Install Command
dotnet new install umbraco-extension --name TestingProject
Example usage