feat(conventional-commits): Add JSDoc types to named exports

lerna · Dec 10, 2020 · 81a591c · 81a591c
1 parent 89c64b4
commit 81a591c
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 1 deletion.
diff --git a/core/conventional-commits/index.js b/core/conventional-commits/index.js
@@ -5,3 +5,13 @@ const { updateChangelog } = require("./lib/update-changelog");
 
 exports.recommendVersion = recommendVersion;
 exports.updateChangelog = updateChangelog;
+
+/** @typedef {'fixed' | 'independent'} VersioningStrategy */
+/** @typedef {'fixed' | 'independent' | 'root'} ChangelogType */
+/** @typedef {string | { name: string; [key: string]: unknown }} ChangelogPresetConfig */
+/**
+ * @typedef {object} BaseChangelogOptions
+ * @property {ChangelogPresetConfig} [changelogPreset]
+ * @property {string} [rootPath] of project
+ * @property {string} [tagPrefix] defaults to "v"
+ */
diff --git a/core/conventional-commits/lib/get-changelog-config.js b/core/conventional-commits/lib/get-changelog-config.js
@@ -35,7 +35,7 @@ function resolveConfigPromise(presetPackageName, presetConfig) {
 }
 
 /**
- * @param {string|{ name: string; [key: string]: unknown }} [changelogPreset]
+ * @param {import("..").ChangelogPresetConfig} [changelogPreset]
  * @param {string} [rootPath]
  */
 function getChangelogConfig(changelogPreset = "conventional-changelog-angular", rootPath) {

diff --git a/core/conventional-commits/lib/recommend-version.js b/core/conventional-commits/lib/recommend-version.js
@@ -7,6 +7,11 @@ const { getChangelogConfig } = require("./get-changelog-config");
 
 module.exports.recommendVersion = recommendVersion;
 
+/**
+ * @param {import("@lerna/package").Package} pkg
+ * @param {import("..").VersioningStrategy} type
+ * @param {import("..").BaseChangelogOptions & { prereleaseId?: string }} commandOptions
+ */
 function recommendVersion(pkg, type, { changelogPreset, rootPath, tagPrefix, prereleaseId }) {
   log.silly(type, "for %s at %s", pkg.name, pkg.location);
 

diff --git a/core/conventional-commits/lib/update-changelog.js b/core/conventional-commits/lib/update-changelog.js
@@ -11,6 +11,11 @@ const { readExistingChangelog } = require("./read-existing-changelog");
 
 module.exports.updateChangelog = updateChangelog;
 
+/**
+ * @param {import("@lerna/package").Package} pkg
+ * @param {import("..").ChangelogType} type
+ * @param {import("..").BaseChangelogOptions & { version?: string }} commandOptions
+ */
 function updateChangelog(pkg, type, { changelogPreset, rootPath, tagPrefix = "v", version }) {
   log.silly(type, "for %s at %s", pkg.name, pkg.location);