Little tweaks

Author: mcmire

src/release-specification.test.ts

@@ -338,7 +338,7 @@ packages:
       });
     });
 
-    it('throws if any of the keys in the "packages" objectproperty do not match the names of any workspace packages', async () => {
+    it('throws if any of the keys in the "packages" object do not match the names of any workspace packages', async () => {
       await withSandbox(async (sandbox) => {
         const project = buildMockProject({
           workspacePackages: {

src/repo.ts

@@ -21,7 +21,7 @@ async function getStdoutFromCommandWithin(
  * Runs a Git command within the given repository, obtaining the immediate
  * output.
  *
- * @param repositoryDirectoryPath - The directory of the repository.
+ * @param repositoryDirectoryPath - The path to the repository directory.
  * @param args - The arguments to the command.
  * @returns The standard output of the command.
  * @throws An execa error object if the command fails in some way.
@@ -44,7 +44,7 @@ export async function getStdoutFromGitCommandWithin(
  * If the URL of the "origin" remote matches neither pattern, an error is
  * thrown.
  *
- * @param repositoryDirectoryPath - The path to the project directory.
+ * @param repositoryDirectoryPath - The path to the repository directory.
  * @returns The HTTPS URL of the repository, e.g.
  * `https://github.com/OrganizationName/RepositoryName`.
  */
@@ -83,30 +83,30 @@ export async function getRepositoryHttpsUrl(
  * This function does three things:
  *
  * 1. Stages all of the changes which have been made to the repo thus far and
- *    creates a new Git commit which carries the name of the new release.
+ * creates a new Git commit which carries the name of the new release.
  * 2. Creates a new branch pointed to that commit (which also carries the name
- *    of the new release).
+ * of the new release).
  * 3. Switches to that branch.
  *
- * @param projectRepositoryPath - The path to the project directory.
+ * @param repositoryDirectoryPath - The path to the repository directory.
  * @param releaseName - The name of the release, which will be used to name the
  * commit and the branch.
  */
 export async function captureChangesInReleaseBranch(
-  projectRepositoryPath: string,
+  repositoryDirectoryPath: string,
   releaseName: string,
 ) {
   // TODO: What if the index was dirty before this script was run? Or what if
   // you're in the middle of a rebase? Might want to check that up front before
   // changes are even made.
   // TODO: What if this branch already exists? Append the build number?
-  await getStdoutFromGitCommandWithin(projectRepositoryPath, [
+  await getStdoutFromGitCommandWithin(repositoryDirectoryPath, [
     'checkout',
     '-b',
     `release/${releaseName}`,
   ]);
-  await getStdoutFromGitCommandWithin(projectRepositoryPath, ['add', '-A']);
-  await getStdoutFromGitCommandWithin(projectRepositoryPath, [
+  await getStdoutFromGitCommandWithin(repositoryDirectoryPath, ['add', '-A']);
+  await getStdoutFromGitCommandWithin(repositoryDirectoryPath, [
     'commit',
     '-m',
     `Release ${releaseName}`,