@langri-sha/projen-prettier 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,20 @@
+{
+  "name": "@langri-sha/projen-prettier",
+  "entries": [
+    {
+      "date": "Mon, 27 May 2024 03:22:54 GMT",
+      "version": "0.1.0",
+      "tag": "@langri-sha/projen-prettier_v0.1.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-prettier",
+            "commit": "46f1a1df1a3c4e63293027640c917472274d082e",
+            "comment": "feat(prettier): Add support for configuring Prettier"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log - @langri-sha/projen-prettier
+
+This log was last generated on Mon, 27 May 2024 03:22:54 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.1.0
+
+Mon, 27 May 2024 03:22:54 GMT
+
+### Minor changes
+
+- feat(prettier): Add support for configuring Prettier (filip.dupanovic@gmail.com)

package/lib/index.d.ts

@@ -0,0 +1,33 @@
+import type { Config } from 'prettier';
+import { FileBase, IResolver, IgnoreFile, Project } from 'projen';
+/**
+ * Options for configuring Prettier.
+ */
+export interface PrettierOptions {
+    /**
+     * Name of the Prettier config module.
+     *
+     * @default 'prettier.config.js'
+     */
+    filename?: string;
+    /**
+     * Name of the Prettier configuration package to extend from.
+     */
+    extends?: string;
+    /**
+     * Ignore patterns.
+     */
+    ignorePatterns?: string[];
+    /**
+     * Prettier configuration object.
+     */
+    config?: Config;
+}
+export declare class Prettier extends FileBase {
+    #private;
+    ignore: IgnoreFile;
+    config: Config;
+    constructor(project: Project, options?: PrettierOptions);
+    protected synthesizeContent(_: IResolver): string | undefined;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEjE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,qBAAa,QAAS,SAAQ,QAAQ;;IAEpC,MAAM,EAAE,UAAU,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;gBAEF,OAAO,EAAE,OAAO,EAAE,OAAO,GAAE,eAAoB;cAexC,iBAAiB,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;CAevE"}

package/lib/index.js

@@ -0,0 +1,44 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Prettier_extends;
+import serialize from 'serialize-javascript';
+import { FileBase, IgnoreFile } from 'projen';
+export class Prettier extends FileBase {
+    constructor(project, options = {}) {
+        const filename = options.filename ?? 'prettier.config.js';
+        super(project, filename, {
+            readonly: true,
+            marker: true,
+        });
+        _Prettier_extends.set(this, void 0);
+        __classPrivateFieldSet(this, _Prettier_extends, options.extends, "f");
+        this.config = options.config ?? {};
+        this.ignore = new IgnoreFile(project, '.prettierignore', {
+            ignorePatterns: options.ignorePatterns,
+        });
+    }
+    synthesizeContent(_) {
+        const config = {
+            ...this.config,
+        };
+        const serialized = serialize(config);
+        return `${__classPrivateFieldGet(this, _Prettier_extends, "f") ? `import defaults from '${__classPrivateFieldGet(this, _Prettier_extends, "f")}'\n\n` : ''}/** @type {import("prettier").Config} */
+    const config = {
+      ${__classPrivateFieldGet(this, _Prettier_extends, "f") ? `...defaults,` : ''}
+      ${serialized.slice(1)}
+
+    export default config
+    `;
+    }
+}
+_Prettier_extends = new WeakMap();
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,SAAS,MAAM,sBAAsB,CAAA;AAE5C,OAAO,EAAE,QAAQ,EAAa,UAAU,EAAW,MAAM,QAAQ,CAAA;AA6BjE,MAAM,OAAO,QAAS,SAAQ,QAAQ;IAKpC,YAAY,OAAgB,EAAE,UAA2B,EAAE;QACzD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,oBAAoB,CAAA;QAEzD,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;YACvB,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;QAVJ,oCAAiB;QAYf,uBAAA,IAAI,qBAAY,OAAO,CAAC,OAAO,MAAA,CAAA;QAC/B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE;YACvD,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAA;IACJ,CAAC;IAEkB,iBAAiB,CAAC,CAAY;QAC/C,MAAM,MAAM,GAAW;YACrB,GAAG,IAAI,CAAC,MAAM;SACf,CAAA;QAED,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;QAEpC,OAAO,GAAG,uBAAA,IAAI,yBAAS,CAAC,CAAC,CAAC,yBAAyB,uBAAA,IAAI,yBAAS,OAAO,CAAC,CAAC,CAAC,EAAE;;QAExE,uBAAA,IAAI,yBAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE;QACnC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;;;KAGtB,CAAA;IACH,CAAC;CACF"}

package/license

@@ -0,0 +1,10 @@
+
+MIT License
+
+Copyright (c) 2024 Filip Dupanović <filip.dupanovic@gmail.com> (https://langri-sha.com)
+
+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/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@langri-sha/projen-prettier",
+  "version": "0.1.0",
+  "license": "MIT",
+  "author": {
+    "name": "Filip Dupanović",
+    "email": "filip.dupanovic@gmail.com",
+    "url": "https://langri-sha.com",
+    "organization": false
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "scripts": {
+    "prepublishOnly": "rm -rf lib; tsc --project tsconfig.build.json"
+  },
+  "dependencies": {
+    "serialize-javascript": "6.0.2"
+  },
+  "devDependencies": {
+    "@langri-sha/jest-test": "0.7.1",
+    "@langri-sha/tsconfig": "0.9.0",
+    "@types/serialize-javascript": "5.0.4",
+    "prettier": "3.0.0",
+    "projen": "0.81.15"
+  },
+  "peerDependencies": {
+    "prettier": "^3.0.0",
+    "projen": "^0.81.15"
+  },
+  "engines": {
+    "node": ">= 20.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "//": "~~ Generated by projen. To modify, edit .projenrc.mts and run \"npx projen\".",
+  "types": "lib/index.d.ts"
+}

package/readme

@@ -0,0 +1,32 @@
+# @langri-sha/projen-prettier
+
+A [projen] component for configuring [Prettier].
+
+## Usage
+
+Install dependencies:
+
+```sh
+npm install -D projen @langri-sha/projen-prettier
+```
+
+Then, create an `Prettier` component for your project:
+
+```js
+import { Project } from 'projen'
+import { License } from '@langri-sha/projen-prettier'
+
+const project = new Project({
+  name: 'my-project',
+})
+
+new Prettier(project, {
+  filename: '',
+  spdx: 'MIT',
+  copyrightHolder: 'John Smith <john.smith@example.com>',
+  copyrightYear: '2000',
+})
+```
+
+[prettier]: https://prettier.io/docs/en/
+[projen]: https://projen.io/

package/src/index.ts

@@ -0,0 +1,67 @@
+import serialize from 'serialize-javascript'
+import type { Config } from 'prettier'
+import { FileBase, IResolver, IgnoreFile, Project } from 'projen'
+
+/**
+ * Options for configuring Prettier.
+ */
+export interface PrettierOptions {
+  /**
+   * Name of the Prettier config module.
+   *
+   * @default 'prettier.config.js'
+   */
+  filename?: string
+
+  /**
+   * Name of the Prettier configuration package to extend from.
+   */
+  extends?: string
+
+  /**
+   * Ignore patterns.
+   */
+  ignorePatterns?: string[]
+
+  /**
+   * Prettier configuration object.
+   */
+  config?: Config
+}
+
+export class Prettier extends FileBase {
+  #extends?: string
+  ignore: IgnoreFile
+  config: Config
+
+  constructor(project: Project, options: PrettierOptions = {}) {
+    const filename = options.filename ?? 'prettier.config.js'
+
+    super(project, filename, {
+      readonly: true,
+      marker: true,
+    })
+
+    this.#extends = options.extends
+    this.config = options.config ?? {}
+    this.ignore = new IgnoreFile(project, '.prettierignore', {
+      ignorePatterns: options.ignorePatterns,
+    })
+  }
+
+  protected override synthesizeContent(_: IResolver): string | undefined {
+    const config: Config = {
+      ...this.config,
+    }
+
+    const serialized = serialize(config)
+
+    return `${this.#extends ? `import defaults from '${this.#extends}'\n\n` : ''}/** @type {import("prettier").Config} */
+    const config = {
+      ${this.#extends ? `...defaults,` : ''}
+      ${serialized.slice(1)}
+
+    export default config
+    `
+  }
+}