@fluentfixture/shared - npm Package Compare versions

Comparing version 1.0.6-alpha.3 to 1.0.6

package.json

 {
   "name": "@fluentfixture/shared",
   "description": "Shared utils of @fluentfixture project. Contains common string, date ,and type utilities.",
-  "version": "1.0.6-alpha.3",
+  "version": "1.0.6",
   "license": "MIT",
@@ -48,3 +48,3 @@ "main": "lib/index.js",
   },
-  "gitHead": "05e0a9c7a3860a821173ea3881a1abff2f9869b2"
+  "gitHead": "562f09e45daafde278f6802f32b08d32db49f2a3"
 }

README.md

@@ -5,7 +5,7 @@ <p align="center">
 
-<p align="center">Shared utils of the <a href="https://github.com/fluentfixture">@fluentfixture</a> project. Provides common string, date, and type utilities.</p>
+<p align="center">A flexible tool for generating customizable mock data with fluent interface 🚀</p>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/@fluentfixture/shared" target="_blank"><img src="https://img.shields.io/npm/v/@fluentfixture/shared.svg" alt="NPM Version"/></a>
-  <a href="https://www.npmjs.com/package/@fluentfixture/shared" target="_blank"><img src="https://img.shields.io/npm/l/@fluentfixture/shared.svg" alt="Package License" /></a>
+  <a href="https://www.npmjs.com/package/@fluentfixture/core" target="_blank"><img src="https://img.shields.io/npm/v/@fluentfixture/core.svg" alt="NPM Version"/></a>
+  <a href="https://en.wikipedia.org/wiki/MIT_License" target="_blank"><img src="https://img.shields.io/npm/l/@fluentfixture/core.svg" alt="Package License" /></a>
   <a href="https://dl.circleci.com/status-badge/redirect/gh/fluentfixture/fluentfixture/tree/main" target="_blank"><img src="https://dl.circleci.com/status-badge/img/gh/fluentfixture/fluentfixture/tree/main.svg?style=svg" alt="CircleCI" /></a>
@@ -15,19 +15,144 @@ <a href="https://coveralls.io/github/fluentfixture/fluentfixture?branch=main" target="_blank"><img src="https://coveralls.io/repos/github/fluentfixture/fluentfixture/badge.svg?branch=main#9" alt="Coverage" /></a>
   <a href="https://www.codefactor.io/repository/github/fluentfixture/fluentfixture" target="_blank"><img src="https://www.codefactor.io/repository/github/fluentfixture/fluentfixture/badge" alt="CodeFactor"/></a>
-  <a href="https://codesandbox.io/s/github/fluentfixture/fluentfixture/tree/main/sample/02-core" target="_blank"><img src="https://img.shields.io/badge/Open%20in-CodeSandbox-blue?style=flat-square&logo=codesandbox" alt="Open in CodeSandbox"/></a>
-  <a href="https://docs.fluentfixture.com" target="_blank"><img src="https://img.shields.io/badge/Open%20in-GitBook-yellow?style=flat-square&logo=gitbook" alt="Open in CodeSandbox"/></a>
+  <a href="https://codesandbox.io/s/github/fluentfixture/fluentfixture/tree/main/sample/core" target="_blank"><img src="https://img.shields.io/badge/Open%20in-CodeSandbox-blue?style=flat-square&logo=codesandbox" alt="Open in CodeSandbox"/></a>
+  <a href="https://docs.fluentfixture.com" target="_blank"><img src="https://img.shields.io/badge/Open%20in-GitBook-yellow?style=flat-square&logo=gitbook" alt="Open in GotBook"/></a>
 </p>
 
-## Introduction
+## Philosophy
 
