Important

This library is deprecated. Go to coven.engineering to see what we are doing nowadays.

---

⚙️ Shared Vangware project configuration files for linting, formatting, documentation and so on.

Configurations

• 🦋 changelog.cjs — Changesets changelog functions.
• 🚨 eslint.config.js — JavaScript and TypeScript linting.
• ✨ prettier.config.cjs — Code formatting.
• 🎨 stylelint.config.cjs — CSS linting.
• 🏷️ typescript.config.json — TypeScript configuration (strict).
• 📖 typedoc.css — Documentation styles.
• 📖 typedoc.config.json — Documentation configuration.

Usage

All this configurations are setup automatically by @vangware/create-package when creating a new package.

For manual setup of each file, follow the instructions below.

.changeset/config.json

{
	"$schema": "https://raw.githubusercontent.com/changesets/changesets/main/packages/config/schema.json",
	"changelog": "@vangware/configs/changelog.cjs",
	"commit": false,
	"access": "restricted",
	"baseBranch": "main",
	"updateInternalDependencies": "patch"
}

eslint.config.js

export { default } from "@vangware/configs/eslint.config.js";

prettier.config.cjs

module.exports = require("@vangware/configs/prettier.config.cjs");

stylelint.config.cjs

module.exports = require("@vangware/configs/stylelint.config.cjs");

tsconfig.json

{
	"extends": "@vangware/configs/typescript.config.json"
}

typedoc.json

{
	"$schema": "https://typedoc.org/schema.json",
	"cname": "PUBLIC DOMAIN",
	"entryPoints": ["./lib"],
	"extends": ["@vangware/configs/typedoc.config.json"],
	"name": "PACKAGE NAME"
}

Useful links

• ⏳ Changelog: List of changes between versions.