https://github.com/mniebling/light-fakery

A lightweight library for generating fake data in Javascript
https://github.com/mniebling/light-fakery

typescript vitepress vitest

Last synced: 5 days ago
JSON representation

A lightweight library for generating fake data in Javascript

• Host: GitHub
• URL: https://github.com/mniebling/light-fakery
• Owner: mniebling
• License: mit
• Created: 2021-06-12T17:15:23.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-30T19:54:20.000Z (about 1 month ago)
• Last Synced: 2025-01-01T10:46:22.215Z (6 days ago)
• Topics: typescript, vitepress, vitest
• Language: TypeScript
• Homepage: https://light-fakery.netlify.app
• Size: 526 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# light-fakery

A lightweight library for generating fake data in JS/TS.

[Documentation](https://light-fakery.netlify.app/)

[![Netlify Status](https://api.netlify.com/api/v1/badges/0ac3b698-e213-4aea-a073-e4401afadb3d/deploy-status)](https://app.netlify.com/sites/light-fakery/deploys)

Its guiding principles are:

- Structured as a [pure ESM package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)

- Tree-shakable so you only bundle data you are using

- First class support for consuming the library in TypeScript

- Focused on fake data use cases that make sense in a business-y environment

- Easy to extend if you need additional data

- Zero dependencies

### Development

`npm run build` — Compile Typescript and emit to `./dist`.

`npm test` — Run unit tests with Vitest.

`npm run docs:dev` — Run Vitepress locally to work on documentation.

`npm run release` — Kick off an [NPM release](https://www.npmjs.com/package/light-fakery). You'll be prompted for the release details and the command will run a build before releasing. This will also attempt to perform a [GitHub release](https://github.com/release-it/release-it/blob/master/docs/github-releases.md#manual), so you will need to have appropriate permissions there to update the details.