From 4fbe91c3d78e4c32e705e97f44f98d995149a0e2 Mon Sep 17 00:00:00 2001 From: eyelidlessness Date: Wed, 22 May 2024 11:52:26 -0700 Subject: [PATCH] Rename `ui-vue` package to `web-forms` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- .github/ISSUE_TEMPLATE.md | 6 +++--- .github/workflows/ci.yml | 10 +++++----- README.md | 9 ++------- eslint.config.js | 12 ++++++------ packages/ui-solid/README.md | 4 ++-- packages/{ui-vue => web-forms}/README.md | 6 +++--- packages/{ui-vue => web-forms}/e2e/tsconfig.json | 0 packages/{ui-vue => web-forms}/e2e/vue.test.ts | 0 packages/{ui-vue => web-forms}/env.d.ts | 0 packages/{ui-vue => web-forms}/icomoon.json | 0 packages/{ui-vue => web-forms}/index.html | 0 packages/{ui-vue => web-forms}/package.json | 4 ++-- packages/{ui-vue => web-forms}/playwright.config.ts | 0 packages/{ui-vue => web-forms}/public/favicon.ico | Bin .../{ui-vue => web-forms}/src/OdkWebFormDemo.vue | 0 .../{ui-vue => web-forms}/src/WebFormsPlugin.ts | 0 packages/{ui-vue => web-forms}/src/assets/.gitkeep | 0 .../src/assets/css/icomoon.css | 0 .../{ui-vue => web-forms}/src/assets/css/style.scss | 0 .../src/assets/fonts/LICENSE-2.0.txt | 0 .../src/assets/fonts/icomoon.svg | 0 .../src/assets/fonts/icomoon.ttf | Bin .../src/assets/fonts/icomoon.woff | Bin .../src/components/ControlLabel.vue | 0 .../src/components/FormGroup.vue | 0 .../src/components/FormHeader.vue | 0 .../src/components/FormLanguageMenu.vue | 0 .../src/components/FormPanel.vue | 0 .../src/components/FormQuestion.vue | 0 .../src/components/OdkWebForm.vue | 0 .../src/components/QuestionList.vue | 0 .../src/components/RepeatInstance.vue | 0 .../src/components/RepeatRange.vue | 0 .../src/components/controls/InputText.vue | 0 .../src/components/controls/SelectControl.vue | 0 .../src/components/controls/UnsupportedControl.vue | 0 packages/{ui-vue => web-forms}/src/demo.ts | 0 packages/{ui-vue => web-forms}/src/index.ts | 0 .../src/themes/2024-light/theme.scss | 0 .../tests/components/ControlLabel.test.ts | 0 .../tests/components/FormHeader.test.ts | 0 .../tests/components/FormLanguageMenu.test.ts | 0 .../tests/components/FormPanel.test.ts | 0 .../tests/components/FormQuestion.test.ts | 0 .../tests/components/RepeatRange.test.ts | 0 .../tests/components/SelectControl.test.ts | 0 packages/{ui-vue => web-forms}/tests/helpers.ts | 0 packages/{ui-vue => web-forms}/tsconfig.app.json | 0 packages/{ui-vue => web-forms}/tsconfig.json | 0 packages/{ui-vue => web-forms}/tsconfig.node.json | 0 packages/{ui-vue => web-forms}/tsconfig.vitest.json | 0 packages/{ui-vue => web-forms}/vite.config.ts | 0 packages/{ui-vue => web-forms}/vitest.config.ts | 0 packages/xforms-engine/README.md | 2 +- packages/xforms-engine/src/index.ts | 9 +++++---- turbo.json | 2 +- 56 files changed, 30 insertions(+), 34 deletions(-) rename packages/{ui-vue => web-forms}/README.md (96%) rename packages/{ui-vue => web-forms}/e2e/tsconfig.json (100%) rename packages/{ui-vue => web-forms}/e2e/vue.test.ts (100%) rename packages/{ui-vue => web-forms}/env.d.ts (100%) rename packages/{ui-vue => web-forms}/icomoon.json (100%) rename packages/{ui-vue => web-forms}/index.html (100%) rename packages/{ui-vue => web-forms}/package.json (97%) rename packages/{ui-vue => web-forms}/playwright.config.ts (100%) rename packages/{ui-vue => web-forms}/public/favicon.ico (100%) rename packages/{ui-vue => web-forms}/src/OdkWebFormDemo.vue (100%) rename packages/{ui-vue => web-forms}/src/WebFormsPlugin.ts (100%) rename packages/{ui-vue => web-forms}/src/assets/.gitkeep (100%) rename packages/{ui-vue => web-forms}/src/assets/css/icomoon.css (100%) rename packages/{ui-vue => web-forms}/src/assets/css/style.scss (100%) rename packages/{ui-vue => web-forms}/src/assets/fonts/LICENSE-2.0.txt (100%) rename packages/{ui-vue => web-forms}/src/assets/fonts/icomoon.svg (100%) rename packages/{ui-vue => web-forms}/src/assets/fonts/icomoon.ttf (100%) rename packages/{ui-vue => web-forms}/src/assets/fonts/icomoon.woff (100%) rename packages/{ui-vue => web-forms}/src/components/ControlLabel.vue (100%) rename packages/{ui-vue => web-forms}/src/components/FormGroup.vue (100%) rename packages/{ui-vue => web-forms}/src/components/FormHeader.vue (100%) rename packages/{ui-vue => web-forms}/src/components/FormLanguageMenu.vue (100%) rename packages/{ui-vue => web-forms}/src/components/FormPanel.vue (100%) rename packages/{ui-vue => web-forms}/src/components/FormQuestion.vue (100%) rename packages/{ui-vue => web-forms}/src/components/OdkWebForm.vue (100%) rename packages/{ui-vue => web-forms}/src/components/QuestionList.vue (100%) rename packages/{ui-vue => web-forms}/src/components/RepeatInstance.vue (100%) rename packages/{ui-vue => web-forms}/src/components/RepeatRange.vue (100%) rename packages/{ui-vue => web-forms}/src/components/controls/InputText.vue (100%) rename packages/{ui-vue => web-forms}/src/components/controls/SelectControl.vue (100%) rename packages/{ui-vue => web-forms}/src/components/controls/UnsupportedControl.vue (100%) rename packages/{ui-vue => web-forms}/src/demo.ts (100%) rename packages/{ui-vue => web-forms}/src/index.ts (100%) rename packages/{ui-vue => web-forms}/src/themes/2024-light/theme.scss (100%) rename packages/{ui-vue => web-forms}/tests/components/ControlLabel.test.ts (100%) rename packages/{ui-vue => web-forms}/tests/components/FormHeader.test.ts (100%) rename packages/{ui-vue => web-forms}/tests/components/FormLanguageMenu.test.ts (100%) rename packages/{ui-vue => web-forms}/tests/components/FormPanel.test.ts (100%) rename packages/{ui-vue => web-forms}/tests/components/FormQuestion.test.ts (100%) rename packages/{ui-vue => web-forms}/tests/components/RepeatRange.test.ts (100%) rename packages/{ui-vue => web-forms}/tests/components/SelectControl.test.ts (100%) rename packages/{ui-vue => web-forms}/tests/helpers.ts (100%) rename packages/{ui-vue => web-forms}/tsconfig.app.json (100%) rename packages/{ui-vue => web-forms}/tsconfig.json (100%) rename packages/{ui-vue => web-forms}/tsconfig.node.json (100%) rename packages/{ui-vue => web-forms}/tsconfig.vitest.json (100%) rename packages/{ui-vue => web-forms}/vite.config.ts (100%) rename packages/{ui-vue => web-forms}/vitest.config.ts (100%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index cf5370aa9..3ca4dab0e 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ - -#### Web Forms version and package (e.g. are you using `ui-vue` or only the engine?) +#### Web Forms version and package (e.g. are you using `web-forms` or only the engine?) #### Browser and version @@ -22,6 +22,6 @@ Feature suggestions should be described [in the forum Features category](https:/ #### Expected behavior -#### Other information +#### Other information Things you tried, stack traces, related issues, suggestions on how to fix it... diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dc80ab13e..534f77332 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -487,8 +487,8 @@ jobs: - if: ${{ matrix.target == 'Web' }} run: 'yarn workspace @getodk/ui-solid test-browser:${{ matrix.browser }}' - ui-vue: - name: '@getodk/ui-vue' + web-forms: + name: '@getodk/web-forms' needs: ['install-and-build'] runs-on: 'ubuntu-latest' @@ -540,13 +540,13 @@ jobs: fail-on-cache-miss: true - if: ${{ matrix.target == 'Node' }} - run: 'yarn workspace @getodk/ui-vue test:types' + run: 'yarn workspace @getodk/web-forms test:types' - if: ${{ matrix.target == 'Node' }} - run: 'yarn workspace @getodk/ui-vue test-node:jsdom' + run: 'yarn workspace @getodk/web-forms test-node:jsdom' - if: ${{ matrix.target == 'Web' }} run: 'yarn playwright install ${{ matrix.browser }} --with-deps' - if: ${{ matrix.target == 'Web' }} - run: 'yarn workspace @getodk/ui-vue test-browser:${{ matrix.browser }}' + run: 'yarn workspace @getodk/web-forms test-browser:${{ matrix.browser }}' diff --git a/README.md b/README.md index deab7f492..298458929 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,18 @@ # ODK Web Forms -With ODK Web Forms, you can define forms with powerful logic using the spreadsheet-based [XLSForm standard](https://docs.getodk.org/xlsform/). Use [our Vue-based frontend](/packages/ui-vue/) or build your own user experience around [the engine](/packages/xforms-engine/)! +With ODK Web Forms, you can define forms with powerful logic using the spreadsheet-based [XLSForm standard](https://docs.getodk.org/xlsform/). Use [our Vue-based frontend](/packages/web-forms/) or build your own user experience around [the engine](/packages/xforms-engine/)! > [!IMPORTANT] > ODK Web Forms is currently pre-release. We don't yet guarantee that its interfaces are stable and it is missing many features that are available in XLSForm form definitions. - - - https://github.com/getodk/web-forms/assets/447837/9b25e1bc-d209-462c-8e9e-3259bd8c5aa6 - - ## Packages > [!NOTE] > Comprehensive usage and development instructions are coming soon! For now, you can see each package's README. Please be sure to run `yarn` commands from the project root. -- [ui-vue](/packages/ui-vue): form-filling frontend built with Vue +- [web-forms](/packages/web-forms): form-filling frontend built with Vue - [xforms-engine](/packages/xforms-engine): implementation of the [ODK XForms specification](https://getodk.github.io/xforms-spec/) - [xpath](/packages/xpath): XPath evaluator with ODK XForms extensions - [scenario](/packages/scenario): engine client used to express tests on forms diff --git a/eslint.config.js b/eslint.config.js index 0677d06f7..f34784353 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -83,7 +83,7 @@ const vueGlob = (pathSansExtensions) => { return extensionsGlob(pathSansExtensions, vueFileExtensions); }; -const vuePackageGlob = vueGlob('packages/ui-vue/**/*'); +const vuePackageGlob = vueGlob('packages/web-forms/**/*'); /** * @typedef {import('eslint').Linter.FlatConfig} FlatConfig @@ -132,7 +132,7 @@ export default tseslint.config( /** * For future reference, there's a **lot** going on here. As briefly as - * reasonably possible, all of this happens for the `ui-vue` package: + * reasonably possible, all of this happens for the `web-forms` package: * * 1. ESLint uses the Vue parser (`vue-eslint-parser`) * 2. The Vue parser, in turn, uses the TypeScript parser @@ -275,10 +275,10 @@ export default tseslint.config( // Vue's project template does a great job of illustrating the use, // and I suspect we'd benefit from applying the pattern throughout the // entire monorepo. - './packages/ui-vue/tsconfig.json', - './packages/ui-vue/tsconfig.app.json', - './packages/ui-vue/tsconfig.node.json', - './packages/ui-vue/tsconfig.vitest.json', + './packages/web-forms/tsconfig.json', + './packages/web-forms/tsconfig.app.json', + './packages/web-forms/tsconfig.node.json', + './packages/web-forms/tsconfig.vitest.json', './scripts/tsconfig.json', ], diff --git a/packages/ui-solid/README.md b/packages/ui-solid/README.md index 2d92b4e6d..ba6580875 100644 --- a/packages/ui-solid/README.md +++ b/packages/ui-solid/README.md @@ -3,7 +3,7 @@ A [Solid](https://www.solidjs.com/) UI for ODK web forms; currently a reference client of [`@getodk/xforms-engine`][xforms-engine]. > [!NOTE] -> The future of this package is unclear! Its current state reflects an early spike/prototyping effort to explore viability of the ODK web forms project. As development of the project proceeds overall, it is likely that the [Vue client](../ui-vue/) will be be more mature and actively developed. +> The future of this package is unclear! Its current state reflects an early spike/prototyping effort to explore viability of the ODK web forms project. As development of the project proceeds overall, it is likely that the [Vue client](../web-forms/) will be be more mature and actively developed. ## Install @@ -61,4 +61,4 @@ This structure is mostly an aspirational attempt at conveying a sense of where a - Node (current/LTS; tested with [jsdom](https://github.com/jsdom/jsdom)). Server-side rendering of forms is not presently supported or targeted beyond testing, though it may be considered in the future. Inclusion of Node in the automated test suites helps us to keep this option open. [xforms-engine]: ../xforms-engine/ -[vue-client]: ../ui-vue/ +[vue-client]: ../web-forms/ diff --git a/packages/ui-vue/README.md b/packages/web-forms/README.md similarity index 96% rename from packages/ui-vue/README.md rename to packages/web-forms/README.md index 35d0ea7e5..406a78729 100644 --- a/packages/ui-vue/README.md +++ b/packages/web-forms/README.md @@ -1,4 +1,4 @@ -# @getodk/ui-vue +# @getodk/web-forms This is a Vue component library that uses [`@getodk/xforms-engine`](../xforms-engine/) to render ODK XForms. @@ -6,7 +6,7 @@ This is a Vue component library that uses [`@getodk/xforms-engine`](../xforms-en To use this library in a Vue.js application: -1. Import `@getodk/ui-vue` as a dependency in the application +1. Import `@getodk/web-forms` as a dependency in the application 2. Install the exported plugin by adding app.use(WebFormsPlugin) in entry component (usually App.vue) 3. Add the exported component anywhere in the application: @@ -28,7 +28,7 @@ Plugin is there to initialize PrimeVue, currently it exposes no options. In futu To run in development, run this command at the monorepo root: ```sh -yarn workspace @getodk/ui-vue dev +yarn workspace @getodk/web-forms dev ``` Individual test environments, and their corresponding watch modes, also have separate commands which can be found in [`package.json`](./package.json). diff --git a/packages/ui-vue/e2e/tsconfig.json b/packages/web-forms/e2e/tsconfig.json similarity index 100% rename from packages/ui-vue/e2e/tsconfig.json rename to packages/web-forms/e2e/tsconfig.json diff --git a/packages/ui-vue/e2e/vue.test.ts b/packages/web-forms/e2e/vue.test.ts similarity index 100% rename from packages/ui-vue/e2e/vue.test.ts rename to packages/web-forms/e2e/vue.test.ts diff --git a/packages/ui-vue/env.d.ts b/packages/web-forms/env.d.ts similarity index 100% rename from packages/ui-vue/env.d.ts rename to packages/web-forms/env.d.ts diff --git a/packages/ui-vue/icomoon.json b/packages/web-forms/icomoon.json similarity index 100% rename from packages/ui-vue/icomoon.json rename to packages/web-forms/icomoon.json diff --git a/packages/ui-vue/index.html b/packages/web-forms/index.html similarity index 100% rename from packages/ui-vue/index.html rename to packages/web-forms/index.html diff --git a/packages/ui-vue/package.json b/packages/web-forms/package.json similarity index 97% rename from packages/ui-vue/package.json rename to packages/web-forms/package.json index 12fc91251..5d654f30f 100644 --- a/packages/ui-vue/package.json +++ b/packages/web-forms/package.json @@ -1,12 +1,12 @@ { - "name": "@getodk/ui-vue", + "name": "@getodk/web-forms", "version": "0.1.0-alpha.0", "description": "Currently a stub/strawman project, reflecting potential naming and structure discussed in https://github.com/getodk/web-forms/issues/40", "author": "getodk", "repository": { "type": "git", "url": "https://github.com/getodk/web-forms", - "directory": "packages/ui-vue" + "directory": "packages/web-forms" }, "bugs": "https://github.com/getodk/web-forms/issues", "homepage": "https://getodk.org/", diff --git a/packages/ui-vue/playwright.config.ts b/packages/web-forms/playwright.config.ts similarity index 100% rename from packages/ui-vue/playwright.config.ts rename to packages/web-forms/playwright.config.ts diff --git a/packages/ui-vue/public/favicon.ico b/packages/web-forms/public/favicon.ico similarity index 100% rename from packages/ui-vue/public/favicon.ico rename to packages/web-forms/public/favicon.ico diff --git a/packages/ui-vue/src/OdkWebFormDemo.vue b/packages/web-forms/src/OdkWebFormDemo.vue similarity index 100% rename from packages/ui-vue/src/OdkWebFormDemo.vue rename to packages/web-forms/src/OdkWebFormDemo.vue diff --git a/packages/ui-vue/src/WebFormsPlugin.ts b/packages/web-forms/src/WebFormsPlugin.ts similarity index 100% rename from packages/ui-vue/src/WebFormsPlugin.ts rename to packages/web-forms/src/WebFormsPlugin.ts diff --git a/packages/ui-vue/src/assets/.gitkeep b/packages/web-forms/src/assets/.gitkeep similarity index 100% rename from packages/ui-vue/src/assets/.gitkeep rename to packages/web-forms/src/assets/.gitkeep diff --git a/packages/ui-vue/src/assets/css/icomoon.css b/packages/web-forms/src/assets/css/icomoon.css similarity index 100% rename from packages/ui-vue/src/assets/css/icomoon.css rename to packages/web-forms/src/assets/css/icomoon.css diff --git a/packages/ui-vue/src/assets/css/style.scss b/packages/web-forms/src/assets/css/style.scss similarity index 100% rename from packages/ui-vue/src/assets/css/style.scss rename to packages/web-forms/src/assets/css/style.scss diff --git a/packages/ui-vue/src/assets/fonts/LICENSE-2.0.txt b/packages/web-forms/src/assets/fonts/LICENSE-2.0.txt similarity index 100% rename from packages/ui-vue/src/assets/fonts/LICENSE-2.0.txt rename to packages/web-forms/src/assets/fonts/LICENSE-2.0.txt diff --git a/packages/ui-vue/src/assets/fonts/icomoon.svg b/packages/web-forms/src/assets/fonts/icomoon.svg similarity index 100% rename from packages/ui-vue/src/assets/fonts/icomoon.svg rename to packages/web-forms/src/assets/fonts/icomoon.svg diff --git a/packages/ui-vue/src/assets/fonts/icomoon.ttf b/packages/web-forms/src/assets/fonts/icomoon.ttf similarity index 100% rename from packages/ui-vue/src/assets/fonts/icomoon.ttf rename to packages/web-forms/src/assets/fonts/icomoon.ttf diff --git a/packages/ui-vue/src/assets/fonts/icomoon.woff b/packages/web-forms/src/assets/fonts/icomoon.woff similarity index 100% rename from packages/ui-vue/src/assets/fonts/icomoon.woff rename to packages/web-forms/src/assets/fonts/icomoon.woff diff --git a/packages/ui-vue/src/components/ControlLabel.vue b/packages/web-forms/src/components/ControlLabel.vue similarity index 100% rename from packages/ui-vue/src/components/ControlLabel.vue rename to packages/web-forms/src/components/ControlLabel.vue diff --git a/packages/ui-vue/src/components/FormGroup.vue b/packages/web-forms/src/components/FormGroup.vue similarity index 100% rename from packages/ui-vue/src/components/FormGroup.vue rename to packages/web-forms/src/components/FormGroup.vue diff --git a/packages/ui-vue/src/components/FormHeader.vue b/packages/web-forms/src/components/FormHeader.vue similarity index 100% rename from packages/ui-vue/src/components/FormHeader.vue rename to packages/web-forms/src/components/FormHeader.vue diff --git a/packages/ui-vue/src/components/FormLanguageMenu.vue b/packages/web-forms/src/components/FormLanguageMenu.vue similarity index 100% rename from packages/ui-vue/src/components/FormLanguageMenu.vue rename to packages/web-forms/src/components/FormLanguageMenu.vue diff --git a/packages/ui-vue/src/components/FormPanel.vue b/packages/web-forms/src/components/FormPanel.vue similarity index 100% rename from packages/ui-vue/src/components/FormPanel.vue rename to packages/web-forms/src/components/FormPanel.vue diff --git a/packages/ui-vue/src/components/FormQuestion.vue b/packages/web-forms/src/components/FormQuestion.vue similarity index 100% rename from packages/ui-vue/src/components/FormQuestion.vue rename to packages/web-forms/src/components/FormQuestion.vue diff --git a/packages/ui-vue/src/components/OdkWebForm.vue b/packages/web-forms/src/components/OdkWebForm.vue similarity index 100% rename from packages/ui-vue/src/components/OdkWebForm.vue rename to packages/web-forms/src/components/OdkWebForm.vue diff --git a/packages/ui-vue/src/components/QuestionList.vue b/packages/web-forms/src/components/QuestionList.vue similarity index 100% rename from packages/ui-vue/src/components/QuestionList.vue rename to packages/web-forms/src/components/QuestionList.vue diff --git a/packages/ui-vue/src/components/RepeatInstance.vue b/packages/web-forms/src/components/RepeatInstance.vue similarity index 100% rename from packages/ui-vue/src/components/RepeatInstance.vue rename to packages/web-forms/src/components/RepeatInstance.vue diff --git a/packages/ui-vue/src/components/RepeatRange.vue b/packages/web-forms/src/components/RepeatRange.vue similarity index 100% rename from packages/ui-vue/src/components/RepeatRange.vue rename to packages/web-forms/src/components/RepeatRange.vue diff --git a/packages/ui-vue/src/components/controls/InputText.vue b/packages/web-forms/src/components/controls/InputText.vue similarity index 100% rename from packages/ui-vue/src/components/controls/InputText.vue rename to packages/web-forms/src/components/controls/InputText.vue diff --git a/packages/ui-vue/src/components/controls/SelectControl.vue b/packages/web-forms/src/components/controls/SelectControl.vue similarity index 100% rename from packages/ui-vue/src/components/controls/SelectControl.vue rename to packages/web-forms/src/components/controls/SelectControl.vue diff --git a/packages/ui-vue/src/components/controls/UnsupportedControl.vue b/packages/web-forms/src/components/controls/UnsupportedControl.vue similarity index 100% rename from packages/ui-vue/src/components/controls/UnsupportedControl.vue rename to packages/web-forms/src/components/controls/UnsupportedControl.vue diff --git a/packages/ui-vue/src/demo.ts b/packages/web-forms/src/demo.ts similarity index 100% rename from packages/ui-vue/src/demo.ts rename to packages/web-forms/src/demo.ts diff --git a/packages/ui-vue/src/index.ts b/packages/web-forms/src/index.ts similarity index 100% rename from packages/ui-vue/src/index.ts rename to packages/web-forms/src/index.ts diff --git a/packages/ui-vue/src/themes/2024-light/theme.scss b/packages/web-forms/src/themes/2024-light/theme.scss similarity index 100% rename from packages/ui-vue/src/themes/2024-light/theme.scss rename to packages/web-forms/src/themes/2024-light/theme.scss diff --git a/packages/ui-vue/tests/components/ControlLabel.test.ts b/packages/web-forms/tests/components/ControlLabel.test.ts similarity index 100% rename from packages/ui-vue/tests/components/ControlLabel.test.ts rename to packages/web-forms/tests/components/ControlLabel.test.ts diff --git a/packages/ui-vue/tests/components/FormHeader.test.ts b/packages/web-forms/tests/components/FormHeader.test.ts similarity index 100% rename from packages/ui-vue/tests/components/FormHeader.test.ts rename to packages/web-forms/tests/components/FormHeader.test.ts diff --git a/packages/ui-vue/tests/components/FormLanguageMenu.test.ts b/packages/web-forms/tests/components/FormLanguageMenu.test.ts similarity index 100% rename from packages/ui-vue/tests/components/FormLanguageMenu.test.ts rename to packages/web-forms/tests/components/FormLanguageMenu.test.ts diff --git a/packages/ui-vue/tests/components/FormPanel.test.ts b/packages/web-forms/tests/components/FormPanel.test.ts similarity index 100% rename from packages/ui-vue/tests/components/FormPanel.test.ts rename to packages/web-forms/tests/components/FormPanel.test.ts diff --git a/packages/ui-vue/tests/components/FormQuestion.test.ts b/packages/web-forms/tests/components/FormQuestion.test.ts similarity index 100% rename from packages/ui-vue/tests/components/FormQuestion.test.ts rename to packages/web-forms/tests/components/FormQuestion.test.ts diff --git a/packages/ui-vue/tests/components/RepeatRange.test.ts b/packages/web-forms/tests/components/RepeatRange.test.ts similarity index 100% rename from packages/ui-vue/tests/components/RepeatRange.test.ts rename to packages/web-forms/tests/components/RepeatRange.test.ts diff --git a/packages/ui-vue/tests/components/SelectControl.test.ts b/packages/web-forms/tests/components/SelectControl.test.ts similarity index 100% rename from packages/ui-vue/tests/components/SelectControl.test.ts rename to packages/web-forms/tests/components/SelectControl.test.ts diff --git a/packages/ui-vue/tests/helpers.ts b/packages/web-forms/tests/helpers.ts similarity index 100% rename from packages/ui-vue/tests/helpers.ts rename to packages/web-forms/tests/helpers.ts diff --git a/packages/ui-vue/tsconfig.app.json b/packages/web-forms/tsconfig.app.json similarity index 100% rename from packages/ui-vue/tsconfig.app.json rename to packages/web-forms/tsconfig.app.json diff --git a/packages/ui-vue/tsconfig.json b/packages/web-forms/tsconfig.json similarity index 100% rename from packages/ui-vue/tsconfig.json rename to packages/web-forms/tsconfig.json diff --git a/packages/ui-vue/tsconfig.node.json b/packages/web-forms/tsconfig.node.json similarity index 100% rename from packages/ui-vue/tsconfig.node.json rename to packages/web-forms/tsconfig.node.json diff --git a/packages/ui-vue/tsconfig.vitest.json b/packages/web-forms/tsconfig.vitest.json similarity index 100% rename from packages/ui-vue/tsconfig.vitest.json rename to packages/web-forms/tsconfig.vitest.json diff --git a/packages/ui-vue/vite.config.ts b/packages/web-forms/vite.config.ts similarity index 100% rename from packages/ui-vue/vite.config.ts rename to packages/web-forms/vite.config.ts diff --git a/packages/ui-vue/vitest.config.ts b/packages/web-forms/vitest.config.ts similarity index 100% rename from packages/ui-vue/vitest.config.ts rename to packages/web-forms/vitest.config.ts diff --git a/packages/xforms-engine/README.md b/packages/xforms-engine/README.md index 7a31e21a5..cdd460d6c 100644 --- a/packages/xforms-engine/README.md +++ b/packages/xforms-engine/README.md @@ -2,7 +2,7 @@ Implementation of the [ODK XForms specification](https://getodk.github.io/xforms-spec/)'s data model and computation logic. This package does not handle presentation or user interaction. Those aspects of web forms are meant to be handled by a client. Presently, those clients are: -- [`@getodk/ui-vue`](../ui-vue) +- [`@getodk/web-forms`](../web-forms) - [`@getodk/ui-solid`](../ui-solid) ## Install diff --git a/packages/xforms-engine/src/index.ts b/packages/xforms-engine/src/index.ts index c678148c1..60abdac06 100644 --- a/packages/xforms-engine/src/index.ts +++ b/packages/xforms-engine/src/index.ts @@ -24,10 +24,11 @@ export type { } from './client/hierarchy.ts'; export type * from './client/index.ts'; -// TODO: notwithstanding potential conflicts with parallel work on `ui-vue`, -// these are the last remaining references **outside of `xforms-engine`** to -// anything besides /client/* and the `initializeForm` entrypoint -// implementation. We'll refine the various `definition` types in due time. +// TODO: notwithstanding potential conflicts with parallel work on `web-forms` +// (former `ui-vue`), these are the last remaining references **outside of +// `xforms-engine`** to anything besides /client/* and the `initializeForm` +// entrypoint implementation. We'll refine the various `definition` types in due +// time. export type { AnySelectDefinition, SelectDefinition, diff --git a/turbo.json b/turbo.json index 26fd3ff78..8975ae440 100644 --- a/turbo.json +++ b/turbo.json @@ -16,7 +16,7 @@ "dependsOn": ["@getodk/xpath#build"], "outputs": ["dist/**"] }, - "@getodk/ui-vue#build": { + "@getodk/web-forms#build": { "dependsOn": ["@getodk/xforms-engine#build"], "outputs": ["dist/**"] },