Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prismicio/prismic-mock

Generate mock Prismic documents, fields, Slices, and models for development and testing environments
https://github.com/prismicio/prismic-mock

javascript prismic typescript

Last synced: 2 months ago
JSON representation

Generate mock Prismic documents, fields, Slices, and models for development and testing environments

Awesome Lists containing this project

README 

        
# @prismicio/mock



[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]

[![Codecov][codecov-src]][codecov-href]

[![Conventional Commits][conventional-commits-src]][conventional-commits-href]

[![License][license-src]][license-href]



> ⚠ This project is in an experimental state and therefore primarily meant to be used by Prismic kits. Use it at your own risks or stay tuned for the official release!



Generate mock [Prismic][prismic] data for development and testing environments.



- 🏭 Generate mock Custom Type and Shared Slice models

- 🧸 Generate mock documents and individual field values from a model



## Install



```bash

npm install @prismicio/mock @prismicio/client

```



## Documentation



> ⚠ Official documentation on the Prismic site is not yet available while the project is developed. Check the integrated [TSDoc](https://tsdoc.org/) for API documentation.



To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].



## Contributing



Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!



**Asking a question**: [Open a new topic][forum-question] on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.



**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.



**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.



**Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.



For more clarity on this project, check out the detailed [CONTRIBUTING.md][contributing] document.



## License



```

Copyright 2013-2024 Prismic  (https://prismic.io)



Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at



    http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```



[prismic]: https://prismic.io



[prismic-docs]: https://prismic.io/docs

[changelog]: /CHANGELOG.md

[contributing]: ./CONTRIBUTING.md



[forum-question]: https://community.prismic.io

[repo-bug-report]: https://github.com/prismicio/prismic-mock/issues/new?assignees=&labels=bug&template=bug_report.md&title=

[repo-feature-request]: https://github.com/prismicio/prismic-mock/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=

[repo-pull-requests]: https://github.com/prismicio/prismic-mock/pulls



[npm-version-src]: https://img.shields.io/npm/v/@prismicio/mock/latest.svg

[npm-version-href]: https://npmjs.com/package/@prismicio/mock

[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/mock.svg

[npm-downloads-href]: https://npmjs.com/package/@prismicio/mock

[github-actions-ci-src]: https://github.com/prismicio/prismic-mock/workflows/ci/badge.svg

[github-actions-ci-href]: https://github.com/prismicio/prismic-mock/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-mock.svg

[codecov-href]: https://codecov.io/gh/prismicio/prismic-mock

[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg

[conventional-commits-href]: https://conventionalcommits.org

[license-src]: https://img.shields.io/npm/l/@prismicio/mock.svg

[license-href]: https://npmjs.com/package/@prismicio/mock