@dotcom-tool-kit/prettier 1.0.2-beta.1

package/.toolkitrc.yml

@@ -0,0 +1,3 @@
+hooks:
+  'format:local': Prettier
+  'format:staged': Prettier

package/lib/index.d.ts

@@ -0,0 +1,13 @@
+import { PackageJsonHook } from '@dotcom-tool-kit/package-json-hook';
+import Prettier from './tasks/prettier';
+export declare const tasks: (typeof Prettier)[];
+declare class FormatLocal extends PackageJsonHook {
+    static description: string;
+    key: string;
+    hook: string;
+}
+export declare const hooks: {
+    'format:local': typeof FormatLocal;
+};
+export {};
+//# 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":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AACpE,OAAO,QAAQ,MAAM,kBAAkB,CAAA;AAEvC,eAAO,MAAM,KAAK,qBAAa,CAAA;AAE/B,cAAM,WAAY,SAAQ,eAAe;IACvC,MAAM,CAAC,WAAW,SAAoB;IAEtC,GAAG,SAAW;IACd,IAAI,SAAiB;CACtB;AAED,eAAO,MAAM,KAAK;;CAEjB,CAAA"}

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hooks = exports.tasks = void 0;
+const tslib_1 = require("tslib");
+const package_json_hook_1 = require("@dotcom-tool-kit/package-json-hook");
+const prettier_1 = (0, tslib_1.__importDefault)(require("./tasks/prettier"));
+exports.tasks = [prettier_1.default];
+class FormatLocal extends package_json_hook_1.PackageJsonHook {
+    constructor() {
+        super(...arguments);
+        this.key = 'format';
+        this.hook = `format:local`;
+    }
+}
+FormatLocal.description = 'format prettier';
+exports.hooks = {
+    'format:local': FormatLocal
+};

package/lib/tasks/prettier.d.ts

@@ -0,0 +1,9 @@
+import { PrettierOptions, PrettierSchema } from '@dotcom-tool-kit/types/lib/schema/prettier';
+import { Task } from '@dotcom-tool-kit/types';
+export default class Prettier extends Task<typeof PrettierSchema> {
+    static description: string;
+    static defaultOptions: PrettierOptions;
+    run(files?: string[]): Promise<void>;
+    formatFile: (filepath: string, options: PrettierOptions) => Promise<void>;
+}
+//# sourceMappingURL=prettier.d.ts.map

package/lib/tasks/prettier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prettier.d.ts","sourceRoot":"","sources":["../../src/tasks/prettier.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAI5F,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAG7C,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,IAAI,CAAC,OAAO,cAAc,CAAC;IAC/D,MAAM,CAAC,WAAW,SAAK;IAEvB,MAAM,CAAC,cAAc,EAAE,eAAe,CASrC;IAEK,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB1C,UAAU,aAAoB,MAAM,WAAW,eAAe,KAAG,QAAQ,IAAI,CAAC,CAgC7E;CACF"}

