@aryaemami59/prettier-config 0.0.4 → 0.0.5

package/dist/index.cjs

@@ -24,10 +24,14 @@ __export(src_exports, {
   prettierConfig: () => prettierConfig
 });
 module.exports = __toCommonJS(src_exports);
+
+// src/defaults.ts
 var prettierConfig = {
   semi: false,
   singleQuote: true
 };
+
+// src/utils.ts
 var createPrettierConfig = (additionalOverrides = {}) => ({ ...prettierConfig, ...additionalOverrides });
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.cjs.map

@@ -1 +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":[]}
+{"version":3,"sources":["../src/index.ts","../src/defaults.ts","../src/utils.ts"],"sourcesContent":["export { prettierConfig } from './defaults.js'\nexport { createPrettierConfig } from './utils.js'\n","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 = {\n  semi: false,\n  singleQuote: true,\n} as const satisfies Config\n","import type { Config } from 'prettier'\nimport { prettierConfig } from './defaults.js'\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;;;ACkCO,IAAM,iBAAiB;AAAA,EAC5B,MAAM;AAAA,EACN,aAAa;AACf;;;ACaO,IAAM,uBAAuB,CAClC,sBAA8B,CAAC,OACnB,EAAE,GAAG,gBAAgB,GAAG,oBAAoB;","names":[]}

package/dist/index.d.cts

@@ -32,14 +32,18 @@ import { Config } from 'prettier';
  * @public
  * @since 0.0.3
  */
-declare const prettierConfig: Config;
+declare const prettierConfig: {
+    readonly semi: false;
+    readonly 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.
+ * @param [additionalOverrides] - **Optional** additional overrides to apply to the configuration.
  * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.
  *
  * @example

package/dist/index.d.ts

@@ -32,14 +32,18 @@ import { Config } from 'prettier';
  * @public
  * @since 0.0.3
  */
-declare const prettierConfig: Config;
+declare const prettierConfig: {
+    readonly semi: false;
+    readonly 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.
+ * @param [additionalOverrides] - **Optional** additional overrides to apply to the configuration.
  * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.
  *
  * @example

package/dist/index.js

@@ -1,8 +1,10 @@
-// src/index.ts
+// src/defaults.ts
 var prettierConfig = {
   semi: false,
   singleQuote: true
 };
+
+// src/utils.ts
 var createPrettierConfig = (additionalOverrides = {}) => ({ ...prettierConfig, ...additionalOverrides });
 export {
   createPrettierConfig,

package/dist/index.js.map

@@ -1 +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":[]}
+{"version":3,"sources":["../src/defaults.ts","../src/utils.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 = {\n  semi: false,\n  singleQuote: true,\n} as const satisfies Config\n","import type { Config } from 'prettier'\nimport { prettierConfig } from './defaults.js'\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,iBAAiB;AAAA,EAC5B,MAAM;AAAA,EACN,aAAa;AACf;;;ACaO,IAAM,uBAAuB,CAClC,sBAA8B,CAAC,OACnB,EAAE,GAAG,gBAAgB,GAAG,oBAAoB;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aryaemami59/prettier-config",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Prettier configuration",
   "keywords": [
     "prettier",
@@ -55,20 +55,25 @@
     "src"
   ],
   "scripts": {
-    "build": "yarn clean && tsup",
-    "check-exports": "attw --pack",
-    "check-package-json": "publint --strict .",
-    "clean": "rimraf dist",
-    "prepack": "yarn build"
+    "build": "tsup --config=$INIT_CWD/tsup.config.mts",
+    "check-exports": "attw --pack $INIT_CWD",
+    "check-package-json": "publint --strict $INIT_CWD",
+    "clean": "rimraf $INIT_CWD/dist/",
+    "format-check": "yarn run -T format-check",
+    "format": "yarn run -T format",
+    "lint-fix": "yarn run -T lint-fix",
+    "lint": "yarn run -T lint",
+    "prepack": "yarn clean && yarn build",
+    "test-types": "tsc -p $INIT_CWD/tsconfig.json"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.0",
-    "@aryaemami59/tsconfig": "^0.0.4",
-    "prettier": "^3.3.3",
-    "publint": "^0.2.12",
+    "@arethetypeswrong/cli": "^0.18.1",
+    "@aryaemami59/tsconfig": "^0.0.5",
+    "prettier": "^3.5.3",
+    "publint": "^0.3.12",
     "rimraf": "^6.0.1",
-    "tsup": "^8.3.5",
-    "typescript": "^5.6.3"
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "prettier": ">=3"

package/src/defaults.ts

@@ -0,0 +1,38 @@
+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 = {
+  semi: false,
+  singleQuote: true,
+} as const satisfies Config

package/src/index.ts

@@ -1,89 +1,2 @@
-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 })
+export { prettierConfig } from './defaults.js'
+export { createPrettierConfig } from './utils.js'

package/src/utils.ts

@@ -0,0 +1,53 @@
+import type { Config } from 'prettier'
+import { prettierConfig } from './defaults.js'
+
+/**
+ * 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 })