-Shared utils of the [@fluentfixture](https://github.com/fluentfixture) project. Provides common string, date, and type utilities.
+> In Informatics, dummy data is benign information that does not contain any useful data, but serves to reserve space where real data is nominally present.
+> Dummy data can be used as a placeholder for both testing and operational purposes.
+> For testing, dummy data can also be used as stubs or pad to avoid software testing issues by ensuring that all variables and data fields are occupied. (↪[wiki](https://en.wikipedia.org/wiki/Dummy_data))
 
-> **WARNING**: This project provides shared utils for [@fluentfixture](https://github.comfluentfixture/) monorepo.
-> Therefore, this project can be terminated when deemed necessary. Please do not develop applications dependent on this project.
+Generating dummy data is crucial in software development. The quality of test data directly impacts development quality and velocity. 
+There are many dummy data generators in the JavaScript ecosystem. However, creating complex objects and responding to real-world use cases can be challenging.
 
+The [@fluentfixture][fluentfixture] aims to provide a fluent interface and an extensible architecture for generating dummy data.
+
+> The [@fluentfixture][fluentfixture] doesn't provide predefined data like FakerJS but offers multiple adapters for integration with external libraries.
+
 ## Documentation
 
-To check out the guide, visit [https://docs.fluentfixture.com/](https://docs.fluentfixture.com/)
+Visit [https://docs.fluentfixture.com](https://docs.fluentfixture.com) to view the full documentation.
 
+## Introduction
+
+### Core (@fluentfixture/core)
+
+The [@fluentfixture/core][fluentfixture-core] provides various data generators for different use cases. 
+All generators offer a fluent interface for manipulating data, including sorting, creating conditional values, and more.
+
+**Installation**
+
+```bash
+$ npm install @fluentfixture/core
+```
+
+**Example**
+
+Let us consider the following requirements. We need;
+- One hundred products that are ordered by their prices,
+- Each product has a price that ends with .95,
+- Each product has a code field with the "id-color" format calculated using generated values,
+- Each product has the same parent category with random id and name but the same type.
+- Half of them have stock.
+
+```ts
+import { alphabetic, bool, hex, int, obj, pick } from '@fluentfixture/core';
+
+// Defines a price generator with amount and the currency fields.
+const price = obj({
+  amount: int(100, 1000).add(0.95),
+  currency: pick(['USD', 'EUR', 'GBP', 'TRY']),
+});
+
+// Defines a color generator. (hex + pad + uppercase)
+const color = hex(6).padStart(7, '#').upperCase();
+
+// Defines a category with constant id.
+const category = obj({
+  id: int(1, 100),
+  name: alphabetic().headerCase(),
+  type: alphabetic(4, 8).memo()
+})
+
+// Defines a product generator.
+const product = obj({
+  id: int(1, 999),
+  name: alphabetic(10, 20).capitalCase(),
+  category: category,
+  description: alphabetic(20, 40).optional(),
+  hasStock: bool(0.5),
+  color: color,
+  price: price,
+});
+
+// 1) Adds 'code' field using generated values.
+// 2) Iterates the model.
+// 3) Sorts the generated models by their prices.
+const products = product
+  .lazy('code', (p) => `${p.id}-${p.color}`)
+  .array(10)
+  .sort((a, b) => a.price.amount - b.price.amount);
+
+// Print all products
+console.log(products.single());
+
+// Print details of the first product.
+console.log(product.format('[${id}] ${name:titleCase()} => ${price.amount}'));
+```
+
+### Format (@fluentfixture/format)
+
+The [@fluentfixture/format][fluentfixture-format] is a flexible string format library that provides formatting functionality with extensible formatting capability.
+
+**Installation**
+
+```bash
+$ npm install @fluentfixture/format
+```
+
+**Example**
+
+```ts
+import { format } from '@fluentfixture/format';
+
+const source = {
+  name: 'john',
+  surname: 'doe',
+  email: '[e-mail]',
+  birthdate: new Date(1_617_258_460_000),
+  balance: {
+    amount: 120,
+    currency: 'USD',
+  },
+  memberships: ['regular user', 'pro user'],
+};
+
+console.log(
+  format('${surname}, ${name} <${balance.amount} ${balance.currency}>', source),
+);
+
+console.log(
+  format('${surname:upperCase()}, ${name:capitalCase()} <${balance.amount} ${balance.currency}>', source),
+);
+
+console.log(
+  format('${surname:upperCase()}, ${name:capitalCase()} BIRTH_DATE=${birthdate:date("MM-DD-YYYY")}', source),
+);
+
+console.log(
+  format('${name}.${surname} > MEMBERSHIP=${memberships.0:dotCase()|upperCase()}', source),
+);
+
+console.log(
+  format('NICKNAME=${name:padStart(7, "#")|padEnd(10,"#")}', source),
+);
+```
+
 ## License
 
 @fluentfixture is [MIT](https://github.com/fluentfixture/fluentfixture/blob/main/LICENSE) licensed.
+
+[fluentfixture]: https://docs.fluentfixture.com
+[fluentfixture-core]: https://docs.fluentfixture.com/packages/fluentfixture-core
+[fluentfixture-format]: https://docs.fluentfixture.com/packages/fluentfixture-format

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22744

increased by20.12%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

157

increased by390.63%

No dependency changes