Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 1.69 KB

README.md

File metadata and controls

75 lines (49 loc) · 1.69 KB
Raw

Kong Spec Editor

A playground with live editor for Kong's spec renderer. Supports:

  • JSON and YAML file formats
  • OpenAPI 2.0, 3.0 and 3.1 (including callbacks)
  • AsyncAPI

Project Setup

pnpm install

Compile and Hot-Reload for Development

pnpm dev

Type-Check

pnpm typecheck

Lint and fix

Lint package files, and optionally auto-fix detected issues.

# Stylelint only
pnpm run stylelint

# Stylelint and fix
pnpm run stylelint:fix

# ESLint only
pnpm run lint

# ESLint and fix
pnpm run lint:fix

Build for production

pnpm run build

Committing Changes

Commitizen friendly

This repo uses Conventional Commits.

Commitizen and Commitlint are used to help build and enforce commit messages.

It is highly recommended to use the following command in order to create your commits:

pnpm run commit

This will trigger the Commitizen interactive prompt for building your commit message.

Enforcing Commit Format

Lefthook is used to manage Git Hooks within the repo.

  • A commit-msg hook is automatically setup that enforces commit message stands with commitlint, see lefthook.ymal
  • A pre-push hook is used that runs eslint before allowing you to push your changes to the repository

Additionally, CI will use commitlint to validate the commits associated with a PR in the Lint and Validate job.