@dotcom-tool-kit/prettier 1.1.0 → 1.2.0

package/.toolkitrc.yml

@@ -1,6 +1,3 @@
 hooks:
   'format:local': Prettier
-
-options:
-  '@dotcom-tool-kit/prettier':
-    files: '**/*.js'
+  'format:staged': Prettier

package/lib/index.d.ts

@@ -1,9 +1,9 @@
-import Prettier from './tasks/prettier';
 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;
-    script: string;
+    key: string;
     hook: string;
 }
 export declare const hooks: {

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,kBAAkB,CAAA;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AAEpE,eAAO,MAAM,KAAK,qBAAa,CAAA;AAE/B,cAAM,WAAY,SAAQ,eAAe;IACvC,MAAM,CAAC,WAAW,SAAoB;IAEtC,MAAM,SAAW;IACjB,IAAI,SAAiB;CACtB;AAED,eAAO,MAAM,KAAK;;CAEjB,CAAA"}
+{"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

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hooks = exports.tasks = void 0;
 const tslib_1 = require("tslib");
-const prettier_1 = (0, tslib_1.__importDefault)(require("./tasks/prettier"));
 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.script = 'format';
+        this.key = 'format';
         this.hook = `format:local`;
     }
 }

package/lib/tasks/prettier.d.ts

@@ -3,6 +3,6 @@ import { Task } from '@dotcom-tool-kit/task';
 export default class Prettier extends Task<typeof PrettierSchema> {
     static description: string;
     static defaultOptions: PrettierOptions;
-    run(): Promise<void>;
+    run(files?: string[]): Promise<void>;
 }
 //# sourceMappingURL=prettier.d.ts.map

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;AAG5F,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAG5C,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,IAAI,OAAO,CAAC,IAAI,CAAC;CAc3B"}
+{"version":3,"file":"prettier.d.ts","sourceRoot":"","sources":["../../src/tasks/prettier.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAG5F,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAG5C,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;CAiB3C"}

package/lib/tasks/prettier.js

@@ -7,11 +7,14 @@ const fast_glob_1 = (0, tslib_1.__importDefault)(require("fast-glob"));
 const task_1 = require("@dotcom-tool-kit/task");
 const error_1 = require("@dotcom-tool-kit/error");
 class Prettier extends task_1.Task {
-    async run() {
+    async run(files) {
         try {
-            const filepaths = await (0, fast_glob_1.default)(this.options.files);
+            const filepaths = await (0, fast_glob_1.default)(files !== null && files !== void 0 ? files : this.options.files);
             for (const filepath of filepaths) {
-                await formatFile(filepath, this.options);
+                const { ignored } = await prettier_1.default.getFileInfo(filepath);
+                if (!ignored) {
+                    await formatFile(filepath, this.options);
+                }
             }
         }
         catch (err) {
@@ -26,7 +29,7 @@ class Prettier extends task_1.Task {
 exports.default = Prettier;
 Prettier.description = '';
 Prettier.defaultOptions = {
-    files: ['{,!(node_modules)/**/}*.js'],
+    files: ['**/*.js'],
     configOptions: {
         singleQuote: true,
         useTabs: true,
@@ -38,21 +41,16 @@ Prettier.defaultOptions = {
 const formatFile = async (filepath, options) => {
     const fileContent = await fs_1.promises.readFile(filepath, 'utf8');
     let prettierConfig;
-    if (options.configFile) {
-        try {
-            prettierConfig = await prettier_1.default.resolveConfig(filepath, { config: options.configFile });
-        }
-        catch (err) {
-            if (err.code !== 'ENOENT') {
-                throw err;
-            }
-        }
-        if (!prettierConfig) {
-            console.log(`prettier could not find the specified configFile (${options.configFile}), using configOptions instead`);
-            prettierConfig = options.configOptions;
+    try {
+        prettierConfig = await prettier_1.default.resolveConfig(filepath, { config: options.configFile });
+    }
+    catch (err) {
+        if (err.code !== 'ENOENT') {
+            throw err;
         }
     }
-    else {
+    if (!prettierConfig && options.configOptions) {
+        console.log(`prettier could not find the specified configFile (${options.configFile}), using configOptions instead`);
         prettierConfig = options.configOptions;
     }
     await fs_1.promises.writeFile(filepath, prettier_1.default.format(fileContent, { ...prettierConfig, filepath }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/prettier",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "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": "^1.1.0",
-    "@dotcom-tool-kit/task": "^1.1.0",
+    "@dotcom-tool-kit/error": "^1.2.0",
+    "@dotcom-tool-kit/task": "^1.2.0",
     "fast-glob": "^3.2.7",
-    "prettier": "^2.4.1"
+    "prettier": "^2.2.1"
   },
   "repository": {
     "type": "git",