@aryaemami59/prettier-config 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Arya Emami
+
+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,88 @@
+# @aryaemami59/prettier-config
+
+Prettier configuration.
+
+## Installation
+
+#### NPM
+
+```bash
+npm install --save-dev @aryaemami59/prettier-config
+```
+
+#### Yarn
+
+```bash
+yarn add --dev @aryaemami59/prettier-config
+```
+
+#### PNPM
+
+```bash
+pnpm add --save-dev @aryaemami59/prettier-config
+```
+
+#### Bun
+
+```bash
+bun add --dev @aryaemami59/prettier-config
+```
+
+## Usage
+
+**ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`**:
+
+```js
+import { prettierConfig } from '@aryaemami59/prettier-config'
+
+export default prettierConfig
+```
+
+**CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)**:
+
+```js
+const { prettierConfig } = require('@aryaemami59/prettier-config')
+
+module.exports = prettierConfig
+```
+
+**CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)**:
+
+```js
+module.exports = (async () =>
+  (await import('@aryaemami59/prettier-config')).prettierConfig)()
+```
+
+To avoid having to write JSDocs we also provide a `createPrettierConfig` function. This function already includes the default `prettierConfig` and you can pass in additional overrides as an argument.
+
+**ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`**:
+
+```js
+import { createPrettierConfig } from '@aryaemami59/prettier-config'
+
+export default createPrettierConfig({
+  arrowParens: 'avoid',
+  // ...Other additional overrides
+})
+```
+
+**CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)**:
+
+```js
+const { createPrettierConfig } = require('@aryaemami59/prettier-config')
+
+module.exports = createPrettierConfig({
+  arrowParens: 'avoid',
+  // ...Other additional overrides
+})
+```
+
+**CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)**:
+
+```js
+module.exports = (async () =>
+  (await import('@aryaemami59/prettier-config')).createPrettierConfig({
+    arrowParens: 'avoid',
+    // ...Other additional overrides
+  }))()
+```

package/dist/index.cjs

