chore(release): release version v2.0.0

.eslintignore

@@ -1,8 +1,11 @@
+deprecated
+packages/**/index.js
+packages/**/index.d.ts
+packages/**/dist/**/*
 node_modules/*
 coverage/*
 dist
 dist/*
-*.js
-*.d.ts
-index.ts
-jest.config.js
+jest.config.base.js
+commitlint.config.js
+jest.config.js

.eslintrc

@@ -1,7 +1,9 @@
 {
+  "root": true,
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "prettier"
+//    "prettier/@typescript-eslint"
   ],
   "parserOptions": {
     "ecmaVersion": 8
@@ -38,7 +40,6 @@
         "trailingComma": "es5"
       }
     ],
-    "react/forbid-prop-types": 0,
     "no-unused-expressions": 0,
     "one-var": 0,
     "no-underscore-dangle": [
@@ -60,6 +61,7 @@
     "lines-between-class-members": "off"
   },
   "env": {
+    "node": true,
     "jest": true
   }
 }

.github/workflows/pr-checks.yml

@@ -6,6 +6,7 @@ on:
   pull_request:
     branches:
       - master
+      - release
 
 jobs:
   build-and-test:
@@ -20,37 +21,37 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
 
-      - name: Get NPM Cache Directory Path
-        id: npm-cache-dir
-        run: echo "::set-output name=dir::$(npm config get cache)"
-
-      - name: Lint Commit Message
-        run: |
-          npm i -D @commitlint/config-conventional
-          echo $(git log -1 --pretty=format:"%s") | npx commitlint
+      - name: Get Yarn Cache Directory Path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
 
       - name: Use NodeJS ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: NPM CI
-        id: npm-cache
+      - name: Yarn Init
+        id: yarn-cache
         uses: actions/cache@v2
         with:
-          path: ${{ steps.npm-cache-dir.outputs.dir }}
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
-            ${{ runner.os }}-node-
+            ${{ runner.os }}-yarn-
+
+      - name: Lint Commit Message
+        run: |
+          yarn add -D -W @commitlint/config-conventional
+          echo $(git log -1 --pretty=format:"%s") | yarn commitlint
 
       - name: Lint Source
-        run: npm run lint
+        run: yarn lint-staged
 
       - name: Build
-        run: npm run build
+        run: yarn build
 
       - name: Test
-        run: npm run test:cov
+        run: yarn test:cov
 
       - name: Upload Report to Codecov
         uses: codecov/codecov-action@v1

.github/workflows/release.yml

@@ -2,9 +2,8 @@ name: Release
 on:
   push:
     branches:
-      - release
-      - alpha
-      - beta
+      - master
+
 jobs:
   main:
     name: Main
@@ -21,32 +20,28 @@ jobs:
         with:
           node-version: 14
 
-      - name: Install Dependecies
-        run: npm install
+      - name: Yarn Install Dependecies
+        run: yarn
 
       - name: Lint Commit Message
-        run: echo $(git log -1 --pretty=format:"%s") | npx commitlint
+        run: |
+          yarn add -D -W @commitlint/config-conventional
+          echo $(git log -1 --pretty=format:"%s") | yarn commitlint
 
       - name: Lint Source
-        run: npm run lint
+        run: yarn lint
 
       - name: Build
-        run: npm run build
+        run: yarn build
 
       - name: Test
-        run: npm run test:cov
+        run: yarn test:cov
 
       - name: Upload Report to Codecov
         uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           directory: ./coverage
-          fail_ci_if_error: true
+          fail_ci_if_error: false
           files: ./coverage/cobertura-coverage.xml
-          name: codecov-umbrella
-
-      - name: Release
-        run: npx semantic-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          name: codecov-umbrella

.gitignore

@@ -14,7 +14,7 @@ lerna-debug.log*
 .DS_Store
 
 # Tests
-/coverage
+coverage
 /sample/coverage
 /.nyc_output
 
@@ -38,3 +38,4 @@ lerna-debug.log*
 junit.xml
 .gitconfig
 .circleci
+!.husky

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged

README.md

@@ -1,16 +1,15 @@
 [![ISC license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 [![npm version](http://img.shields.io/npm/v/mockingbird-ts.svg?style=flat)](https://npmjs.org/package/mockingbird-ts "View this project on npm")
 [![Codecov Coverage](https://img.shields.io/codecov/c/github/omermorad/mockingbird-ts/master.svg?style=flat-square)](https://codecov.io/gh/omermorad/mockingbird-ts)
-[![Master](https://github.com/omermorad/mockingbird-ts/actions/workflows/release.yml/badge.svg?branch=release)](https://github.com/omermorad/mockingbird-ts/actions)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
 
 <p align="center">
   <img width="450" src="https://raw.githubusercontent.com/omermorad/mockingbird-ts/master/docs/logo.png" alt="Mockingbird Logo" />
 
   <h1 align="center">Mockingbird</h1>
 
   <h3 align="center">
-    Decorator Powered TypeScript Library for Creating Mocks
+    The First TypeScript Mocking Framework
   </h3>
 
   <h4 align="center">
@@ -19,10 +18,9 @@
 </p>
 
 ## Installation
-Install the package alongside `faker` and `@types/faker` peer dependencies:
 
 ```bash
-npm i mockingbird-ts faker @types/faker
+npm i -D mockingbird-ts
 ```
 
 ## Usage
@@ -35,58 +33,64 @@ import { Mock, MockFactory } from 'mockingbird-ts';
 class Dog {
   @Mock(faker => faker.name.firstName())
   readonly name: string;
-  
+
   @Mock()
   readonly birthday: Date; // Will generate a recent date
 
   @Mock()
   readonly goodPoints: number; // Will generate a random number
 }
 
-const result = MockFactory.create<Dog>(Dog);
+const oneDog = MockFactory(Dog).one();
+const lotsOfDogs = MockFactory(Dog).many(3);
 ```
 
 ## Documentation
 
 There are many more options that you can use with the `@Mock` decorator (and also the `MockFactory`). \
 [Click here to jump to the full documentation and explore the full API](https://github.com/omermorad/faker.ts/blob/master/docs/README.md)
 
-**Besides, we have also created a full working example for you; [you can find it under
-the sample folder](https://github.com/omermorad/mockingbird-ts/tree/master/sample)**
-
+**Besides, we have also created a full working example for
+you; [you can find it under the sample folder](https://github.com/omermorad/mockingbird-ts/tree/master/sample)**
 
 ## Playground
-**We have created a [REPL Playground](https://repl.it/@omermorad/Mockingbird-Playground) where you can see Mockingbird in action!**
+
+**We have created a [REPL Playground](https://repl.it/@omermorad/Mockingbird-Playground) where you can see Mockingbird
+in action!**
+
+## Use Cases
+ - Generate fake (but reasonable) data for your integration tests
+ - Prepare as many of different fixtures for your tests
+ - Persist the 
 
 ## Motivation
-When it comes to writing unit tests of large projects containing different and
-diverse entities, mocks are widely used to simulate real data.
 
-Creating mocks can be a tedious and cumbersome process and is usually created
-manually or by using libraries like Faker or Chance, which also do not offer a complete solution,
-especially not when deciding to develop in TypeScript and most of the code becomes object oriented.
+When it comes to writing tests of large projects containing different and diverse entities, mocks (sometimes called "
+fixtures") are widely used to simulate real data.
 
-Therefore, we thought of a convenient and efficient solution that allows the use
-of only one decorator, Mock decorator that allows to create mocks by placing it above the properties of the class.
+Creating mocks (or fixtures) can be a tedious and cumbersome process and is usually created manually or by using
+libraries like Faker or Chance, which also do not offer a complete solution, especially not when you write TypeScript
+only, and most of the code is object-oriented and arranged with classes.
 
-Mockingbird offers several options for creating mocks, including the use of the
-well-known library Faker, which allows you to create information such as a fake email, a fake username,
-a fake address and more.
+We came up with a simple (and efficient) yet super convenient solution: all you have to do to get fixtures out of the
+box is to decorate your classes (whether it's an entity, or a model representing the database layer) and generate simple
+or complex fixtures.
 
-### What is faker.js (aka Faker)?
-For those of you who are unfamiliar with `faker.js`, it is an old library written
-with pure JavaScript, which is used to "generate massive amounts of fake data in
-the browser and Node".
+Mockingbird offers several options for creating mocks, including the use of the well-known library Faker, which allows
+you to create data such as a fake email, a fake username, a fake address and more.u to create information such as a fake
+email, a fake username, a fake address and more.
 
-Fake data is usually needed for testing purposes, to assist in the development process itself,
-and sometimes, also for the purpose of demonstrations and training.
+### What is `faker.js` (aka Faker)?
 
-Mockingbird uses Faker under the hood and making it possible to use faker.js in
-a "TypeScript" way, and thereby allows to create mocks that are meaningful like
-email, first name, address and many more.
+For those of you who are unfamiliar with `faker.js`, it is a library which is used to "generate massive amounts of fake data in the browser and Node".
+
+Mockingbird uses `faker.js` under the hood, making it possible to use Faker in it's "TypeScript" way, and thereby allows
+to create mocks that are meaningful like email, first name, address and many more.
 
 ## License
+
 Distributed under the MIT License. See `LICENSE` for more information.
 
 ## Acknowledgements
+
 [faker.js](https://github.com/marak/Faker.js)

codecov.yml

@@ -0,0 +1,8 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 95%
+    patch:
+      default:
+        target: 95%

commitlint.config.js

@@ -0,0 +1,18 @@
+const {
+  utils: { getPackages },
+} = require('@commitlint/config-lerna-scopes');
+
+module.exports = {
+  extends: ['@commitlint/config-conventional', '@commitlint/config-lerna-scopes'],
+  rules: {
+    'scope-enum': async (ctx) => [
+      2,
+      'always',
+      [
+        ...(await getPackages(ctx)),
+        'release',
+        'repo',
+      ],
+    ],
+  },
+};