Skip to content
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

Prepare to publish 0.1.0! #116

Merged
merged 8 commits into from
May 22, 2024
Merged

Prepare to publish 0.1.0! #116

merged 8 commits into from
May 22, 2024

Conversation

eyelidlessness
Copy link
Member

@eyelidlessness eyelidlessness commented May 16, 2024

Closes #50. Closes #99. (We decided to go ahead and publish 0.1.0, and address Changesets afterward.)

  • Also fix a few copypasta mistakes spotted along the way (references to the wrong package in e.g. README prose/instructions/examples, for the most part)

  • Apply any applicable auto-formatting (i.e. changes were applied per file and saved so VSCode would apply the appropriate formatting). Note that this has a greater effect in .vue modules, e.g. stripping a bunch of trailing whitespace that hadn’t already been, adding EOF newlines, etc.

  • Rewrap some text (.md files) and code comments. This was not done automatically on save, it’s a manual command I currently run while editing. As such, I may have missed some, but I tried my best not to leave any new formatting weirdness.

  • Specifies additional criteria for invalidating the install cache in CI. Hopefully this addresses the failure that occurred on the first commit!

  • Excludes xforms-engine generated API docs from lint. This didn't affect CI, but keeps showing up locally, and showed up again while investigating the CI failure.

Also note that there is one remaining reference to the text “odk-web-forms”: this is an older directory name (before we split xforms-engine and ui-solid packages), in a GitHub permalink, so it’s correct.

@eyelidlessness eyelidlessness marked this pull request as draft May 16, 2024 16:28
@eyelidlessness eyelidlessness force-pushed the chore/npm-scope-getodk branch from 492c97b to 6a5cdac Compare May 16, 2024 17:45
@eyelidlessness eyelidlessness marked this pull request as ready for review May 16, 2024 17:51
@eyelidlessness eyelidlessness mentioned this pull request May 16, 2024
12 tasks
@eyelidlessness eyelidlessness changed the title Rename @odk-web-forms NPM scope to @getodk Rename @odk-web-forms NPM scope to @getodk, ui-vue to web-forms May 22, 2024
@eyelidlessness eyelidlessness force-pushed the chore/npm-scope-getodk branch from 7f5cf92 to 4fbe91c Compare May 22, 2024 19:18
@eyelidlessness eyelidlessness force-pushed the chore/npm-scope-getodk branch from 64e3689 to 5aafe4c Compare May 22, 2024 19:47
@eyelidlessness eyelidlessness changed the title Rename @odk-web-forms NPM scope to @getodk, ui-vue to web-forms Prepare to publish 0.1.0! May 22, 2024
In so doing:

- Also fix a few copypasta mistakes spotted along the way (references to the wrong package, for the most part)
- Apply any applicable auto-formatting (i.e. changes were applied per file and saved so VSCode would apply the appropriate formatting). Note that this has a greater effect in .vue modules, e.g. stripping a bunch of trailing whitespace that hadn’t already been, adding EOF newlines, etc. - Rewrap some text (in .md files) and code comments. This was not done automatically on save, it’s something I currently do while editing comments. As such, I may have missed some, but I tried my best not to leave any new comment formatting weirdness.

Also note that there is one remaining reference to the text “odk-web-forms”: this is an older directory name (before we split `xforms-engine` and `ui-solid` packages), in a GitHub permalink, so it’s correct.
This doesn’t affect failure in CI, but it showed up locally while investigating that.
As decided in this week’s team meetings:

- We expect this to be our canonical (first-party) client for filling forms.
- It will also be the source package for a custom element wrapper (which will also be built with the underlying Vue UI implementation, but won’t require Vue in host applications).
- While we may continue to maintain `ui-solid`, that primarily serves internal purposes for now. We don’t **currently** anticipate providing multiple framework-specific UIs in tandem.
- ODK web forms -> ODK Web Forms
- web forms -> forms (where it isn’t a reference to the project)

There are a few other references in code comments which are left as-is to avoid adding noise to those source files. We can update them as appropriate.
@eyelidlessness eyelidlessness force-pushed the chore/npm-scope-getodk branch from 5aafe4c to 43c46ff Compare May 22, 2024 19:52
@sadiqkhoja
Copy link
Contributor

Apply any applicable auto-formatting

I ran yarn format on main branch, nothing was changed except LICENSE.md and README.md. Even without --cache flag, nothing changes in ui-vue package. Maybe there is some discrepancy between vscode and prettier formatting.

This is just an observation, no action is required for now.

Copy link
Contributor

@sadiqkhoja sadiqkhoja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@eyelidlessness eyelidlessness merged commit f3046fe into main May 22, 2024
70 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Getting ready to publish Decide on npm scopes and package names
2 participants