@@ -0,0 +1,37 @@
+"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 src_exports = {};
+__export(src_exports, {
+  createPrettierConfig: () => createPrettierConfig,
+  prettierConfig: () => prettierConfig
+});
+module.exports = __toCommonJS(src_exports);
+var prettierConfig = {
+  semi: false,
+  singleQuote: true
+};
+var createPrettierConfig = (additionalOverrides = {}) => ({ ...prettierConfig, ...additionalOverrides });
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPrettierConfig,
+  prettierConfig
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Config } from 'prettier'\n\n/**\n * Prettier configuration.\n *\n * @example\n * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>\n *\n * ```js\n * import { prettierConfig } from '@aryaemami59/prettier-config'\n *\n * export default prettierConfig\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>\n *\n * ```js\n * const { prettierConfig } = require('@aryaemami59/prettier-config')\n *\n * module.exports = prettierConfig\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>\n *\n * ```js\n * module.exports = (async () =>\n *   (await import('@aryaemami59/prettier-config')).prettierConfig)()\n * ```\n *\n * @public\n * @since 0.0.3\n */\nexport const prettierConfig: Config = {\n  semi: false,\n  singleQuote: true,\n}\n\n/**\n * A function that returns {@linkcode prettierConfig}\n * along with optional additional overrides.\n * It's made mainly to provide intellisense and eliminate\n * the need for manual type annotations using JSDoc comments.\n *\n * @param additionalOverrides - Optional additional overrides to apply to the configuration.\n * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.\n *\n * @example\n * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>\n *\n * ```js\n * import { createPrettierConfig } from '@aryaemami59/prettier-config'\n *\n * export default createPrettierConfig({\n *   arrowParens: 'avoid',\n *   // ...Other additional overrides\n * })\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>\n *\n * ```js\n * const { createPrettierConfig } = require('@aryaemami59/prettier-config')\n *\n * module.exports = createPrettierConfig({\n *   arrowParens: 'avoid',\n *   // ...Other additional overrides\n * })\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>\n *\n * ```js\n * module.exports = (async () =>\n *   (await import('@aryaemami59/prettier-config')).createPrettierConfig({\n *     arrowParens: 'avoid',\n *     // ...Other additional overrides\n *   }))()\n * ```\n *\n * @public\n * @since 0.0.3\n */\nexport const createPrettierConfig = (\n  additionalOverrides: Config = {},\n): Config => ({ ...prettierConfig, ...additionalOverrides })\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkCO,IAAM,iBAAyB;AAAA,EACpC,MAAM;AAAA,EACN,aAAa;AACf;AAiDO,IAAM,uBAAuB,CAClC,sBAA8B,CAAC,OACnB,EAAE,GAAG,gBAAgB,GAAG,oBAAoB;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,85 @@
+import { Config } from 'prettier';
+
+/**
+ * Prettier configuration.
+ *
+ * @example
+ * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
+ *
+ * ```js
+ * import { prettierConfig } from '@aryaemami59/prettier-config'
+ *
+ * export default prettierConfig
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
+ *
+ * ```js
+ * const { prettierConfig } = require('@aryaemami59/prettier-config')
+ *
+ * module.exports = prettierConfig
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
+ *
+ * ```js
+ * module.exports = (async () =>
+ *   (await import('@aryaemami59/prettier-config')).prettierConfig)()
+ * ```
+ *
+ * @public
+ * @since 0.0.3
+ */
+declare const prettierConfig: Config;
+/**
+ * A function that returns {@linkcode prettierConfig}
+ * along with optional additional overrides.
+ * It's made mainly to provide intellisense and eliminate
+ * the need for manual type annotations using JSDoc comments.
+ *
+ * @param additionalOverrides - Optional additional overrides to apply to the configuration.
+ * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.
+ *
+ * @example
+ * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
+ *
+ * ```js
+ * import { createPrettierConfig } from '@aryaemami59/prettier-config'
+ *
+ * export default createPrettierConfig({
+ *   arrowParens: 'avoid',
+ *   // ...Other additional overrides
+ * })
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
+ *
+ * ```js
+ * const { createPrettierConfig } = require('@aryaemami59/prettier-config')
+ *
+ * module.exports = createPrettierConfig({
+ *   arrowParens: 'avoid',
+ *   // ...Other additional overrides
+ * })
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
+ *
+ * ```js
+ * module.exports = (async () =>
+ *   (await import('@aryaemami59/prettier-config')).createPrettierConfig({
+ *     arrowParens: 'avoid',
+ *     // ...Other additional overrides
+ *   }))()
+ * ```
+ *
+ * @public
+ * @since 0.0.3
+ */
+declare const createPrettierConfig: (additionalOverrides?: Config) => Config;
+
+export { createPrettierConfig, prettierConfig };

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+import { Config } from 'prettier';
+
+/**
+ * Prettier configuration.
+ *
+ * @example
+ * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
+ *
+ * ```js
+ * import { prettierConfig } from '@aryaemami59/prettier-config'
+ *
+ * export default prettierConfig
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
+ *
+ * ```js
+ * const { prettierConfig } = require('@aryaemami59/prettier-config')
+ *
+ * module.exports = prettierConfig
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
+ *
+ * ```js
+ * module.exports = (async () =>
+ *   (await import('@aryaemami59/prettier-config')).prettierConfig)()
+ * ```
+ *
+ * @public
+ * @since 0.0.3
+ */
+declare const prettierConfig: Config;
+/**
+ * A function that returns {@linkcode prettierConfig}
+ * along with optional additional overrides.
+ * It's made mainly to provide intellisense and eliminate
+ * the need for manual type annotations using JSDoc comments.
+ *
+ * @param additionalOverrides - Optional additional overrides to apply to the configuration.
+ * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.
+ *
+ * @example
+ * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
+ *
+ * ```js
+ * import { createPrettierConfig } from '@aryaemami59/prettier-config'
+ *
+ * export default createPrettierConfig({
+ *   arrowParens: 'avoid',
+ *   // ...Other additional overrides
+ * })
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
+ *
+ * ```js
+ * const { createPrettierConfig } = require('@aryaemami59/prettier-config')
+ *
+ * module.exports = createPrettierConfig({
+ *   arrowParens: 'avoid',
+ *   // ...Other additional overrides
+ * })
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
+ *
+ * ```js
+ * module.exports = (async () =>
+ *   (await import('@aryaemami59/prettier-config')).createPrettierConfig({
+ *     arrowParens: 'avoid',
+ *     // ...Other additional overrides
+ *   }))()
+ * ```
+ *
+ * @public
+ * @since 0.0.3
+ */
+declare const createPrettierConfig: (additionalOverrides?: Config) => Config;
+
+export { createPrettierConfig, prettierConfig };

package/dist/index.js

