Installation

Syncify is distributed as a CommonJS (CJS) module but is compatible with ECMAScript Module (ESM) environments since it operates as a CLI binary-based tool. You have the option to install Syncify either on a per-project basis or globally, with global installation being the recommended and preferred method.

Syncify requires users to have both Node (v20 or higher) and Git (v2.2 or higher) installed on their system. While Syncify is compatible with various package managers, for the optimal experience, it’s advisable to consider using pnpm.

$ pnpm add @syncify/cli -g

$ npm i @syncify/cli -g

$ yarn add @syncify/cli -g

$ bun add @syncify/cli -g

Schema Stores

Syncify provides JSON Schema Store references for usage in JSON files that contain a $schema property or within text editors like VSCode which support external schema store association. The JSON Schema store is helpful for users who prefer .json configurations or are setting config options within their package.json file via the syncify config key.

Package package.json

https://unpkg.com/@syncify/schema/pkg.json

Config File syncify.config.json

https://unpkg.com/@syncify/schema/config.json

Sections *.schema

https://unpkg.com/@syncify/schema/sections.json

VSCode Usage

Developers using the VSCode text editor can enable the JSON Schema within the projects workspace or global settings. If you are using the vscode-liquid extension these references are automatically applied for you, however for the animals using Shopify theme check, you’ll need to extend.

{
  "json.schemas": [
    {
      "fileMatch": ["**/package.json"],
      "url": "https://unpkg.com/@syncify/schema/pkg.json"
    },
    {
      "fileMatch": ["**/*.schema"],
      "url": "https://unpkg.com/@syncify/schema/sections.json"
    }
  ]
}