@dnd-mapp/config-prettier 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-09-20
+
+### Added
+
+- `base` config, available as `@dnd-mapp/config-prettier` and `@dnd-mapp/config-prettier/base`.
+
+[Unreleased]: https://github.com/dnd-mapp/config-prettier/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/dnd-mapp/config-prettier/releases/tag/v1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 D&D Mapp
+
+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

@@ -0,0 +1,68 @@
+# @dnd-mapp/config-prettier
+
+[![push main](https://github.com/dnd-mapp/config-prettier/actions/workflows/push-main.yaml/badge.svg?branch=main)](https://github.com/dnd-mapp/config-prettier/actions/workflows/push-main.yaml)
+[![npm version](https://img.shields.io/npm/v/@dnd-mapp/config-prettier)](https://www.npmjs.com/package/@dnd-mapp/config-prettier)
+[![license](https://img.shields.io/npm/l/@dnd-mapp/config-prettier)](LICENSE)
+
+Shared Prettier config for all D&D Mapp projects.
+
+## Requirements
+
+- Prettier 3 is a peer dependency and must be installed in your project.
+
+## Installation
+
+```bash
+pnpm add --save-dev prettier @dnd-mapp/config-prettier
+```
+
+## Usage
+
+Reference the config from a `.prettierrc` file in your project root.
+
+```json
+"@dnd-mapp/config-prettier"
+```
+
+To add your own options, re-export the config from a `prettier.config.js` file instead.
+
+```js
+import config from '@dnd-mapp/config-prettier';
+
+export default {
+    ...config,
+    printWidth: 100,
+};
+```
+
+## Available configs
+
+| Config | Import path                      | Description                        |
+|:-------|:---------------------------------|:-----------------------------------|
+| `base` | `@dnd-mapp/config-prettier/base` | The default config for any project |
+
+The package root, `@dnd-mapp/config-prettier`, resolves to `base`.
+
+## What `base` sets
+
+| Option        | Value          | Description                                      |
+|:--------------|:---------------|:-------------------------------------------------|
+| `printWidth`  | `120`          | Wraps code at 120 columns                        |
+| `quoteProps`  | `'consistent'` | Quotes object properties only if one requires it |
+| `singleQuote` | `true`         | Uses single quotes instead of double quotes      |
+
+The config has one override. Files that match `*.yaml` or `*.yml` use double quotes, so `singleQuote` is `false` for them.
+
+The config does not set `tabWidth`. Prettier reads it from the `.editorconfig` file in your project, so set `indent_size` there.
+
+## Changelog
+
+Notable changes for consumers of this package are listed in the [changelog](CHANGELOG.md).
+
+## Contributing
+
+Contributions are welcome. See the [contributing guide](CONTRIBUTING.md) for details.
+
+## License
+
+[MIT](LICENSE) © D&D Mapp

package/configs/base.js

@@ -0,0 +1,16 @@
+/** @type {import('prettier').Config} */
+const config = {
+    overrides: [
+        {
+            files: ['*.yaml', '*.yml'],
+            options: {
+                singleQuote: false,
+            },
+        },
+    ],
+    printWidth: 120,
+    quoteProps: 'consistent',
+    singleQuote: true,
+};
+
+export default config;

package/index.js

@@ -0,0 +1 @@
+export { default } from './configs/base.js';

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@dnd-mapp/config-prettier",
+  "description": "Prettier configuration shared across D&D Mapp projects.",
+  "version": "1.0.0",
+  "license": "MIT",
+  "type": "module",
+  "author": "D&D Mapp",
+  "keywords": [
+    "dnd-mapp",
+    "prettier",
+    "prettier-config",
+    "config",
+    "formatting"
+  ],
+  "homepage": "https://github.com/dnd-mapp/config-prettier#readme",
+  "bugs": {
+    "url": "https://github.com/dnd-mapp/config-prettier/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dnd-mapp/config-prettier.git"
+  },
+  "exports": {
+    ".": "./index.js",
+    "./*": "./configs/*.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": "^24.21.0"
+  },
+  "peerDependencies": {
+    "prettier": "^3"
+  }
+}