@ethima/semantic-release-configuration 6.0.0 → 7.0.0-rc.2

package/README.md

@@ -20,9 +20,10 @@ configuration supporting a range of languages and platforms supported by the
 - Maintains a `CHANGELOG.md` from the generated release notes using
   [`@semantic-release/changelog`][semantic-release-changelog-plugin-url] and
   [`@semantic-release/git`][semantic-release-git-plugin-url].
-- (Conditionally) maintains NPM package files, i.e. `package.json` and
-  publishes using [`@semantic-release/npm`][semantic-release-npm-plugin-url]
-  and [`@semantic-release/git`][semantic-release-git-plugin-url].
+- (Conditionally) maintains NPM package files, i.e. `package.json`,
+  `package-lock.json` (if committed), and publishes using
+  [`@semantic-release/npm`][semantic-release-npm-plugin-url] and
+  [`@semantic-release/git`][semantic-release-git-plugin-url].
 - (Conditionally) maintains Julia package files, i.e. `version` fields in
   `Project.toml` files, using
   [`semantic-release-replace-plugin`][semantic-release-replace-plugin-url] and

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@ethima/semantic-release-configuration",
-  "version": "6.0.0",
+  "version": "7.0.0-rc.2",
   "description": "A shareable semantic release configuration supporting a range of languages and platforms supported by the Ethima organization.",
   "main": "./src/index.js",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@gitlab.com/ethima/semantic-release-configuration.git"
   },
+  "type": "module",
   "scripts": {
     "test": "ava"
   },
@@ -27,11 +28,15 @@
     "@semantic-release/gitlab": "13.0.0",
     "conventional-changelog-conventionalcommits": "7.0.2",
     "cosmiconfig": "8.3.6",
+    "execa": "8.0.1",
     "semantic-release-replace-plugin": "1.2.7"
   },
   "devDependencies": {
     "ava": "6.0.1"
   },
+  "peerDependencies": {
+    "semantic-release": ">= 22.0.7"
+  },
   "engines": {
     "node": ">= 20.8.1"
   }

package/src/branches.js

@@ -28,7 +28,7 @@ function determinePrefixedBranchType(
  * @return array An array containing the determined branch configuration as the
  * sole entry.
  */
-function BranchesConfiguration(branch, configuration) {
+export function BranchesConfiguration(branch, configuration) {
   if (configuration.primary_release_branch === branch) {
     return [branch];
   }
@@ -78,5 +78,3 @@ function BranchesConfiguration(branch, configuration) {
 
   return [];
 }
-
-module.exports = BranchesConfiguration;

package/src/configuration.js

@@ -1,5 +1,5 @@
-const { cosmiconfigSync } = require("cosmiconfig");
-const { env } = require("node:process");
+import { cosmiconfigSync } from "cosmiconfig";
+import { env } from "node:process";
 
 const CONFIGURATION_DEFAULTS = {
   // The character(s) to use to separate the prefix for maintenance and
@@ -27,6 +27,7 @@ const ethimaConfig = cosmiconfigSync("ethima").search();
 // sufficient for the current configuration needs, which tend to be simple
 // values and doing a deep merge would add currently unnecessary complexity.
 // This can be revisited once the need arises
-const CONFIGURATION = { ...CONFIGURATION_DEFAULTS, ...ethimaConfig?.config };
-
-module.exports = CONFIGURATION;
+export const CONFIGURATION = {
+  ...CONFIGURATION_DEFAULTS,
+  ...ethimaConfig?.config,
+};

package/src/index.js

@@ -1,15 +1,29 @@
-const { accessSync } = require("node:fs");
-const { env } = require("node:process");
+import { accessSync } from "node:fs";
+import { env } from "node:process";
+import { execa } from "execa";
 
-const BranchesConfiguration = require("./branches.js");
-const CONFIGURATION = require("./configuration.js");
-const VersionedTemplatesConfiguration = require("./versioned-templates.js");
+import { BranchesConfiguration } from "./branches.js";
+import { CONFIGURATION } from "./configuration.js";
+import { VersionedTemplatesConfiguration } from "./versioned-templates.js";
 
 const GIT_ASSETS = [
   CONFIGURATION.changelog_filename,
   ...CONFIGURATION.files_with_versioned_templates,
 ];
 
+/**
+ * Checks whether a file is being tracked by Git.
+ *
+ * @param {string} path The path to the file to verify for whether it's being
+ * tracked by Git.
+ *
+ * @return bool Whether the file is being tracked by Git.
+ */
+async function isFileTrackedByGit(path) {
+  const { stdout } = await execa("git", ["ls-files", path]);
+  return stdout.includes(path);
+}
+
 /*
  * Determines whether the provided plugin should be added to the semantic
  * release configuration based on the presence of select environment variables.
@@ -32,6 +46,10 @@ try {
   accessSync("package.json");
   GIT_ASSETS.push("package.json");
   NPM_PLUGIN.push("@semantic-release/npm");
+
+  if (isFileTrackedByGit("package-lock.json")) {
+    GIT_ASSETS.push("package-lock.json");
+  }
 } catch {}
 
 const JULIA_PROJECT_TOML_PLUGIN = [];
@@ -109,4 +127,4 @@ const SEMANTIC_RELEASE_CONFIGURATION = {
   ],
 };
 
-module.exports = SEMANTIC_RELEASE_CONFIGURATION;
+export default SEMANTIC_RELEASE_CONFIGURATION;

package/src/versioned-templates.js

@@ -1,4 +1,4 @@
-const { extname } = require("node:path");
+import { extname } from "node:path";
 
 /**
  * The default configuration for tokens used by the {@link buildReplacement}
@@ -96,8 +96,8 @@ function buildReplacement(
   template,
   template_end,
   replacement_end,
-  _, // Index of match start
-  _, // Searched text
+  __, // Index of match start
+  ___, // Searched text
   filename,
   context,
 ) {
@@ -224,7 +224,7 @@ function stripTemplateContinuationTokens(
  * `semantic-release-replace-plugin` set up to replace specific tokens with the
  * next semantic release version in the provided {@param files}.
  */
-function VersionedTemplatesConfiguration(files) {
+export function VersionedTemplatesConfiguration(files) {
   return [
     "semantic-release-replace-plugin",
     {
@@ -239,5 +239,3 @@ function VersionedTemplatesConfiguration(files) {
     },
   ];
 }
-
-module.exports = VersionedTemplatesConfiguration;