@pob/pretty-pkg 7.1.0 → 8.0.0

package/CHANGELOG.md

@@ -3,6 +3,59 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.0](https://github.com/christophehurpeau/pob/compare/@pob/pretty-pkg@7.1.1...@pob/pretty-pkg@8.0.0) (2024-06-07)
+
+### ⚠ BREAKING CHANGES
+
+* **deps:** use async prettier or prettier/sync 
+
+### Features
+
+* add package yarn-version ([e2e8be6](https://github.com/christophehurpeau/pob/commit/e2e8be65fd50f9084c519fd07503748a1d970509))
+* **deps:** update @pob/eslint-config to v56 (major) ([#2036](https://github.com/christophehurpeau/pob/issues/2036)) ([b26302b](https://github.com/christophehurpeau/pob/commit/b26302bd6dbf9bf4da2e97238c59ae80282ad9a4))
+* **deps:** update dependency @rollup/plugin-run to v3.1.0 ([#2079](https://github.com/christophehurpeau/pob/issues/2079)) ([c2ef4fa](https://github.com/christophehurpeau/pob/commit/c2ef4fa22322952dcb626a5d99bc16e141684cd0))
+* **deps:** update dependency conventional-changelog-conventionalcommits to v8 ([#2033](https://github.com/christophehurpeau/pob/issues/2033)) ([e7a568e](https://github.com/christophehurpeau/pob/commit/e7a568e4fabea00955bc6f005d85088f947f58cb))
+* **deps:** update dependency esbuild to v0.21.0 ([#2040](https://github.com/christophehurpeau/pob/issues/2040)) ([dc252dc](https://github.com/christophehurpeau/pob/commit/dc252dc815dd450e2687e3f5784c3604bcfbab3c))
+* **deps:** update dependency glob to v10.4.0 ([#2061](https://github.com/christophehurpeau/pob/issues/2061)) ([05dd06f](https://github.com/christophehurpeau/pob/commit/05dd06f1fb51d3cff0b95d6457fb9060d5d2db29))
+* **deps:** update dependency prettier to v3 ([#1698](https://github.com/christophehurpeau/pob/issues/1698)) ([a65e641](https://github.com/christophehurpeau/pob/commit/a65e6418d4b80680b753a773b02925603df8ea12))
+* **deps:** update dependency prettier to v3.3.0 ([#2071](https://github.com/christophehurpeau/pob/issues/2071)) ([04f24c3](https://github.com/christophehurpeau/pob/commit/04f24c33fcab0472cc830675696c219ee5ba14f9))
+* **deps:** update dependency yeoman-generator to v7.2.0 ([#2063](https://github.com/christophehurpeau/pob/issues/2063)) ([a5b8748](https://github.com/christophehurpeau/pob/commit/a5b8748fecedff6291475656672feb1766c60e5f))
+* migrate pob.babelEnvs to pob.envs + pob.bundler ([6baa9bb](https://github.com/christophehurpeau/pob/commit/6baa9bb986a1321beefcf9de3de566c285e548d1))
+
+### Bug Fixes
+
+* commit build of yarn-version ([539f4b2](https://github.com/christophehurpeau/pob/commit/539f4b2e12d8df4dc5cec272a24343721f4d2bdb))
+* **deps:** update dependency esbuild to v0.21.1 ([#2042](https://github.com/christophehurpeau/pob/issues/2042)) ([2c47629](https://github.com/christophehurpeau/pob/commit/2c476296d1ecabaf272461df0901786bcea07aab))
+* **deps:** update dependency esbuild to v0.21.2 ([#2051](https://github.com/christophehurpeau/pob/issues/2051)) ([8e8596f](https://github.com/christophehurpeau/pob/commit/8e8596f11350ee7e152ebec5603295edea8e6da7))
+* **deps:** update dependency esbuild to v0.21.3 ([#2055](https://github.com/christophehurpeau/pob/issues/2055)) ([f27179c](https://github.com/christophehurpeau/pob/commit/f27179c5d6f4259a2885ee9097cf857b73849cef))
+* **deps:** update dependency esbuild to v0.21.4 ([#2065](https://github.com/christophehurpeau/pob/issues/2065)) ([984e479](https://github.com/christophehurpeau/pob/commit/984e479c1958c224bc584936c13908578563e29d))
+* **deps:** update dependency glob to v10.3.14 ([#2047](https://github.com/christophehurpeau/pob/issues/2047)) ([201fff2](https://github.com/christophehurpeau/pob/commit/201fff2e3def4a8c7344af403464e7bf16eb44bc))
+* **deps:** update dependency glob to v10.3.15 ([#2050](https://github.com/christophehurpeau/pob/issues/2050)) ([8142969](https://github.com/christophehurpeau/pob/commit/8142969c29cda5fb5f8cf924522fd719ac0278d7))
+* **deps:** update dependency glob to v10.3.16 ([#2056](https://github.com/christophehurpeau/pob/issues/2056)) ([d5ce7c0](https://github.com/christophehurpeau/pob/commit/d5ce7c0922a93a188250eb5e6a5eb8b14ac76630))
+* **deps:** update dependency glob to v10.4.1 ([#2062](https://github.com/christophehurpeau/pob/issues/2062)) ([c9eb614](https://github.com/christophehurpeau/pob/commit/c9eb614f8b0906bf4757bb21ed2bed570dbf55c4))
+* **deps:** update dependency lint-staged to v15.2.4 ([#2057](https://github.com/christophehurpeau/pob/issues/2057)) ([3266770](https://github.com/christophehurpeau/pob/commit/3266770fc90c82ccc25cd0bce67106063cf38b51))
+* **deps:** update dependency lint-staged to v15.2.5 ([#2066](https://github.com/christophehurpeau/pob/issues/2066)) ([0c5396b](https://github.com/christophehurpeau/pob/commit/0c5396b73c9a99e37964c9752f2f55b4079f888e))
+* **deps:** update dependency mem-fs-editor to v11.0.1 ([#2060](https://github.com/christophehurpeau/pob/issues/2060)) ([a4824cb](https://github.com/christophehurpeau/pob/commit/a4824cb89b8d94846ac7eb4ca062a500cadcc606))
+* **deps:** update dependency prettier to v3.3.1 ([#2078](https://github.com/christophehurpeau/pob/issues/2078)) ([57ecb30](https://github.com/christophehurpeau/pob/commit/57ecb301bc6dded8e9063c1e3afc9f6f04d023b1))
+* **deps:** update dependency semver to v7.6.1 ([#2041](https://github.com/christophehurpeau/pob/issues/2041)) ([17b20a3](https://github.com/christophehurpeau/pob/commit/17b20a3a352e4fbcda88d2e43938a8dbafe0667c))
+* **deps:** update dependency semver to v7.6.2 ([#2048](https://github.com/christophehurpeau/pob/issues/2048)) ([e4a50f3](https://github.com/christophehurpeau/pob/commit/e4a50f3c11b87306ed30ec0cbcdd8f6f23a4ac75))
+* **deps:** update dependency yeoman-environment to v4.4.1 ([#2073](https://github.com/christophehurpeau/pob/issues/2073)) ([528734e](https://github.com/christophehurpeau/pob/commit/528734e27f1f0b59ab5f5d87ff98e95385168b72))
+* **deps:** update yarn monorepo ([#2045](https://github.com/christophehurpeau/pob/issues/2045)) ([bfce168](https://github.com/christophehurpeau/pob/commit/bfce1680e6df15f6a57e83fefc39e1257bf8f6e3))
+* fix for CommonTestingGenerator ([e7f93df](https://github.com/christophehurpeau/pob/commit/e7f93df65007fe8a6e5faac6fd3d796adf6d3233))
+* fix yarn-version command ([87e25ca](https://github.com/christophehurpeau/pob/commit/87e25cae86d3730f14e50e6370efe69bd2e21814))
+* **pob:** leave default compressionLevel config ([3d4c5d1](https://github.com/christophehurpeau/pob/commit/3d4c5d1e92ec1194dec99e768c2743e085c1fa94))
+* **pob:** missing await ([f91682b](https://github.com/christophehurpeau/pob/commit/f91682b72016733065d7d505c6be5d4fddad25d8))
+* update json5 ([4034c94](https://github.com/christophehurpeau/pob/commit/4034c947a1111021ee037144cefbee0cd39b9d33))
+Version bump for dependency: @pob/sort-pkg
+
+
+## [7.1.1](https://github.com/christophehurpeau/pob/compare/@pob/pretty-pkg@7.1.0...@pob/pretty-pkg@7.1.1) (2024-05-05)
+
+Note: no notable changes
+
+Version bump for dependency: sort-pkg
+
+
 ## [7.1.0](https://github.com/christophehurpeau/pob/compare/@pob/pretty-pkg@7.0.0...@pob/pretty-pkg@7.1.0) (2024-04-21)
 
 Note: no notable changes

package/README.md

@@ -44,32 +44,32 @@ yarn pretty-pkg package.json
 #### overrideSync
 
 ```js
-const { overrideSync } = require('@pob/pretty-pkg');
+const { overrideSync } = require("@pob/pretty-pkg");
 
-overrideSync('package.json');
+overrideSync("package.json");
 ```
 
 #### writeSync
 
 ```js
-const fs = require('fs');
-const { writeSync } = require('@pob/pretty-pkg');
+const fs = require("fs");
+const { writeSync } = require("@pob/pretty-pkg");
 
-const pkg = JSON.parse(fs.readFileSync('package.json', 'utf-8'));
-writeSync(pkg, 'package.json');
+const pkg = JSON.parse(fs.readFileSync("package.json", "utf-8"));
+writeSync(pkg, "package.json");
 ```
 
 #### default
 
 ```js
-const fs = require('fs');
-const prettyPkg = require('@pob/pretty-pkg');
+const fs = require("fs");
+const prettyPkg = require("@pob/pretty-pkg");
 
 // parsing yourself
-const pkg = JSON.parse(fs.readFileSync('package.json', 'utf-8'));
-fs.writeFileSync(prettyPkg(pkg), 'package.json');
+const pkg = JSON.parse(fs.readFileSync("package.json", "utf-8"));
+fs.writeFileSync(prettyPkg(pkg), "package.json");
 
 // let prettyPkg parse
-const pkgContent = fs.readFileSync('package.json', 'utf-8');
-fs.writeFileSync(prettyPkg(pkgContent), 'package.json');
+const pkgContent = fs.readFileSync("package.json", "utf-8");
+fs.writeFileSync(prettyPkg(pkgContent), "package.json");
 ```

package/bin/pretty-pkg.js

@@ -1,37 +1,42 @@
 #!/usr/bin/env node
 
-import fs from 'node:fs';
-import path from 'node:path';
-import { glob } from 'glob';
-import { overrideSync, writeSync } from '../lib/index.js';
+import fs from "node:fs";
+import path from "node:path";
+import { glob } from "glob";
+import { override, write } from "../lib/index.js";
 
 const packageJsonPathnames = process.argv.slice(2);
 
 if (packageJsonPathnames.length > 0) {
-  packageJsonPathnames.forEach((packageJsonPathname) => {
-    overrideSync(packageJsonPathname);
-  });
+  await Promise.all(
+    packageJsonPathnames.map((packageJsonPathname) => {
+      return override(packageJsonPathname);
+    }),
+  );
 } else {
-  const pkg = JSON.parse(fs.readFileSync('package.json'));
-  writeSync(pkg, 'package.json');
+  const pkg = JSON.parse(fs.readFileSync("package.json"));
+
+  const promises = [write(pkg, "package.json")];
 
   if (pkg.workspaces && pkg.workspaces.length > 0) {
     const patterns = pkg.workspaces;
 
     const getGlobPattern = (pattern) =>
-      pattern.endsWith('/') ? pattern : `${pattern}/`;
+      pattern.endsWith("/") ? pattern : `${pattern}/`;
 
     for (const pattern of patterns) {
       const matches = await glob(getGlobPattern(pattern), {
-        ignore: ['**/node_modules/**'],
+        ignore: ["**/node_modules/**"],
       });
 
       for (const match of matches) {
-        const packageJsonPathname = path.join(match, 'package.json');
+        const packageJsonPathname = path.join(match, "package.json");
         if (fs.existsSync(packageJsonPathname)) {
-          overrideSync(packageJsonPathname);
+          promises.push(override(packageJsonPathname));
         }
       }
     }
   }
+
+  await Promise.all(promises);
 }

package/lib/index.js

@@ -1,20 +1,20 @@
-import fs from 'node:fs';
-import sortPkg from '@pob/sort-pkg';
-import prettier from 'prettier';
+import fs from "node:fs/promises";
+import sortPkg from "@pob/sort-pkg";
+import prettier from "prettier";
 
 export default function prettyPkg(pkg, prettierOptions) {
-  if (typeof pkg === 'string') {
+  if (typeof pkg === "string") {
     pkg = JSON.parse(pkg);
-    if (typeof pkg !== 'object') {
+    if (typeof pkg !== "object") {
       throw new TypeError(
-        'Invalid package: not an object after parsing string',
+        "Invalid package: not an object after parsing string",
       );
     }
-  } else if (typeof pkg !== 'object') {
-    throw new TypeError('expected pkg to be object or string');
+  } else if (typeof pkg !== "object") {
+    throw new TypeError("expected pkg to be object or string");
   }
 
-  if (typeof prettierOptions === 'string') {
+  if (typeof prettierOptions === "string") {
     throw new TypeError(
       `Please import "${prettierOptions}" and pass it as the second argument of prettyPkg`,
     );
@@ -22,18 +22,18 @@ export default function prettyPkg(pkg, prettierOptions) {
 
   sortPkg(pkg);
   return prettier.format(JSON.stringify(pkg, undefined, 2), {
-    filepath: 'package.json',
+    filepath: "package.json",
     printWidth: 80,
     ...prettierOptions,
   });
 }
 
-export function writeSync(pkg, path, prettierOptions) {
-  const string = prettyPkg(pkg, prettierOptions);
-  fs.writeFileSync(path, string, 'utf8');
+export async function write(pkg, path, prettierOptions) {
+  const string = await prettyPkg(pkg, prettierOptions);
+  await fs.writeFile(path, string, "utf8");
 }
 
-export function overrideSync(path, prettierOptions) {
-  const pkg = fs.readFileSync(path, 'utf8');
-  return writeSync(pkg, path, prettierOptions);
+export async function override(path, prettierOptions) {
+  const pkg = await fs.readFile(path, "utf8");
+  await write(pkg, path, prettierOptions);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pob/pretty-pkg",
-  "version": "7.1.0",
+  "version": "8.0.0",
   "description": "prettier and sort package.json",
   "keywords": [],
   "author": "Christophe Hurpeau <christophe@hurpeau.com> (https://christophe.hurpeau.com)",
@@ -37,8 +37,8 @@
   "pob": {},
   "prettier": "@pob/root/prettier-config",
   "dependencies": {
-    "@pob/sort-pkg": "7.1.0",
+    "@pob/sort-pkg": "7.2.0",
     "glob": "^10.0.0",
-    "prettier": "^2.6.2"
+    "prettier": "^3.2.5"
   }
 }