@dotcom-tool-kit/prettier 2.1.3 → 2.2.1

package/lib/index.js

@@ -3,7 +3,7 @@ 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"));
+const prettier_1 = tslib_1.__importDefault(require("./tasks/prettier"));
 exports.tasks = [prettier_1.default];
 class FormatLocal extends package_json_hook_1.PackageJsonScriptHook {
     constructor() {

package/lib/tasks/prettier.d.ts

@@ -2,7 +2,6 @@ import { PrettierOptions, PrettierSchema } from '@dotcom-tool-kit/types/lib/sche
 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>;
 }

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;IAEvB,MAAM,CAAC,cAAc,EAAE,eAAe,CAUrC;IAEK,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,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"}

package/lib/tasks/prettier.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const prettier_1 = (0, tslib_1.__importDefault)(require("prettier"));
+const prettier_1 = tslib_1.__importDefault(require("prettier"));
 const fs_1 = require("fs");
-const fast_glob_1 = (0, tslib_1.__importDefault)(require("fast-glob"));
+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 error_1 = require("@dotcom-tool-kit/error");
@@ -63,14 +63,3 @@ class Prettier extends types_1.Task {
 }
 exports.default = Prettier;
 Prettier.description = '';
-Prettier.defaultOptions = {
-    files: ['**/*.{js,jsx,ts,tsx}'],
-    ignoreFile: '.prettierignore',
-    configOptions: {
-        singleQuote: true,
-        useTabs: true,
-        bracketSpacing: true,
-        arrowParens: 'always',
-        trailingComma: 'none'
-    }
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/prettier",
-  "version": "2.1.3",
+  "version": "2.2.1",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -11,9 +11,9 @@
   "license": "ISC",
   "dependencies": {
     "@dotcom-tool-kit/error": "^2.0.1",
-    "@dotcom-tool-kit/logger": "^2.2.0",
+    "@dotcom-tool-kit/logger": "^2.2.1",
     "@dotcom-tool-kit/package-json-hook": "^3.0.0",
-    "@dotcom-tool-kit/types": "^2.8.0",
+    "@dotcom-tool-kit/types": "^2.9.1",
     "fast-glob": "^3.2.7",
     "hook-std": "^2.0.0",
     "prettier": "^2.2.1",
@@ -40,6 +40,6 @@
     "extends": "../../package.json"
   },
   "peerDependencies": {
-    "dotcom-tool-kit": "2.x"
+    "dotcom-tool-kit": "^2.6.0"
   }
 }

package/readme.md

@@ -27,26 +27,10 @@ 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.
+| 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 |
 
 For more information on prettier configuration, visit the [Prettier docs](https://prettier.io/docs/en/configuration.html).