package/lib/tasks/prettier.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const prettier_1 = (0, tslib_1.__importDefault)(require("prettier"));
+const fs_1 = require("fs");
+const fast_glob_1 = (0, tslib_1.__importDefault)(require("fast-glob"));
+const logger_1 = require("@dotcom-tool-kit/logger");
+const types_1 = require("@dotcom-tool-kit/types");
+const error_1 = require("@dotcom-tool-kit/error");
+class Prettier extends types_1.Task {
+    constructor() {
+        super(...arguments);
+        this.formatFile = async (filepath, options) => {
+            const fileContent = await fs_1.promises.readFile(filepath, 'utf8');
+            let prettierConfig;
+            try {
+                prettierConfig = await prettier_1.default.resolveConfig(filepath, { config: options.configFile });
+            }
+            catch (err) {
+                if (err.code !== 'ENOENT') {
+                    const error = new error_1.ToolKitError('there was an error when resolving the prettier config');
+                    if (err instanceof Error) {
+                        error.details = err.message;
+                    }
+                    throw error;
+                }
+            }
+            if (!prettierConfig && options.configOptions) {
+                this.logger.warn(`prettier could not find the specified configFile${options.configFile ? ` (${logger_1.styles.filepath(options.configFile)})` : ''}), using ${logger_1.styles.option('configOptions')} instead`);
+                prettierConfig = options.configOptions;
+            }
+            const unhook = (0, logger_1.hookConsole)(this.logger, 'prettier');
+            try {
+                await fs_1.promises.writeFile(filepath, prettier_1.default.format(fileContent, { ...prettierConfig, filepath }));
+            }
+            finally {
+                unhook();
+            }
+        };
+    }
+    async run(files) {
+        try {
+            const filepaths = await (0, fast_glob_1.default)(files !== null && files !== void 0 ? files : this.options.files);
+            for (const filepath of filepaths) {
+                const { ignored } = await prettier_1.default.getFileInfo(filepath);
+                if (!ignored) {
+                    await this.formatFile(filepath, this.options);
+                }
+            }
+        }
+        catch (err) {
+            const error = new error_1.ToolKitError('there was an error running the prettier plugin');
+            if (err instanceof Error) {
+                error.details = err.message;
+            }
+            throw error;
+        }
+    }
+}
+exports.default = Prettier;
+Prettier.description = '';
+Prettier.defaultOptions = {
+    files: ['**/*.js'],
+    configOptions: {
+        singleQuote: true,
+        useTabs: true,
+        bracketSpacing: true,
+        arrowParens: 'always',
+        trailingComma: 'none'
+    }
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@dotcom-tool-kit/prettier",
+  "version": "1.0.2-beta.1",
+  "description": "",
+  "main": "lib",
+  "scripts": {
+    "test": "cd ../../ ; npx jest --silent --projects plugins/prettier"
+  },
+  "keywords": [],
+  "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
+  "license": "ISC",
+  "dependencies": {
+    "@dotcom-tool-kit/error": "^1.0.2-beta.1",
+    "@dotcom-tool-kit/logger": "^1.0.2-beta.1",
+    "@dotcom-tool-kit/package-json-hook": "^1.0.2-beta.1",
+    "@dotcom-tool-kit/types": "^1.0.2-beta.1",
+    "fast-glob": "^3.2.7",
+    "hook-std": "^2.0.0",
+    "prettier": "^2.2.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/financial-times/dotcom-tool-kit.git",
+    "directory": "plugins/prettier"
+  },
+  "bugs": "https://github.com/financial-times/dotcom-tool-kit/issues",
+  "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/prettier",
+  "files": [
+    "/lib",
+    ".toolkitrc.yml"
+  ],
+  "devDependencies": {
+    "@jest/globals": "^27.4.6",
+    "jest": "^27.4.7",
+    "ts-jest": "^27.1.3",
+    "winston": "^3.5.1"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

package/readme.md

@@ -0,0 +1,52 @@
+# `prettier` Tool Kit plugin
+
+This plugin is for adding prettier onto your apps.
+
+## Installation
+
+Install `@dotcom-tool-kit/prettier` as a `devDependency` in your app:
+
+```sh
+npm install --save-dev @dotcom-tool-kit/prettier
+```
+
+Add the plugin to your [Tool Kit configuration](https://github.com/financial-times/dotcom-tool-kit/blob/main/readme.md#configuration):
+
+```yaml
+plugins:
+	- '@dotcom-tool-kit/prettier'
+```
+
+And install this plugin's hooks:
+
+```sh
+npx dotcom-tool-kit --install
+```
+
+This will modify your `package.json`. You should commit this change.
+
+### Options
+
+#### `files`
+
+A required Array of strings of filepath(s) or filepath pattern(s) to be formatted. Defaults to `['{,!(node_modules)/**/}*.js'].
+
+#### `configOptions`
+
+An optional prettier configuration object. Defaults to:
+
+```js
+{
+    singleQuote: true,
+    useTabs: true,
+    bracketSpacing: true,
+    arrowParens: 'always',
+    trailingComma: 'none'
+}
+```
+
+#### `configFile`
+
+An optional String that specifies the prettier configuration file (.prettierrc.json). The configuration file will be resolved starting from the location of the file being formatted, and searching up the file tree until a config file is (or isn’t) found. If the configFile is not found the prettier plugin will default to configOptions.
+
+For more information on prettier configuration, visit the [Prettier docs](https://prettier.io/docs/en/configuration.html).