@dotcom-tool-kit/prettier 3.2.0 → 4.0.0-beta.1

package/.toolkitrc.yml

@@ -1,3 +1,17 @@
-hooks:
+plugins:
+  - '@dotcom-tool-kit/package-json-hook'
+
+tasks:
+  Prettier: './lib/tasks/prettier'
+
+commands:
   'format:local': Prettier
   'format:staged': Prettier
+
+options:
+  hooks:
+    - PackageJson:
+        scripts:
+          format: 'format:local'
+
+version: 2

package/lib/tasks/prettier.d.ts

@@ -1,7 +1,8 @@
-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;
+import { PrettierOptions, PrettierSchema } from '@dotcom-tool-kit/schemas/lib/tasks/prettier';
+import { Task } from '@dotcom-tool-kit/base';
+export default class Prettier extends Task<{
+    task: typeof PrettierSchema;
+}> {
     run(files?: string[]): Promise<void>;
     formatFile: (filepath: string, options: PrettierOptions) => Promise<void>;
 }

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

@@ -1 +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;IAEjB,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB1C,UAAU,aAAoB,MAAM,WAAW,eAAe,KAAG,QAAQ,IAAI,CAAC,CAsC7E;CACF"}
+{"version":3,"file":"prettier.d.ts","sourceRoot":"","sources":["../../src/tasks/prettier.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAI7F,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAG5C,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,IAAI,CAAC;IAAE,IAAI,EAAE,OAAO,cAAc,CAAA;CAAE,CAAC;IACnE,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB1C,UAAU,aAAoB,MAAM,WAAW,eAAe,KAAG,QAAQ,IAAI,CAAC,CA2B7E;CACF"}

package/lib/tasks/prettier.js

@@ -5,9 +5,9 @@ const prettier_1 = tslib_1.__importDefault(require("prettier"));
 const fs_1 = require("fs");
 const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
 const logger_1 = require("@dotcom-tool-kit/logger");
-const types_1 = require("@dotcom-tool-kit/types");
+const base_1 = require("@dotcom-tool-kit/base");
 const error_1 = require("@dotcom-tool-kit/error");
-class Prettier extends types_1.Task {
+class Prettier extends base_1.Task {
     constructor() {
         super(...arguments);
         this.formatFile = async (filepath, options) => {
@@ -25,10 +25,6 @@ class Prettier extends types_1.Task {
                     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 { ignored } = await prettier_1.default.getFileInfo(filepath, { ignorePath: this.options.ignoreFile });
             if (ignored) {
                 return;
@@ -62,4 +58,3 @@ class Prettier extends types_1.Task {
     }
 }
 exports.default = Prettier;
-Prettier.description = '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/prettier",
-  "version": "3.2.0",
+  "version": "4.0.0-beta.1",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -10,10 +10,10 @@
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotcom-tool-kit/error": "^3.2.0",
-    "@dotcom-tool-kit/logger": "^3.4.0",
-    "@dotcom-tool-kit/package-json-hook": "^4.2.0",
-    "@dotcom-tool-kit/types": "^3.6.0",
+    "@dotcom-tool-kit/base": "4.0.0-beta.0",
+    "@dotcom-tool-kit/error": "4.0.0-beta.0",
+    "@dotcom-tool-kit/logger": "4.0.0-beta.0",
+    "@dotcom-tool-kit/package-json-hook": "5.0.0-beta.1",
     "fast-glob": "^3.2.7",
     "hook-std": "^2.0.0",
     "prettier": "^2.2.1",
@@ -31,19 +31,17 @@
     ".toolkitrc.yml"
   ],
   "devDependencies": {
-    "@jest/globals": "^27.4.6",
-    "jest": "^27.4.7",
-    "ts-jest": "^27.1.3",
+    "@types/prettier": "^2.7.3",
     "winston": "^3.5.1"
   },
   "volta": {
     "extends": "../../package.json"
   },
   "peerDependencies": {
-    "dotcom-tool-kit": "3.x"
+    "dotcom-tool-kit": "4.0.0-beta.1"
   },
   "engines": {
-    "node": "16.x || 18.x || 20.x",
+    "node": "18.x || 20.x",
     "npm": "7.x || 8.x || 9.x || 10.x"
   }
 }

package/readme.md

@@ -1,6 +1,6 @@
 # @dotcom-tool-kit/prettier
 
-This plugin is for adding prettier onto your apps.
+Tool Kit plugin to format your source code with [Prettier](https://prettier.io).
 
 ## Installation
 
@@ -17,20 +17,19 @@ plugins:
 	- '@dotcom-tool-kit/prettier'
 ```
 
-And install this plugin's hooks:
+<!-- begin autogenerated docs -->
+## Tasks
 
-```sh
-npx dotcom-tool-kit --install
-```
-
-This will modify your `package.json`. You should commit this change.
+### `Prettier`
 
-### Options
+Format files with `prettier`.
+#### Task options
 
-| Key | Description | Default value |
-|-|-|-|
-| `files` | A required Array of strings of filepath(s) or filepath pattern(s) to be formatted | `['{,!(node_modules)/**/}*.js']` |
-| `configOptions` | An optional prettier configuration object | <br>`{`<br>`    singleQuote: true,`<br>`    useTabs: true,`<br>`    bracketSpacing: true,`<br>`    arrowParens: 'always',`<br>`    trailingComma: 'none'`<br>`}`<br> |
-| `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. | `configOptions` value |
+| Property     | Description                                                                                                                                     | Type                      | Default                    |
+| :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------ | :------------------------- |
+| `files`      | glob pattern of files to run Prettier on.                                                                                                       | `Array<string> \| string` | `["**/*.{js,jsx,ts,tsx}"]` |
+| `configFile` | path to a Prettier config file to use. Uses Prettier's built-in [config resolution](https://prettier.io/docs/en/configuration.html) by default. | `string`                  |                            |
+| `ignoreFile` | path to a Prettier [ignore file](https://prettier.io/docs/en/ignore).                                                                           | `string`                  | `'.prettierignore'`        |
 
-For more information on prettier configuration, visit the [Prettier docs](https://prettier.io/docs/en/configuration.html).
+_All properties are optional._
+<!-- end autogenerated docs -->

package/lib/index.d.ts

@@ -1,13 +0,0 @@
-import { PackageJsonScriptHook } from '@dotcom-tool-kit/package-json-hook';
-import Prettier from './tasks/prettier';
-export declare const tasks: (typeof Prettier)[];
-declare class FormatLocal extends PackageJsonScriptHook {
-    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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAA;AAC1E,OAAO,QAAQ,MAAM,kBAAkB,CAAA;AAEvC,eAAO,MAAM,KAAK,qBAAa,CAAA;AAE/B,cAAM,WAAY,SAAQ,qBAAqB;IAC7C,MAAM,CAAC,WAAW,SAAoB;IAEtC,GAAG,SAAW;IACd,IAAI,SAAiB;CACtB;AAED,eAAO,MAAM,KAAK;;CAEjB,CAAA"}

package/lib/index.js

@@ -1,18 +0,0 @@
-"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 = tslib_1.__importDefault(require("./tasks/prettier"));
-exports.tasks = [prettier_1.default];
-class FormatLocal extends package_json_hook_1.PackageJsonScriptHook {
-    constructor() {
-        super(...arguments);
-        this.key = 'format';
-        this.hook = `format:local`;
-    }
-}
-FormatLocal.description = 'format prettier';
-exports.hooks = {
-    'format:local': FormatLocal
-};