@jmlweb/prettier-config-base 1.0.0

package/README.md

@@ -0,0 +1,137 @@
+# @jmlweb/prettier-config-base
+
+[![npm version](https://img.shields.io/npm/v/@jmlweb/prettier-config-base)](https://www.npmjs.com/package/@jmlweb/prettier-config-base)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-339933.svg)](https://nodejs.org/)
+
+> Base Prettier configuration package that provides shared formatting rules for consistent code style across projects.
+
+## ✨ Features
+
+- 🎯 **Consistent Formatting**: Standardized code style across all projects
+- 🔧 **Zero Configuration**: Works out of the box with sensible defaults
+- 📦 **Extensible**: Foundation for framework-specific Prettier configs
+- 🚀 **Modern Defaults**: Optimized for modern JavaScript/TypeScript projects
+
+## 📦 Installation
+
+```bash
+npm install --save-dev @jmlweb/prettier-config-base prettier
+```
+
+## 🚀 Quick Start
+
+### Option 1: Using `package.json` (Recommended)
+
+Add to your `package.json`:
+
+```json
+{
+  "prettier": "@jmlweb/prettier-config-base"
+}
+```
+
+### Option 2: Using `.prettierrc.js`
+
+Create a `.prettierrc.js` file in your project root:
+
+```javascript
+module.exports = require('@jmlweb/prettier-config-base');
+```
+
+### Option 3: Using `.prettierrc.json`
+
+Create a `.prettierrc.json` file:
+
+```json
+"@jmlweb/prettier-config-base"
+```
+
+## 📋 Configuration
+
+This package provides the following Prettier settings:
+
+| Option          | Value        | Description                                |
+| --------------- | ------------ | ------------------------------------------ |
+| `semi`          | `true`       | Use semicolons at the end of statements    |
+| `singleQuote`   | `true`       | Use single quotes instead of double quotes |
+| `tabWidth`      | `2`          | Use 2 spaces for indentation               |
+| `trailingComma` | `'all'`      | Add trailing commas wherever possible      |
+| `useTabs`       | `false`      | Use spaces instead of tabs                 |
+| `endOfLine`     | `'lf'`       | Use LF line endings (Unix-style)           |
+| `proseWrap`     | `'preserve'` | Preserve prose wrapping in markdown files  |
+
+## 💡 Examples
+
+### Before Formatting
+
+```javascript
+const user = { name: 'John', age: 30, email: 'john@example.com' };
+function greet(user) {
+  return 'Hello, ' + user.name + '!';
+}
+```
+
+### After Formatting
+
+```javascript
+const user = {
+  name: 'John',
+  age: 30,
+  email: 'john@example.com',
+};
+
+function greet(user) {
+  return 'Hello, ' + user.name + '!';
+}
+```
+
+## 🔧 Usage with Scripts
+
+Add formatting scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
+    "format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,md}\""
+  }
+}
+```
+
+Then run:
+
+```bash
+npm run format        # Format all files
+npm run format:check  # Check formatting without modifying files
+```
+
+## 🎨 Extending the Configuration
+
+You can extend this config for project-specific needs:
+
+```javascript
+// .prettierrc.js
+const baseConfig = require('@jmlweb/prettier-config-base');
+
+module.exports = {
+  ...baseConfig,
+  // Override or add specific options
+  printWidth: 100,
+  arrowParens: 'always',
+};
+```
+
+## 🔗 Related Packages
+
+- [`@jmlweb/prettier-config-tailwind`](../prettier-config-tailwind) - Adds Tailwind CSS class sorting
+- [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint config that works seamlessly with this Prettier config
+
+## 📝 Requirements
+
+- **Node.js** >= 18.0.0
+- **Prettier** >= 3.0.0
+
+## 📄 License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,35 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var config = {
+  semi: true,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: "all",
+  useTabs: false,
+  endOfLine: "lf",
+  proseWrap: "preserve"
+};
+var index_default = config;

package/dist/index.d.cts

@@ -0,0 +1,5 @@
+import { Config } from 'prettier';
+
+declare const config: Config;
+
+export { config as default };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { Config } from 'prettier';
+
+declare const config: Config;
+
+export { config as default };

package/dist/index.js

@@ -0,0 +1,14 @@
+// src/index.ts
+var config = {
+  semi: true,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: "all",
+  useTabs: false,
+  endOfLine: "lf",
+  proseWrap: "preserve"
+};
+var index_default = config;
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@jmlweb/prettier-config-base",
+  "version": "1.0.0",
+  "description": "Base Prettier configuration for jmlweb projects",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "pnpm build"
+  },
+  "keywords": [
+    "prettier",
+    "prettier-config",
+    "code-formatter"
+  ],
+  "author": "jmlweb",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jmlweb/tooling.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jmlweb/tooling/issues"
+  },
+  "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/prettier-config-base#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "prettier": "^3.0.0"
+  },
+  "devDependencies": {
+    "@jmlweb/tsconfig-internal": "workspace:*",
+    "prettier": "^3.3.3",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}