Getting Started

Installation

First, you need to install golar package.

npm i -D golar

pnpm add -D golar

yarn add -D golar

Golar loads golar.config.ts from the current working directory, so start by creating that file.

In the root of your repository create a file named golar.config.ts:

import { defineConfig } from 'golar/unstable'

export default defineConfig({})

Next, open the guide for the language you’re using.

You can also register multiple language plugins in the same golar.config.ts file if your project mixes frameworks.

Astro Set up the Astro plugin, and use Golar with .astro files.

Ember Set up the Ember plugin, and use Golar with .gts files.

Svelte Set up the Svelte plugin, and use Golar with .svelte files.

Vue Set up the Vue plugin, and use Golar with .vue files.

Golar CLI has four modes.

The default mode is recommended for most projects. To run Golar CLI in the default mode, call golar CLI without any command line arguments.

npx golar

pnpm golar

yarn golar

This command locates golar.config.ts, loads all language plugins and lint rules, runs linting and then type-checks all project files.

See the mode docs for command-specific behavior and configuration: default mode, lint, typecheck, and tsc.