@yoo-digital/oxfmt-config 0.0.0-stage → 0.1.1-canary.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 YOO AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,63 @@
-# Temporary Holding Version
+# YOO Oxfmt Configuration
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+_This package contains a reusable [oxfmt](https://oxc.rs/docs/guide/usage/formatter) configuration for projects @ YOO._
+
+[![npm version](https://badge.fury.io/js/%40yoo-digital%2Foxfmt-config.svg)](https://www.npmjs.com/package/@yoo-digital/oxfmt-config)
+
+## Introduction
+
+The configuration builds on oxfmt's defaults and adds the following settings:
+
+- Single quotes in JavaScript and TypeScript, double quotes in CSS, SCSS and HTML
+- One attribute per line in HTML and JSX
+- Sorted imports, without blank lines between import groups
+- `package.json` files are not sorted
+- HTML files use a print width of 120
+- Angular component templates are formatted with the Angular parser (see [Angular templates](#angular-templates))
+
+## Using the Configuration
+
+Install the configuration together with oxfmt:
+
+```text
+pnpm add -D @yoo-digital/oxfmt-config oxfmt
+```
+
+Create an `oxfmt.config.mts` file in the root of your project:
+
+```ts
+export { default } from '@yoo-digital/oxfmt-config';
+```
+
+Then run `oxfmt` to format your project, or `oxfmt --check` to verify the formatting (e.g. in CI).
+
+## Extending the Configuration
+
+oxfmt has no `extends` option. Spread the configuration and add your project-specific options:
+
+```ts
+import yooOxfmtConfig from '@yoo-digital/oxfmt-config';
+import { defineConfig } from 'oxfmt';
+
+export default defineConfig({
+  ...yooOxfmtConfig,
+  // overrides
+});
+```
+
+For a complete overview of configuration options please refer to the [official documentation](https://oxc.rs/docs/guide/usage/formatter/config).
+
+## Ignoring files
+
+oxfmt respects `.gitignore` files. Use the `ignorePatterns` option to ignore additional files.
+
+## Angular templates
+
+Angular component templates are formatted with the Angular parser, which supports control flow blocks
+(`@if`, `@for`, …), bindings and pipes. Templates are detected by these patterns:
+
+- `**/*.component.html`
+- `**/src/app/**/*.html` (Angular 20+ naming without the `.component` suffix, e.g. `app.html`)
+
+All other `*.html` files, such as `src/index.html`, are formatted as plain HTML. If your templates live elsewhere,
+add your own entry to `associations` with `language: 'angular-html'`.

package/oxfmt.config.d.mts

@@ -0,0 +1,5 @@
+import type { OxfmtConfig } from 'oxfmt';
+
+declare const config: OxfmtConfig;
+
+export default config;

package/oxfmt.config.mjs

@@ -0,0 +1,32 @@
+// @ts-check
+import { defineConfig } from 'oxfmt';
+
+export default defineConfig({
+  singleQuote: true,
+  singleAttributePerLine: true,
+  sortPackageJson: false,
+  sortImports: {
+    newlinesBetween: false,
+  },
+  associations: [
+    {
+      files: ['**/*.component.html', '**/src/app/**/*.html'],
+      language: 'angular-html',
+    },
+  ],
+  overrides: [
+    {
+      files: ['**/*.scss', '**/*.css'],
+      options: {
+        singleQuote: false,
+      },
+    },
+    {
+      files: ['**/*.html'],
+      options: {
+        singleQuote: false,
+        printWidth: 120,
+      },
+    },
+  ],
+});

package/package.json

@@ -1,6 +1,89 @@
 {
   "name": "@yoo-digital/oxfmt-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1-canary.0",
+  "description": "Reusable oxfmt configuration for projects within YOO AG",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "Oxfmt",
+    "Formatter"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:yoo-digital/config.git",
+    "directory": "packages/oxfmt-config"
+  },
+  "author": {
+    "name": "YOO AG",
+    "email": "info@yoo.digital",
+    "url": "https://www.yoo.digital/"
+  },
+  "contributors": [
+    {
+      "name": "Björn Bühler",
+      "email": "bjoern.buehler@yoo.digital"
+    },
+    {
+      "name": "Cédric Madörin",
+      "email": "cedric.madoerin@yoo.digital"
+    },
+    {
+      "name": "Emanuel Marsicovetere",
+      "email": "emanuel.marsicovetere@yoo.digital"
+    },
+    {
+      "name": "Hervé Brunner",
+      "email": "herve.brunner@yoo.digital"
+    },
+    {
+      "name": "Kelvin Louis",
+      "email": "kelvin.louis@yoo.digital"
+    },
+    {
+      "name": "Robin Hahne",
+      "email": "robin.hahne@yoo.digital"
+    },
+    {
+      "name": "Sacha Schmid",
+      "email": "sacha.schmid@yoo.digital"
+    },
+    {
+      "name": "Tobias Maier",
+      "email": "tobias.maier@yoo.digital"
+    },
+    {
+      "name": "Tobias Wahl",
+      "email": "tobias.wahl@yoo.digital"
+    },
+    {
+      "name": "Yanick Recher",
+      "email": "yanick.recher@yoo.digital"
+    }
+  ],
+  "exports": {
+    ".": {
+      "types": "./oxfmt.config.d.mts",
+      "import": "./oxfmt.config.mjs"
+    }
+  },
+  "types": "./oxfmt.config.d.mts",
+  "files": [
+    "LICENSE",
+    "README.md",
+    "oxfmt.config.d.mts",
+    "oxfmt.config.mjs"
+  ],
+  "engines": {
+    "node": ">=24",
+    "pnpm": ">=11"
+  },
+  "devDependencies": {
+    "oxfmt": "~0.76.0",
+    "typescript": "~6.0.3"
+  },
+  "peerDependencies": {
+    "oxfmt": ">=0.76.0 <1"
+  }
 }