@@ -0,0 +1,11 @@
+// src/index.ts
+var prettierConfig = {
+  semi: false,
+  singleQuote: true
+};
+var createPrettierConfig = (additionalOverrides = {}) => ({ ...prettierConfig, ...additionalOverrides });
+export {
+  createPrettierConfig,
+  prettierConfig
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Config } from 'prettier'\n\n/**\n * Prettier configuration.\n *\n * @example\n * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>\n *\n * ```js\n * import { prettierConfig } from '@aryaemami59/prettier-config'\n *\n * export default prettierConfig\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>\n *\n * ```js\n * const { prettierConfig } = require('@aryaemami59/prettier-config')\n *\n * module.exports = prettierConfig\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>\n *\n * ```js\n * module.exports = (async () =>\n *   (await import('@aryaemami59/prettier-config')).prettierConfig)()\n * ```\n *\n * @public\n * @since 0.0.3\n */\nexport const prettierConfig: Config = {\n  semi: false,\n  singleQuote: true,\n}\n\n/**\n * A function that returns {@linkcode prettierConfig}\n * along with optional additional overrides.\n * It's made mainly to provide intellisense and eliminate\n * the need for manual type annotations using JSDoc comments.\n *\n * @param additionalOverrides - Optional additional overrides to apply to the configuration.\n * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.\n *\n * @example\n * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>\n *\n * ```js\n * import { createPrettierConfig } from '@aryaemami59/prettier-config'\n *\n * export default createPrettierConfig({\n *   arrowParens: 'avoid',\n *   // ...Other additional overrides\n * })\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>\n *\n * ```js\n * const { createPrettierConfig } = require('@aryaemami59/prettier-config')\n *\n * module.exports = createPrettierConfig({\n *   arrowParens: 'avoid',\n *   // ...Other additional overrides\n * })\n * ```\n *\n * @example\n * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>\n *\n * ```js\n * module.exports = (async () =>\n *   (await import('@aryaemami59/prettier-config')).createPrettierConfig({\n *     arrowParens: 'avoid',\n *     // ...Other additional overrides\n *   }))()\n * ```\n *\n * @public\n * @since 0.0.3\n */\nexport const createPrettierConfig = (\n  additionalOverrides: Config = {},\n): Config => ({ ...prettierConfig, ...additionalOverrides })\n"],"mappings":";AAkCO,IAAM,iBAAyB;AAAA,EACpC,MAAM;AAAA,EACN,aAAa;AACf;AAiDO,IAAM,uBAAuB,CAClC,sBAA8B,CAAC,OACnB,EAAE,GAAG,gBAAgB,GAAG,oBAAoB;","names":[]}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@aryaemami59/prettier-config",
+  "version": "0.0.3",
+  "description": "Prettier configuration",
+  "keywords": [
+    "prettier",
+    "config",
+    "prettier-config",
+    "configuration"
+  ],
+  "homepage": "https://github.com/aryaemami59/configs/tree/master/packages/prettier#readme",
+  "bugs": {
+    "url": "https://github.com/aryaemami59/configs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aryaemami59/configs.git",
+    "directory": "packages/prettier"
+  },
+  "license": "MIT",
+  "author": "Arya Emami <aryaemami59@yahoo.com> (https://github.com/aryaemami59)",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "bun": {
+        "types": "./dist/index.d.ts",
+        "default": "./src/index.ts"
+      },
+      "module-sync": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "module": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "default": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "yarn clean && tsup",
+    "check-exports": "attw --pack",
+    "check-package-json": "publint --strict .",
+    "clean": "rimraf dist",
+    "prepack": "yarn build"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.0",
+    "@aryaemami59/tsconfig": "^0.0.3",
+    "prettier": "^3.3.3",
+    "publint": "^0.2.12",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "prettier": ">=3"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/src/index.ts

@@ -0,0 +1,89 @@
+import type { Config } from 'prettier'
+
+/**
+ * Prettier configuration.
+ *
+ * @example
+ * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
+ *
+ * ```js
+ * import { prettierConfig } from '@aryaemami59/prettier-config'
+ *
+ * export default prettierConfig
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
+ *
+ * ```js
+ * const { prettierConfig } = require('@aryaemami59/prettier-config')
+ *
+ * module.exports = prettierConfig
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
+ *
+ * ```js
+ * module.exports = (async () =>
+ *   (await import('@aryaemami59/prettier-config')).prettierConfig)()
+ * ```
+ *
+ * @public
+ * @since 0.0.3
+ */
+export const prettierConfig: Config = {
+  semi: false,
+  singleQuote: true,
+}
+
+/**
+ * A function that returns {@linkcode prettierConfig}
+ * along with optional additional overrides.
+ * It's made mainly to provide intellisense and eliminate
+ * the need for manual type annotations using JSDoc comments.
+ *
+ * @param additionalOverrides - Optional additional overrides to apply to the configuration.
+ * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.
+ *
+ * @example
+ * <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
+ *
+ * ```js
+ * import { createPrettierConfig } from '@aryaemami59/prettier-config'
+ *
+ * export default createPrettierConfig({
+ *   arrowParens: 'avoid',
+ *   // ...Other additional overrides
+ * })
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
+ *
+ * ```js
+ * const { createPrettierConfig } = require('@aryaemami59/prettier-config')
+ *
+ * module.exports = createPrettierConfig({
+ *   arrowParens: 'avoid',
+ *   // ...Other additional overrides
+ * })
+ * ```
+ *
+ * @example
+ * <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
+ *
+ * ```js
+ * module.exports = (async () =>
+ *   (await import('@aryaemami59/prettier-config')).createPrettierConfig({
+ *     arrowParens: 'avoid',
+ *     // ...Other additional overrides
+ *   }))()
+ * ```
+ *
+ * @public
+ * @since 0.0.3
+ */
+export const createPrettierConfig = (
+  additionalOverrides: Config = {},
+): Config => ({ ...prettierConfig, ...additionalOverrides })