@fullsnacklab/oxfmt-config 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,115 @@
-# Temporary Holding Version
+# @fullsnacklab/oxfmt-config
 
-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.
+Shared Oxfmt config: width 80, single quotes, and the existing agent-directory
+ignores. `base.json` owns these values; the root export is built JavaScript with
+type declarations. Indentation comes from the consumer's EditorConfig unless
+explicitly overridden in Oxfmt.
+
+## Install
+
+```sh
+bun add --dev @fullsnacklab/oxfmt-config oxfmt@~0.65.0
+```
+
+Create `oxfmt.config.ts` at your project root:
+
+```ts
+import shared from '@fullsnacklab/oxfmt-config';
+import { defineConfig } from 'oxfmt';
+
+export default defineConfig({
+    ...shared,
+});
+```
+
+Add scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "format": "oxfmt",
+    "format:check": "oxfmt --check"
+  }
+}
+```
+
+Use `bun run format` to write changes and `bun run format:check` for read-only
+checks. The local wrapper keeps relative file patterns anchored in your project.
+
+## Editor settings
+
+Copy [`examples/.editorconfig`](examples/.editorconfig) to your project root:
+
+```sh
+cp node_modules/@fullsnacklab/oxfmt-config/examples/.editorconfig .editorconfig
+```
+
+Merge it with an existing EditorConfig rather than replacing project-specific
+sections. The example chooses:
+
+- **4 spaces for code; 2 for JSON/JSONC, YAML, and TOML.** TS/JS config files use code indentation.
+- LF, UTF-8, final newlines, and trimmed trailing whitespace.
+- Preserved trailing whitespace in Markdown/MDX, where spaces can encode line breaks.
+
+Oxfmt uses supported EditorConfig settings as fallbacks; explicit Oxfmt options
+win. Quotes and print width belong in Oxfmt, not nonstandard EditorConfig keys.
+The Markdown exception controls editor trimming, not Oxfmt's Markdown rendering.
+
+## Project overrides
+
+Keep exceptions in your wrapper:
+
+```ts
+import shared from '@fullsnacklab/oxfmt-config';
+import { defineConfig } from 'oxfmt';
+
+export default defineConfig({
+    ...shared,
+    printWidth: 100,
+    ignorePatterns: [...(shared.ignorePatterns ?? []), 'dist/**'],
+});
+```
+
+Setting `ignorePatterns` directly replaces the shared list; appending retains it.
+The base ignores `.pi`, `.agents`, `.opencode`, `.claude`, `.omp`, and `.codex`
+patterns. Override the list deliberately if you want those files formatted.
+
+## Raw JSON
+
+`@fullsnacklab/oxfmt-config/base.json` exposes the same source data:
+
+```ts
+import base from '@fullsnacklab/oxfmt-config/base.json' with { type: 'json' };
+
+export default { ...base };
+```
+
+Oxfmt does not provide package-name JSON `extends`; use the local wrapper rather
+than adding an unsupported inheritance property.
+
+## Releases
+
+After the initial publish, configure npm trusted publishing for:
+
+- Owner: `full-snack-lab`
+- Repository: `oxfmt-config`
+- Workflow filename: `release.yml`
+- Environment: leave blank
+- Allow direct `npm publish`
+
+Commit a new package version and run **Actions → Release → Run workflow** on that
+commit's branch. The workflow uses Bun to install/build/pack and npm solely for
+OIDC publishing. It needs no stored npm token. Already-published versions cannot
+be republished. The workflow must be pushed to GitHub before it is available.
+
+## Maintaining
+
+```sh
+bun install --frozen-lockfile
+bun run build
+bun pm pack --dry-run --ignore-scripts
+```
+
+Bunup emits ESM and isolated declarations into `dist/`. The explicit public type
+avoids the inferred-declaration compiler path. The package includes built files,
+`base.json`, and the EditorConfig example. No build is required in consuming projects.

package/base.json

@@ -0,0 +1,12 @@
+{
+    "ignorePatterns": [
+    "**/.pi/*",
+    "**/.agents/*",
+    "**/.opencode/*",
+		"**/.claude/*",
+		"**/.omp/*",
+		"**/.codex/*"
+	],
+	"printWidth": 80,
+	"singleQuote": true
+}

package/dist/oxfmt.config.d.ts

@@ -0,0 +1,3 @@
+import { OxfmtConfig } from "oxfmt";
+declare const config: OxfmtConfig;
+export { config as default };

package/dist/oxfmt.config.js

@@ -0,0 +1,20 @@
+// base.json
+var base_default = {
+  ignorePatterns: [
+    "**/.pi/*",
+    "**/.agents/*",
+    "**/.opencode/*",
+    "**/.claude/*",
+    "**/.omp/*",
+    "**/.codex/*"
+  ],
+  printWidth: 80,
+  singleQuote: true
+};
+
+// oxfmt.config.ts
+var config = base_default;
+var oxfmt_config_default = config;
+export {
+  oxfmt_config_default as default
+};

package/examples/.editorconfig

@@ -0,0 +1,18 @@
+# Copy to the consumer root. Oxfmt reads these as fallback formatting settings.
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Structured configuration uses two spaces; TS/JS config files remain code.
+[*.{json,jsonc,yaml,yml,toml}]
+indent_size = 2
+
+# Preserve Markdown's intentional two-space hard line breaks.
+[*.{md,mdx}]
+trim_trailing_whitespace = false

package/package.json

@@ -1,6 +1,36 @@
 {
-  "name": "@fullsnacklab/oxfmt-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+	"name": "@fullsnacklab/oxfmt-config",
+	"description": "Oxfmt configuration",
+	"version": "0.1.0",
+	"devDependencies": {
+		"@changesets/cli": "^2.27.1",
+		"bunup": "0.16.32"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/full-snack-lab/oxfmt-config.git"
+	},
+	"author": {
+		"name": "Jordan Sweeting",
+		"email": "jordan@fullsnacklab.com",
+		"url": "https://fullsnacklab.com"
+	},
+	"license": "MIT",
+	"type": "module",
+	"files": ["dist", "base.json", "examples/.editorconfig"],
+	"scripts": {
+		"build": "bunup",
+		"format": "oxfmt",
+		"format:check": "oxfmt --check"
+	},
+	"peerDependencies": {
+		"oxfmt": "0.65.0"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/oxfmt.config.d.ts",
+			"import": "./dist/oxfmt.config.js"
+		},
+		"./base.json": "./base.json"
+	}
 }