Installation

Æsthetic is available for consumption via the NPM registry and supports both ESM and CJS environments. For the best practice, it is recommended to install Æsthetic on a per-project basis rather than globally. While tree-shaking is not feasible with Æsthetic, developers can rest assured that the module remains relatively small, with a gzipped size of 57.5kb. Additionally, its import bundle is distributed as a single, concise file.

PNPM

Æsthetic recommends developers choose pnpm as their package manager.

$ pnpm add esthetic --save-dev

NPM

$ npm install esthetic --save-dev

Yarn

$ yarn add esthetic

CDN Usage

You may optionally prefer to use the unpkg CDN for quick usage in the web browser. Æsthetic will be exposed in globalThis scope when used in browser environments. You can access method via window.esthetic (or simply, esthetic) anywhere in your application.

https://unpkg.com/esthetic

You can disable globalThis assignment from being applied via esthetic.settings() method. See the usage → settings page for more information.

JSON Schema Store

Æsthetic provided 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.

https://unpkg.com/esthetic/schema.json

VSCode Usage

You can provide the schema store reference a couple of different ways. Developers using the VSCode text editor, can either install the Æsthetic Extension or alternatively provide the schema store to your workspace settings:

{
  "json.schemas": [
    {
      "url": "https://unpkg.com/esthetic/schema.json",
      "fileMatch": [
        "package.json",
        ".esthetic.json",
        ".esthetic"
      ]
    }
  ]
}

Direct Usage

You may optionally choose to provide the schema store directly within JSON configuration files.

{
  "$schema": "https://unpkg.com/esthetic/schema.json"
}