🐌Welcome to @snailicide/g-shopify-library🐌

| npm | GitHub |

Collections of types and utilities for working with Shopify

• 🐌Welcome to @snailicide/g-shopify-library🐌
  • Author
  • Features
  • Examples
    • Install
    • Build
    • Tests
  • Helpful Links
  • To-Do
  • Bugs

Table of contents generated with markdown-toc

Author

👤 Gillian Tunney | github | email |

Features

• Generic functions for Storefront API, Shopify MediaURLs, etc
• Section Schema types and validators (using zod)

Examples

See @snailicide/vite-plugin-shopify-liquid-modules for an usage example of using the validators and types.

Usage

Install

This library is published in the NPM registry and can be installed using any compatible package manager.

#npm
npm i @snailicide/g-shopify-library -D

# yarn
yarn add @snailicide/g-shopify-library -D

# pnp
pnpm add @snailicide/g-shopify-library -D

For pnpm workspace:

pnpm add @snailicide/g-shopify-library@workspace:*

pnpm --filter=[yourGlob] add @snailicide/g-shopify-library@workspace:*

Build

pnpm --filter=@snailicide/g-shopify-library build

Tests

pnpm --filter=@snailicide/g-shopify-library test

Helpful Links

• Shopify Section schema reference
• @shopify/admin-graphql-api-utilities
• Zod
• TypeScript
• Ramda

To-Do

• [ ] Presets (in new version)
• [ ] Documentation

Bugs

Please create an issue if you found any bugs, to help us improve this project!