Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 19 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,42 @@

## Installation

* `git clone <repository-url>`
* `cd ember-headless-form`
* `pnpm install`
- `git clone git@github.com:universal-ember/form.git`
- `cd form`
- `pnpm install`

## Linting

* `pnpm lint`
* `pnpm lint:fix`
- `pnpm lint`
- `pnpm lint:fix`

## Developing

To develop in this monorepo you can simply run:

* `pnpm start`
- `pnpm start`

from the root directory.

This will:

* Build all of the `packages/*` and watch them for changes
* Build the docs app and the tests app and serve them
* Automatically sync changes from the `packages/*` to the served apps so
that they are always up to date.
- Build all of the `packages/*` and watch them for changes
- Serve the docs app and the test app (vite dev servers, ports printed on boot)

You can now visit:
If you only need one of the apps:

* The docs app at http://localhost:4201/
* The tests app at http://localhost:4202/tests

If you don't need to run both apps you can save a little of your local
compute by running:

* `start:docs-app` and visiting http://localhost:4201/
* `start:test-app` and visiting http://localhost:4202/tests

These commands will still build and watch the `packages/*` and sync changes
to the running app. Don't run both `only` tasks together as this will cause
issues - if you want to run both apps simply use `pnpm start`.
- `pnpm start:docs-app`
- `pnpm start:test-app`

## Running tests

You can run the tests with the following commands:
- `pnpm test`

Scenario testing (other Ember versions) uses [@embroider/try](https://github.com/embroider-build/embroider):

* `pnpm test`
* `pnpm test:docs`
- `cd test-app`
- `pnpm dlx @embroider/try apply ember-lts-5.12`
- `pnpm install --no-lockfile` (from the repo root)
- `pnpm turbo test --force`

For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
See `test-app/.try.mjs` for the available scenarios.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# @universal-ember/form
# @universal-ember/form

[![CI](https://github.com/universal-ember/form/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/universal-ember/form/actions/workflows/ci.yml)


The Ember.js addon that distills the common behavior and accessibility best practices of forms into reusable components, without any opinions on specific markup or styling. Use it to build your forms directly, or to build your opinionated forms component kit on top of it.
The Ember.js library that distills the common behavior and accessibility best practices of forms into reusable components, without any opinions on specific markup or styling. Use it to build your forms directly, or to build your opinionated forms component kit on top of it.

## Key Features

Expand All @@ -13,23 +12,22 @@ The Ember.js addon that distills the common behavior and accessibility best prac
- Optional ready-to-use integrations for `ember-changeset` and `yup` based validation
- Support for async state
- TypeScript / Glint support with tight types
- Octane-based v2 addon
- Fully tested

## Compatibility

- Ember.js v4.4 or above
- Embroider or ember-auto-import v2
- Ember.js v4.4 or above (CI-verified on v5.8+)
- a modern (vite) app, or a classic build via ember-auto-import v2 / Embroider

## Installation

```
ember install ember-headless-form
pnpm add @universal-ember/form
```

## Usage

Visit our [documentation website](https://ember-headless-form.pages.dev/).
Visit our [documentation website](https://ue-form.pages.dev/).

## Contributing

Expand Down
16 changes: 10 additions & 6 deletions packages/changeset/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# ember-headless-form-changeset
# @universal-ember/form-changeset

Integrates [`ember-changeset`](https://github.com/poteto/ember-changeset) and optionally [`ember-changeset-validations`](https://github.com/poteto/ember-changeset-validations/) seamlessly with the validation support of [ember-headless-form](https://github.com/CrowdStrike/ember-headless-form).
Integrates [`ember-changeset`](https://github.com/poteto/ember-changeset) and optionally [`ember-changeset-validations`](https://github.com/poteto/ember-changeset-validations/) seamlessly with the validation support of [@universal-ember/form](https://github.com/universal-ember/form).

## Compatibility

- Ember.js v4.4 or above
- Embroider or ember-auto-import v2
- Ember.js v4.4 or above (CI-verified on v5.8+)
- a modern (vite) app, or a classic build via ember-auto-import v2 / Embroider

## Installation

```
ember install ember-headless-form-changeset
pnpm add @universal-ember/form-changeset
```

## Usage

Visit our [documentation website](https://ember-headless-form.pages.dev/).
Visit our [documentation website](https://ue-form.pages.dev/).

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

## Credits

Originally from [CrowdStrike's ember-headless-form](https://github.com/crowdstrike/ember-headless-form)

## License

This project is licensed under the [MIT License](LICENSE.md).
6 changes: 5 additions & 1 deletion packages/changeset/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
"keywords": [
"ember-addon"
],
"repository": "https://github.com/CrowdStrike/@universal-ember/form.git",
"repository": {
"type": "git",
"url": "https://github.com/universal-ember/form.git",
"directory": "packages/changeset"
},
"license": "MIT",
"author": "CrowdStrike UX Team",
"files": [
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
{
"name": "@universal-ember/form",
"version": "1.1.1",
"description": "The default blueprint for Embroider v2 addons.",
"description": "The Ember.js library that distills the common behavior and accessibility best practices of forms into reusable components, without any opinions on specific markup or styling",
"keywords": [
"ember-addon"
],
"repository": "https://github.com/CrowdStrike/@universal-ember/form.git",
"repository": {
"type": "git",
"url": "https://github.com/universal-ember/form.git",
"directory": "packages/form"
},
"license": "MIT",
"author": "CrowdStrike UX Team",
"files": [
Expand Down
File renamed without changes.
File renamed without changes.
16 changes: 10 additions & 6 deletions packages/yup/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# ember-headless-form-yup
# @universal-ember/form-yup

Integrates [`yup`](https://github.com/jquense/yup) based schemas seamlessly with the validation support of [ember-headless-form](https://github.com/CrowdStrike/ember-headless-form).
Integrates [`yup`](https://github.com/jquense/yup) based schemas seamlessly with the validation support of [@universal-ember/form](https://github.com/universal-ember/form).

## Compatibility

- Ember.js v4.4 or above
- Embroider or ember-auto-import v2
- Ember.js v4.4 or above (CI-verified on v5.8+)
- a modern (vite) app, or a classic build via ember-auto-import v2 / Embroider

## Installation

```
ember install ember-headless-form-yup
pnpm add @universal-ember/form-yup
```

## Usage

Visit our [documentation website](https://ember-headless-form.pages.dev/).
Visit our [documentation website](https://ue-form.pages.dev/).

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

## Credits

Originally from [CrowdStrike's ember-headless-form](https://github.com/crowdstrike/ember-headless-form)

## License

This project is licensed under the [MIT License](LICENSE.md).
6 changes: 5 additions & 1 deletion packages/yup/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
"keywords": [
"ember-addon"
],
"repository": "https://github.com/CrowdStrike/@universal-ember/form.git",
"repository": {
"type": "git",
"url": "https://github.com/universal-ember/form.git",
"directory": "packages/yup"
},
"license": "MIT",
"author": "CrowdStrike UX Team",
"files": [
Expand Down
32 changes: 16 additions & 16 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading