# sm-commons

> A set of common utilities for slice machine libraries

Latest version **0.1.6** (published 2022-04-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install sm-commons
pnpm add sm-commons
yarn add sm-commons
bun add sm-commons
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2022-04-08 |
| First published | 2019-12-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 12 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 305 |
| Author | Hugo Villain |
| Maintainers | sprite, hypervillain, amaurycahuet, npmdiscovery |
| Keywords | Prismic, slices |

## Links

- npm: https://www.npmjs.com/package/sm-commons
- Repository: https://github.com/prismicio/sm-commons
- Homepage: https://github.com/prismicio/sm-commons#readme
- Issues: https://github.com/prismicio/sm-commons/issues
- npm.io page: https://npm.io/package/sm-commons

## Dependencies (3)

- [consola](https://npm.io/package/consola.md) ^2.11.3
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2
- [expect.js](https://npm.io/package/expect.js.md) ^0.3.1

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 0.1.6 (latest) — 2022-04-08
- 0.1.7-alpha.2 (alpha) — 2022-04-12
- 0.0.24-beta.2 (beta) — 2021-11-24
- 0.1.7-alpha.1 — 2022-04-11
- 0.1.7-alpha.0 — 2022-04-08
- 0.1.6-alpha.5 — 2022-04-08
- 0.1.6-alpha.4 — 2022-04-08
- 0.1.6-alpha.3 — 2022-04-07
- 0.1.6-alpha.2 — 2022-04-06
- 0.1.6-alpha.1 — 2022-04-05
- 0.1.6-alpha.0 — 2022-04-01
- 0.1.5 — 2022-03-30
- 0.1.5-alpha.12 — 2022-03-30
- 0.1.5-alpha.11 — 2022-03-30
- 0.1.5-alpha.10 — 2022-03-29
- … 162 more at https://npm.io/package/sm-commons/versions

## README

<p align="center">
  <a href="https://slicemachine.dev">
    <img src=".github/logo.svg" alt="Slice Machine logo" width="220" />
  </a>
</p>
<p align="center">
  Develop and work with <a href="https://prismic.io">Prismic</a> Slices, locally.
</p>

# Slice Machine

[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![npm version][npm-version-src]][npm-version-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![License][license-src]][license-href]

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

For real-time updates on Prismic's system status, visit the [Prismic Status Page](https://status.prismic.io/) 🔔.

## Quickstart

For the smoothest onboarding experience, go to [Prismic][prismic-dashboard], create an account, create a new repository, and choose a starter project. You will be guided through a full introduction to Slice Machine.

If you want to dive in without any guidance, follow these steps:

Create a Next.js, Nuxt, or SvelteKit app:
```
npx create-next-app@latest my-app
```
```
npx nuxi@latest init my-app
```
```
npx sv create my-app
```

Open the folder:
```
cd my-app
```
Install dependencies:
```
npm i
```

Init Slice Machine:
```
npx @slicemachine/init
```

Open two terminals. In one terminal, run the web app:

```
npm run dev
```

In the other, run Slice Machine:
```
npm run slicemachine
```
Now you can use Slice Machine to create content models for your website. You will push your models to Prismic, where editors can use them to create content.

You will need to query content from the Prismic API to use it in your application. To learn how to use the Prismic API, visit the [Prismic Documentation][prismic-docs].

## Documentation

To discover what's new on this package check out the [changelog][changelog]. For full documentation, visit the official [Prismic documentation][sm-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 PR][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.

## License

```
Copyright 2013-2024 Prismic <contact@prismic.io> (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.
```

<!-- Links -->

[prismic]: https://prismic.io

<!-- TODO: Replace link with a more useful one if available -->

[prismic-docs]: https://prismic.io/docs
[sm-docs]: https://prismic.io/docs/slice-machine
[prismic-dashboard]: https://prismic.io/dashboard
[changelog]: /CHANGELOG.md

<!-- TODO: Replace link with a more useful one if available -->

[forum-question]: https://community.prismic.io
[repo-bug-report]: https://github.com/prismicio/slice-machine/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[repo-feature-request]: https://github.com/prismicio/slice-machine/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[repo-pull-requests]: https://github.com/prismicio/slice-machine/pulls

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/slice-machine-ui/latest.svg
[npm-version-href]: https://npmjs.com/package/slice-machine-ui
[npm-downloads-src]: https://img.shields.io/npm/dm/slice-machine-ui.svg
[npm-downloads-href]: https://npmjs.com/package/slice-machine-ui
[github-actions-ci-src]: https://github.com/prismicio/slice-machine/workflows/test/badge.svg
[github-actions-ci-href]: https://github.com/prismicio/slice-machine/actions?query=workflow%3Atest
[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/slice-machine.svg
[codecov-href]: https://codecov.io/gh/prismicio/slice-machine
[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/slice-machine-ui.svg
[license-href]: https://npmjs.com/package/slice-machine-ui

---
_Source: https://npm.io/package/sm-commons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._