Remaining work on packaging for publish.#11
Conversation
a03785b to
35f4570
Compare
|
Do you want this reviewed now? I am presuming you do not right this moment, but do request my review when you want it looked at. |
35f4570 to
6fc227f
Compare
6fc227f to
b1723cf
Compare
|
@conatus Sorry, missed that. No, I did not. Now I do! |
janbaykara
left a comment
There was a problem hiding this comment.
Not seeing anything wildly wrong here.
Occurred to me that there could be scope for including a django variant of Ruby-style import maps, for loading Stimulus controller files for templates, as an alternative to bundling them altogether.
Glad to see this publish soon!
docs/guides/getting-started.md
Outdated
| @@ -0,0 +1,8 @@ | |||
| Groundwork is distributed as a Python library [via PyPI](https://pypi.org/project/groundwork-django/). Frontend components are distibuted [via NPM](https://npmjs.org/package/groundwork-ui). | |||
There was a problem hiding this comment.
Maybe repeat the package slug groundwork-django here, for easy copy pasta? This could also be echoed in README.md. I note that groundwork is actually taken by another package, but that would have been my immediate guess.
There was a problem hiding this comment.
Good call. Updated.
We in fact kind of already have this behaviour by using dynamic This is also exposed as a utility to the application, which it can use to load its own controllers, and does by default in the starter template. It should be better documented though! In general, I haven't written anything on the stimulus side of the library. I'll make a task to do that. Using import maps could prove to be a more 'standard' way of providing this behaviour when the django hotwired libraries mature a bit. This is nice in that it doesn't impose any constraints on how the django app is configured though. |
Description
This PR:
ts-jestforbabel-jestbecause it didn't play nicely with some newer js features vite supports (import.meta)pyck->groundworkMotivation and Context
This library needs publishing before people can use it!
Was unsure about whether to tackle this now or defer it, but it'd be quite annoying to use without doing so – the npm package needs building before install and in practice so does the python package, as it includes a bunch of static js and css.
How Can It Be Tested?
Hard to fully test yourself because it involves a release hook on CI. I have done by temporarily switching the CI trigger to pull-request and running it on this.
Types of changes
Checklist: