@opinionated-ts/config 1.7.0 → 1.8.1

package/README.md

@@ -2,52 +2,57 @@
 
 Opinionated, reusable TypeScript tooling configurations focused on performance, code quality, and developer experience.
 
-## Installation
+## When to use?
 
-```bash
-bun add -D @opinionated-ts/config
+This package provides recommended, opinionated configurations designed to reduce project setup time and maintain consistent tooling across TypeScript projects.
 
-# npm install -D @opinionated-ts/config
-# pnpm add -D @opinionated-ts/config
-# yarn add -D @opinionated-ts/config
-```
+Use it when you want to:
 
-## Usage
+- Move fast without sacrificing code quality
+- Keep a consistent developer experience across repositories
+- Avoid repetitive configuration boilerplate
+- Standardize tooling with a clear opinionated default
 
-Import the configurations you need:
+The configurations prioritize:
 
-<!-- prettier-ignore -->
-```ts
-import {
-  commitlintConfig,
-  cspellConfig,
-  oxfmtConfig,
-  oxlintConfig,
-} from "@opinionated-ts/config";
-```
+- **Performance** — Fast tooling and builds
+- **Code quality** — Comprehensive linting and type checking
+- **Developer experience** — Zero-friction setup and consistent workflows
+- **Modern tooling** — Latest standards and best practices
 
-<!-- prettier-ignore -->
-Each configuration can be used directly as a recommended default or customized depending on the configuration system supported by each tool.
+> [!NOTE]
+> This package is designed primarily for **Bun** environments. The workflow validations and tool integrations are optimized for Bun's runtime and package manager.
 
-See the configuration guides for each tool:
+## What's included
 
-- [Scripts](./docs/scripts.md)
-- [Typescript](./docs/tsconfig.md)
-- [Commitlint](./docs/commitlint.md)
-- [CSpell](./docs/cspell.md)
-- [Oxfmt](./docs/oxfmt.md)
-- [Oxlint](./docs/oxlint.md)
-- [Lefthook](./docs/lefthook.md)
-- [GitHub Actions](./docs/github-actions.md)
-- [Release](./docs/release.md)
+### Local Automatic Validations
 
-## Philosophy
+| Category           | Tool                                          | Description                                                           |
+| ------------------ | --------------------------------------------- | --------------------------------------------------------------------- |
+| **Type checking**  | [TypeScript](https://www.typescriptlang.org/) | Applied together with Oxlint via `typeCheck`/`typeAware`              |
+| **Linter**         | [Oxlint](https://oxc.rs/)                     | Fast linting, pre-configured                                          |
+| **Formatter**      | [Oxfmt](https://oxc.rs/)                      | Fast formatting, pre-configured                                       |
+| **Spellchecking**  | [cspell](https://cspell.org/)                 | Pre-configured for English/Spanish                                    |
+| **Commit linting** | [commitlint](https://commitlint.js.org/)      | Enforces [Conventional Commits](https://www.conventionalcommits.org/) |
+| **Git hooks**      | [lefthook](https://lefthook.dev/)             | Wired up locally (`pre-commit`, `commit-msg`, `pre-push`)             |
 
-This package provides recommended, opinionated configurations designed to reduce project setup time and maintain consistent tooling across TypeScript projects.
+### Remote Automatic Validations
 
-The configurations prioritize:
+| Category    | Tool                                                     | Description                                              |
+| ----------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| **CI/CD**   | [GitHub Actions](https://github.com/features/actions)    | Automated workflows for validation and release pipelines |
+| **Release** | [Semantic Release](https://semantic-release.gitbook.io/) | Automated versioning and releases                        |
+
+## Getting started
+
+### Option 1: Start fast with the template
+
+The easiest way to use this stack is to start from our ready-to-use template:
+
+👉 [@opinionated-ts/template](https://github.com/opinionated-ts/template)
+
+It is already set up with the recommended defaults and tooling wiring.
+
+### Option 2: Add to an existing project
 
-- Performance
-- Code quality
-- Developer experience
-- Modern tooling
+Install the package and follow our [Installation, Usage & Configuration Guide](./docs/getting-started.md).

package/dist/configs/release.mjs

@@ -1,5 +1,3 @@
-import "conventional-changelog-conventionalcommits";
-import "semantic-release";
 //#region src/configs/release.ts
 const semanticReleaseConfig = {
 	branches: [

package/dist/index.d.mts

@@ -1,5 +1,18 @@
 import semanticReleaseConfig from "./configs/release.mjs";
-import { RuleConfigSeverity } from "@commitlint/types";
+//#region node_modules/@commitlint/types/lib/rules.d.ts
+/**
+ * Rules always have a severity.
+ * Severity indicates what to do if the rule is found to be broken
+ * 0 - Disable this rule
+ * 1 - Warn for violations
+ * 2 - Error for violations
+ */
+declare enum RuleConfigSeverity {
+  Disabled = 0,
+  Warning = 1,
+  Error = 2
+}
+//#endregion
 //#region src/configs/commitlint.d.ts
 declare const commitlintConfig: {
   extends: string[];

package/dist/index.mjs

@@ -1,6 +1,23 @@
 import semanticReleaseConfig from "./configs/release.mjs";
-import { RuleConfigSeverity } from "@commitlint/types";
-import "oxlint";
+//#region node_modules/@commitlint/types/lib/rules.js
+/**
+* Rules always have a severity.
+* Severity indicates what to do if the rule is found to be broken
+* 0 - Disable this rule
+* 1 - Warn for violations
+* 2 - Error for violations
+*/
+var RuleConfigSeverity;
+(function(RuleConfigSeverity) {
+	RuleConfigSeverity[RuleConfigSeverity["Disabled"] = 0] = "Disabled";
+	RuleConfigSeverity[RuleConfigSeverity["Warning"] = 1] = "Warning";
+	RuleConfigSeverity[RuleConfigSeverity["Error"] = 2] = "Error";
+})(RuleConfigSeverity || (RuleConfigSeverity = {}));
+var RuleConfigQuality;
+(function(RuleConfigQuality) {
+	RuleConfigQuality[RuleConfigQuality["User"] = 0] = "User";
+	RuleConfigQuality[RuleConfigQuality["Qualified"] = 1] = "Qualified";
+})(RuleConfigQuality || (RuleConfigQuality = {}));
 const commitlintConfig = {
 	extends: ["@commitlint/config-conventional"],
 	rules: {

package/lefthook.yml

@@ -30,7 +30,7 @@ pre-push:
   parallel: true
   commands:
     run-tests:
-      run: bun test
+      run: bun run tests || bun test
 
     run-audit:
       run: bun audit

package/package.json

@@ -90,5 +90,8 @@
     "node": "^26.2.0"
   },
   "packageManager": "bun@1.4.0",
-  "version": "1.7.0"
+  "inlinedDependencies": {
+    "@commitlint/types": "21.2.0"
+  },
+  "version": "1.8.1"
 }