@noodlestan/prettier-config 0.0.0-stage → 0.1.0

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Noodlestan
+
+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,61 @@
-# Temporary Holding Version
+# Noodlestan Prettier 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.
+> Noodlestan's canonical base Prettier formatting configuration.
+
+## Usage
+
+Install the package alongside [Prettier](https://prettier.io/):
+
+```bash
+npm install --save-dev @noodlestan/prettier-config prettier
+```
+
+Then point your repository or package at the config from the `prettier` field of your `package.json`:
+
+```json
+{
+  "prettier": "@noodlestan/prettier-config"
+}
+```
+
+**⚠️ Note:** delete your repository's or library's own `.prettierrc` (or `.prettierrc.json`,
+`.prettierrc.js`, …). A local Prettier config file shadows the `prettier` field of
+`package.json`.
+
+### Peer Depedencies
+
+The `prettier` package is a peer dependencies of this package and must be installed in the target project.
+
+## Rules
+
+The configuration resolves to the following rules:
+
+| Rule            | Value     |
+| --------------- | --------- |
+| `useTabs`       | `false`   |
+| `printWidth`    | `100`     |
+| `tabWidth`      | `2`       |
+| `semi`          | `true`    |
+| `singleQuote`   | `true`    |
+| `trailingComma` | `"all"`   |
+| `arrowParens`   | `"avoid"` |
+
+An `overrides` entry sets `useTabs: true` for `*.js`, `*.cjs`, `*.mjs`, `*.mts`,
+`*.ts` and `*.tsx`.
+
+## Development
+
+Make sure you read the [root README](../../README.md) first.
+
+### Scripts
+
+Run from this package directory:
+
+- `npm run lint` — report prettier issues
+- `npm run lint:fix` — fix formatting and lint issues
+
+## License
+
+Copyright (c) 2026 [Noodlestan](https://noodlestan.org/).
+
+Published under a [MIT license](https://noodlestan.mit-license.org/).

package/package.json

@@ -1,6 +1,31 @@
 {
   "name": "@noodlestan/prettier-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Noodlestan's base Prettier formatting configuration.",
+  "author": "Noodlestan Collective",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./src/index.cjs",
+  "prettier": "./src/index.cjs",
+  "exports": {
+    ".": "./src/index.cjs",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE-MIT"
+  ],
+  "scripts": {
+    "lint": "prettier . -c",
+    "lint:fix": "prettier . -c --write",
+    "test": "echo no tests yet",
+    "ci": "npm run lint"
+  },
+  "peerDependencies": {
+    "prettier": "^3.8.4"
+  }
+}

package/src/index.cjs

@@ -0,0 +1,23 @@
+module.exports = {
+	useTabs: false,
+	printWidth: 100,
+	tabWidth: 2,
+	semi: true,
+	singleQuote: true,
+	trailingComma: 'all',
+	arrowParens: 'avoid',
+	overrides: [
+		{
+			files: ['*.art', '*.tart'],
+			options: {
+				parser: 'markdown',
+			},
+		},
+		{
+			files: ['*.js', '*.cjs', '*.mjs', '*.ts', '*.mts', '*.tsx'],
+			options: {
+				useTabs: true,
+			},
+		},
+	],
+};