@changesets/write - npm Package Compare versions

Comparing version 0.1.9 to 0.2.0

CHANGELOG.md

 # @changesets/write
 
+## 0.2.0
+
+### Minor Changes
+
+- [#905](https://github.com/changesets/changesets/pull/905) [`c140171`](https://github.com/changesets/changesets/commit/c1401716cf5ee839aaa02ea7ff8f23f8af8bf5b0) Thanks [@Andarist](https://github.com/Andarist)! - The local version of Prettier is going to be preferred from now on when writing formatted `.md` files back to disk. At the same time the version of Prettier that we depend on has been upgraded.
+
 ## 0.1.9
@@ -4,0 +10,0 @@

dist/write.cjs.dev.js

@@ -66,2 +66,16 @@ 'use strict';
 
+function getPrettierInstance(cwd) {
+  try {
+    return require(require.resolve("prettier", {
+      paths: [cwd]
+    }));
+  } catch (err) {
+    if (!err || err.code !== "MODULE_NOT_FOUND") {
+      throw err;
+    }
+
+    return prettier__default['default'];
+  }
+}
+
 async function writeChangeset(changeset, cwd) {
@@ -79,3 +93,4 @@ const {
   });
-  const prettierConfig = await prettier__default['default'].resolveConfig(cwd);
+  const prettierInstance = getPrettierInstance(cwd);
+  const prettierConfig = await prettierInstance.resolveConfig(cwd);
   const newChangesetPath = path__default['default'].resolve(changesetBase, `${changesetID}.md`); // NOTE: The quotation marks in here are really important even though they are
@@ -91,3 +106,3 @@ // not spec for yaml. This is because package names can contain special
   `;
-  await fs__default['default'].writeFile(newChangesetPath, prettier__default['default'].format(changesetContents, _objectSpread2(_objectSpread2({}, prettierConfig), {}, {
+  await fs__default['default'].writeFile(newChangesetPath, prettierInstance.format(changesetContents, _objectSpread2(_objectSpread2({}, prettierConfig), {}, {
     parser: "markdown"
@@ -94,0 +109,0 @@ })));

dist/write.cjs.prod.js

@@ -49,2 +49,13 @@ "use strict";
 
+function getPrettierInstance(cwd) {
+  try {
+    return require(require.resolve("prettier", {
+      paths: [ cwd ]
+    }));
+  } catch (err) {
+    if (!err || "MODULE_NOT_FOUND" !== err.code) throw err;
+    return prettier__default.default;
+  }
+}
+
 async function writeChangeset(changeset, cwd) {
@@ -54,4 +65,4 @@ const {summary: summary, releases: releases} = changeset, changesetBase = path__default.default.resolve(cwd, ".changeset"), changesetID = humanId__default.default({
     capitalize: !1
-  }), prettierConfig = await prettier__default.default.resolveConfig(cwd), newChangesetPath = path__default.default.resolve(changesetBase, changesetID + ".md"), changesetContents = `---\n${releases.map((release => `"${release.name}": ${release.type}`)).join("\n")}\n---\n\n${summary}\n  `;
-  return await fs__default.default.writeFile(newChangesetPath, prettier__default.default.format(changesetContents, _objectSpread2(_objectSpread2({}, prettierConfig), {}, {
+  }), prettierInstance = getPrettierInstance(cwd), prettierConfig = await prettierInstance.resolveConfig(cwd), newChangesetPath = path__default.default.resolve(changesetBase, changesetID + ".md"), changesetContents = `---\n${releases.map((release => `"${release.name}": ${release.type}`)).join("\n")}\n---\n\n${summary}\n  `;
+  return await fs__default.default.writeFile(newChangesetPath, prettierInstance.format(changesetContents, _objectSpread2(_objectSpread2({}, prettierConfig), {}, {
     parser: "markdown"
@@ -58,0 +69,0 @@ }))), changesetID;

dist/write.esm.js

@@ -55,2 +55,16 @@ import fs from 'fs-extra';
 
+function getPrettierInstance(cwd) {
+  try {
+    return require(require.resolve("prettier", {
+      paths: [cwd]
+    }));
+  } catch (err) {
+    if (!err || err.code !== "MODULE_NOT_FOUND") {
+      throw err;
+    }
+
+    return prettier;
+  }
+}
+
 async function writeChangeset(changeset, cwd) {
@@ -68,3 +82,4 @@ const {
   });
-  const prettierConfig = await prettier.resolveConfig(cwd);
+  const prettierInstance = getPrettierInstance(cwd);
+  const prettierConfig = await prettierInstance.resolveConfig(cwd);
   const newChangesetPath = path.resolve(changesetBase, `${changesetID}.md`); // NOTE: The quotation marks in here are really important even though they are
@@ -80,3 +95,3 @@ // not spec for yaml. This is because package names can contain special
   `;
-  await fs.writeFile(newChangesetPath, prettier.format(changesetContents, _objectSpread2(_objectSpread2({}, prettierConfig), {}, {
+  await fs.writeFile(newChangesetPath, prettierInstance.format(changesetContents, _objectSpread2(_objectSpread2({}, prettierConfig), {}, {
     parser: "markdown"
@@ -83,0 +98,0 @@ })));

package.json

 {
   "name": "@changesets/write",
-  "version": "0.1.9",
+  "version": "0.2.0",
   "description": "Writes a changeset to a file",
@@ -14,3 +14,3 @@ "main": "dist/write.cjs.js",
     "human-id": "^1.0.2",
-    "prettier": "^1.19.1"
+    "prettier": "^2.7.1"
   },
@@ -17,0 +17,0 @@ "devDependencies": {

README.md

@@ -12,4 +12,4 @@ # @changesets/write
     { name: "@changesets/something", type: "minor" },
-    { name: "@changesets/something-else", type: "patch" }
-  ]
+    { name: "@changesets/something-else", type: "patch" },
+  ],
 };
@@ -16,0 +16,0 @@

src/index.test.ts

@@ -17,3 +17,3 @@ import fixtures from "fixturez";
   summary: "This is a summary",
-  releases: [{ name: "pkg-a", type: "minor" }]
+  releases: [{ name: "pkg-a", type: "minor" }],
 };
@@ -23,3 +23,3 @@
   summary: "",
-  releases: []
+  releases: [],
 };
@@ -26,0 +26,0 @@

src/index.ts

@@ -7,2 +7,13 @@ import fs from "fs-extra";
 
+function getPrettierInstance(cwd: string): typeof prettier {
+  try {
+    return require(require.resolve("prettier", { paths: [cwd] }));
+  } catch (err) {
+    if (!err || (err as any).code !== "MODULE_NOT_FOUND") {
+      throw err;
+    }
+    return prettier;
+  }
+}
+
 async function writeChangeset(
@@ -20,6 +31,7 @@ changeset: Changeset,
     separator: "-",
-    capitalize: false
+    capitalize: false,
   });
 
-  const prettierConfig = await prettier.resolveConfig(cwd);
+  const prettierInstance = getPrettierInstance(cwd);
+  const prettierConfig = await prettierInstance.resolveConfig(cwd);
 
@@ -32,3 +44,3 @@ const newChangesetPath = path.resolve(changesetBase, `${changesetID}.md`);
   const changesetContents = `---
-${releases.map(release => `"${release.name}": ${release.type}`).join("\n")}
+${releases.map((release) => `"${release.name}": ${release.type}`).join("\n")}
 ---
@@ -41,5 +53,5 @@
     newChangesetPath,
-    prettier.format(changesetContents, {
+    prettierInstance.format(changesetContents, {
       ...prettierConfig,
-      parser: "markdown"
+      parser: "markdown",
     })
@@ -46,0 +58,0 @@ );

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16867

increased by10.86%

Lines of code

336

increased by16.26%

Worsened metrics

Number of low supply chain risk alerts

8

increased by60%

Dependency changes

• + Addedprettier@2.8.8(transitive)

• - Removedprettier@1.19.1(transitive)

• Updatedprettier@^2.7.1