chore(init): init

Author: NetanelBasal

.prettierignore

@@ -0,0 +1,2 @@
+package.json
+dist

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to Transloco
+# Contributing to Forms Manager
 
-🙏 We would ❤️ for you to contribute to Transloco and help make it even better than it is today!
+🙏 We would ❤️ for you to contribute to Forms Manager and help make it even better than it is today!
 
 # Developing
 
@@ -14,7 +14,6 @@ Run the tests:
 
 ```bash
 npm test
-npm run e2e
 ```
 
 Run the playground app:

PULL_REQUEST_TEMPLATE.md

@@ -2,7 +2,7 @@
 
 Please check if your PR fulfills the following requirements:
 
-- [ ] The commit message follows our guidelines: https://github.com/ngneat/transloco/blob/master/CONTRIBUTING.md#commit
+- [ ] The commit message follows our guidelines: https://github.com/ngneat/forms-manager/blob/master/CONTRIBUTING.md#commit
 - [ ] Tests for the changes have been added (for bug fixes / features)
 - [ ] Docs have been added / updated (for bug fixes / features)
 

README.md

@@ -10,7 +10,7 @@
 [![coc-badge](https://img.shields.io/badge/codeof-conduct-ff69b4.svg?style=flat-square)]()
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e5079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
 
 <hr />
 
@@ -24,17 +24,19 @@ This is powerful, as it gives you the following abilities:
 
 The goal in creating this was to work with the existing Angular form ecosystem, and save you the trouble of learning a new API. Let’s see how it works:
 
+First, install the library:
+
+## Installation
+
+```
+npm i @ngenat/forms-manager
+```
+
+Then, create a component with a form:
+
 ```ts
 import { NgFormsManager } from '@ngneat/forms-manager';
 
-export interface FormsState {
-  onboarding: {
-    name: string;
-    age: number;
-    city: string;
-  };
-}
-
 @Component({
   template: `
    <form [formGroup]="onboardingForm">
@@ -46,7 +48,7 @@ export interface FormsState {
 })
 export class OnboardingComponent {
   constructor(
-    private formsManager: NgFormsManager<FormsState>,
+    private formsManager: NgFormsManager,
     private builder: FormBuilder
   ) {}
 

angular.json

@@ -22,13 +22,8 @@
             "main": "src/main.ts",
             "polyfills": "src/polyfills.ts",
             "tsConfig": "src/tsconfig.app.json",
-            "assets": [
-              "src/favicon.ico",
-              "src/assets"
-            ],
-            "styles": [
-              "src/styles.scss"
-            ],
+            "assets": ["src/favicon.ico", "src/assets"],
+            "styles": ["src/styles.scss"],
             "scripts": []
           },
           "configurations": {
@@ -82,26 +77,16 @@
             "polyfills": "src/polyfills.ts",
             "tsConfig": "src/tsconfig.spec.json",
             "karmaConfig": "src/karma.conf.js",
-            "styles": [
-              "src/styles.scss"
-            ],
+            "styles": ["src/styles.scss"],
             "scripts": [],
-            "assets": [
-              "src/favicon.ico",
-              "src/assets"
-            ]
+            "assets": ["src/favicon.ico", "src/assets"]
           }
         },
         "lint": {
           "builder": "@angular-devkit/build-angular:tslint",
           "options": {
-            "tsConfig": [
-              "src/tsconfig.app.json",
-              "src/tsconfig.spec.json"
-            ],
-            "exclude": [
-              "**/node_modules/**"
-            ]
+            "tsConfig": ["src/tsconfig.app.json", "src/tsconfig.spec.json"],
+            "exclude": ["**/node_modules/**"]
           }
         }
       }
@@ -127,13 +112,44 @@
           "builder": "@angular-devkit/build-angular:tslint",
           "options": {
             "tsConfig": "e2e/tsconfig.e2e.json",
-            "exclude": [
-              "**/node_modules/**"
-            ]
+            "exclude": ["**/node_modules/**"]
+          }
+        }
+      }
+    },
+    "@ngneat/forms-manager": {
+      "root": "projects/ngneat/forms-manager",
+      "sourceRoot": "projects/ngneat/forms-manager/src",
+      "projectType": "library",
+      "prefix": "lib",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-ng-packagr:build",
+          "options": {
+            "tsConfig": "projects/ngneat/forms-manager/tsconfig.lib.json",
+            "project": "projects/ngneat/forms-manager/ng-package.json"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/ngneat/forms-manager/src/test.ts",
+            "tsConfig": "projects/ngneat/forms-manager/tsconfig.spec.json",
+            "karmaConfig": "projects/ngneat/forms-manager/karma.conf.js"
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "projects/ngneat/forms-manager/tsconfig.lib.json",
+              "projects/ngneat/forms-manager/tsconfig.spec.json"
+            ],
+            "exclude": ["**/node_modules/**"]
           }
         }
       }
     }
   },
   "defaultProject": "ngneat-forms-manager"
-}
+}

commitlint.config.js

@@ -0,0 +1,7 @@
+/**
+ * To check all configuration options, please visit
+ * https://commitlint.js.org/#/reference-rules
+ */
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};