@deckstar/final-form - npm Package Compare versions

Comparing version 1.0.8 to 1.0.9

package.json

 {
   "name": "@deckstar/final-form",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "🏁 Framework agnostic, high performance, subscription-based form state management",
@@ -26,10 +26,3 @@ "main": "dist/cjs",
   "homepage": "https://github.com/deckstar/final-form-ts#readme",
-  "devDependencies": {
-    "@types/node": "^16.10.1",
-    "doctoc": "^2.0.1"
-  },
-  "dependencies": {
-    "@babel/runtime": "^7.10.0"
-  },
-  "gitHead": "23da07361def9a5df324ad2a5bf32f06744ee808"
+  "gitHead": "4be4827b5168a4cb36b9a7b019d27943dd5d85a1"
 }

README.md

@@ -1,59 +0,38 @@
-[<img src="form-nerd-logo.png" align="left"/>](https://formnerd.co/final-form-readme) **You build great forms, but do you know HOW users use your forms? [Find out with Form Nerd!](https://formnerd.co/final-form-readme) Professional analytics from the creator of Final Form.**
+# final-form-ts
 
----
+## Introduction
 
-💰 **Hey there! Do you fancy yourself a javascript expert? [Take this quiz](https://triplebyte.com/a/V6j0KPS/ff) and get offers from top tech companies!** 💰
+> _Final Form TS_ is a subscription-based state-management library for building forms in JavaScript.
 
----
+## Acknowledgements
 
-# 🏁 Final Form
+Final Form TS is a fork of Erik Rasmussen's [Final Form](https://github.com/final-form/final-form), rewritten in TypeScript.
 
-[![Final Form](banner.png)](https://final-form.org)
+## Quick install
 
-[![Backers on Open Collective](https://opencollective.com/final-form/backers/badge.svg)](#backers)
-[![Sponsors on Open Collective](https://opencollective.com/final-form/sponsors/badge.svg)](#sponsors)
-[![NPM Version](https://img.shields.io/npm/v/final-form.svg?style=flat)](https://www.npmjs.com/package/final-form)
-[![NPM Downloads](https://img.shields.io/npm/dm/final-form.svg?style=flat)](https://npm-stat.com/charts.html?package=final-form)
-[![Build Status](https://travis-ci.org/final-form/final-form.svg?branch=main)](https://travis-ci.org/final-form/final-form)
-[![codecov.io](https://codecov.io/gh/final-form/final-form/branch/main/graph/badge.svg)](https://codecov.io/gh/final-form/final-form)
-[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+Pick the form package that you want and install it with the "@deckstar" prefix. For example:
 
-✅ **Zero** dependencies
+```bash
+yarn add @deckstar/final-form
+```
 
-✅ Framework agnostic
+The package is mostly compatible with the original `final-form` packages.
 
-✅ Opt-in subscriptions - only update on the state you need!
+```ts
+import { createForm } from "@deckstar/final-form"; // almost identical to the original final-form
+```
 
-✅ 💥 [**5.1k gzipped**](https://bundlephobia.com/result?p=final-form) 💥
+### Package alias
 
----
+If you wish to import packages with their original names (e.g. "final-form" rather than "@deckstar/final-form"), you must install the packages with an alias. Make sure to include the version! For example:
 
-[<img align="right" src="docs/sencha.svg" height="100"/>](https://www.sencha.com/)
+```bash
+yarn add final-form@npm:@deckstar/final-form@^1.0.0
+```
 
-### Final Form is sponsored by [Sencha](https://www.sencha.com/).
+This alias would allow you to import things with the same package name as the original package. This can be useful if you don't wish to rewrite imports throughout a project.
 
-Comprehensive JS framework and UI components for building enterprise-grade web apps.
-
----
-
-## 💬 [Give Feedback on Final Form](https://goo.gl/forms/dxdfxKNy64DLb99z2) 💬
-
-In the interest of making 🏁 Final Form the best library it can be, we'd love your thoughts and feedback.
-
-[Take a quick survey](https://goo.gl/forms/dxdfxKNy64DLb99z2).
-
----
-
-## [Get Started](https://final-form.org/docs/final-form/getting-started)
-
-## [Philosophy](https://final-form.org/docs/final-form/philosophy)
-
-## [Examples](https://final-form.org/docs/final-form/examples)
-
-## [API](https://final-form.org/docs/final-form/api)
-
-## [Companion Libraries](https://final-form.org/docs/final-form/companion-libraries)
-
-## [Who's using Final Form?](https://final-form.org/users)
-
-<img src="https://static.scarf.sh/a.png?x-pxid=40db3a4c-1187-4b9e-b363-c059774fe5e1" />
+```ts
+// import { createForm } from "@deckstar/final-form"; // won't work anymore
+import { createForm } from "final-form"; // works after adding the alias!
+```

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Dependency count

0

decreased by-100%

Dev dependency count

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

295863

decreased by-0.48%

Number of lines in readme file

39

decreased by-35%

Dependency changes

• - Removed@babel/runtime@^7.10.0

• - Removed@babel/runtime@7.26.0(transitive)

• - Removedregenerator-runtime@0.14.1(transitive)