gitlab-releaser - npm Package Compare versions

Comparing version 4.0.2 to 4.0.3

index.js

@@ -26,5 +26,5 @@ 'use strict';
  *
- * @private
  * @param   {string} message The error message.
  * @returns {object}         A ci-logger formatted message object.
+ * @private
  */
@@ -43,5 +43,5 @@ const getErrorLogEntry = (message) => {
  *
- * @private
  * @param {string} releaseName The given release name.
  * @param {string} message     The error message if no release specified.
+ * @private
  */
@@ -57,6 +57,6 @@ const validateReleaseName = (releaseName, message) => {
  *
- * @private
  * @param   {object} data        The release data.
  * @param   {string} releaseName The given release name.
  * @returns {object}             Release data including any applicable CHANGELOG data.
+ * @private
  */
@@ -82,6 +82,6 @@ const processReleaseData = (data, releaseName) => {
  *
- * @private
  * @param   {object} data        The gitlab-releaser data.
  * @param   {string} releaseName The given release name.
  * @returns {object}             The applicable release object.
+ * @private
  */
@@ -99,4 +99,4 @@ const getReleaseFromGitLabReleaser = (data, releaseName) => {
  *
+ * @param {string} type The file schema type.
  * @private
- * @param {string} type The file schema type.
  */
@@ -119,4 +119,2 @@ const validateSchemaType = (type) => {
  *
- * @public
- * @static
  * @param   {string} directory       The directory where the release file
@@ -130,2 +128,4 @@ *                                   is located.
  * @returns {string}                 The release-cli command.
+ * @static
+ * @public
  */
@@ -175,4 +175,2 @@ // eslint-disable-next-line max-lines-per-function
  *
- * @public
- * @static
  * @param {string} directory         The destination directory to save
@@ -182,2 +180,4 @@ *                                   the script.
  * @param {string} command           The shell command for the script.
+ * @static
+ * @public
  */
@@ -184,0 +184,0 @@ const saveReleaseCliScript = (directory, releaseScriptName, command) => {

lib/changelog.js

@@ -20,7 +20,7 @@ 'use strict';
  *
- * @public
- * @static
  * @param   {object}  data The release object to check.
  * @returns {boolean}      True if the release uses CHANGELOG data,
  *                         otherwise false.
+ * @static
+ * @public
  */
@@ -38,4 +38,2 @@ const usesChangelog = (data) => {
  *
- * @public
- * @static
  * @param   {string} releaseName   The release name to find in the CHANGELOG.
@@ -45,2 +43,4 @@ * @param   {string} changelogPath The directory to find the CHANGELOG.
  *                                 the CHANGELOG.
+ * @static
+ * @public
  */
@@ -86,7 +86,7 @@ // eslint-disable-next-line max-lines-per-function
  *
+ * @param   {object} data        The release.
+ * @param   {string} releaseName The release name to find in the CHANGELOG.
+ * @returns {object}             The release updated with CHANGELOG data.
+ * @static
  * @public
- * @static
- * @param   {object} data         The release.
- * @param   {string} releaseName  The release name to find in the CHANGELOG.
- * @returns {object}              The release updated with CHANGELOG data.
  */
@@ -93,0 +93,0 @@ const processChangelogData = (data, releaseName) => {

lib/cli-args.js

@@ -14,6 +14,6 @@ 'use strict';
  *
- * @private
  * @param   {string} value      The value of the CLI argument.
  * @param   {string} optionName The name of the CLI argument.
  * @returns {string}            The CLI argument with escaped value.
+ * @private
  */
@@ -27,6 +27,6 @@ const getArgument = (value, optionName) => {
  *
+ * @param   {string[]} values     Array of CLI argument values.
+ * @param   {string}   optionName The name of the CLI argument.
+ * @returns {string}              The CLI argument with escaped value.
  * @private
- * @param   {string[]} values   Array of CLI argument values.
- * @param   {string} optionName The name of the CLI argument.
- * @returns {string}            The CLI argument with escaped value.
  */
@@ -46,5 +46,5 @@ const getArrayArguments = (values, optionName) => {
  *
- * @private
  * @param   {object} assets The release asset object.
  * @returns {string}        The CLI argument with escaped value.
+ * @private
  */
@@ -66,7 +66,7 @@ const getAssetLinks = (assets) => {
  *
- * @public
- * @static
  * @param   {object} release A release object with applicable parameters
  *                           (which may include environment variables).
  * @returns {string}         The CLI arguments for release-cli.
+ * @static
+ * @public
  */
@@ -73,0 +73,0 @@ const getArgumentsString = (release) => {

lib/schema.js

@@ -16,6 +16,6 @@ 'use strict';
  *
+ * @readonly
  * @enum {string}
- * @readonly
+ * @static
  * @public
- * @static
  */
@@ -38,6 +38,6 @@ const SchemaTypes = Object.freeze({
  *
- * @public
- * @static
  * @param   {string}  value The schema type to check.
  * @returns {boolean}       True if the value is a valid schema type.
+ * @static
+ * @public
  */
@@ -52,3 +52,2 @@ const isValidSchemaType = (value) => {
  *
- * @private
  * @param   {string[]} schemaFiles The JSON schema files to load.
@@ -59,2 +58,3 @@ * @param   {string}   schemaId    The ID for the parent schema.
  *                                 schema, otherwise false.
+ * @private
  */
@@ -76,6 +76,6 @@ const validateDataAgainstSchema = (schemaFiles, schemaId, data) => {
  *
- * @public
- * @static
  * @param   {object}  data The release object to check.
  * @returns {boolean}      True if valid gitlab-releaser schema, otherwise false.
+ * @static
+ * @public
  */
@@ -93,6 +93,6 @@ const isValidGitLabReleaser = (data) => {
  *
- * @public
- * @static
  * @param   {object}  data The release object to check.
  * @returns {boolean}      True if valid release schema, otherwise false.
+ * @static
+ * @public
  */
@@ -99,0 +99,0 @@ const isValidRelease = (data) => {

lib/string-escape.js

@@ -35,6 +35,6 @@ 'use strict';
  *
- * @public
- * @static
  * @param   {string} value The string to be formatted.
  * @returns {string}       The escaped string.
+ * @static
+ * @public
  */
@@ -41,0 +41,0 @@ const escapeString = (value) => {

package.json

 {
   "name": "gitlab-releaser",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "Generate arguments for GitLab release-cli command",
@@ -43,6 +43,6 @@ "bin": "./bin/gitlab-releaser.js",
   "devDependencies": {
-    "@aarongoldenthal/eslint-config-standard": "^16.0.1",
+    "@aarongoldenthal/eslint-config-standard": "^17.0.1",
     "bin-tester": "^3.0.0",
-    "eslint": "^8.23.0",
-    "jest": "^29.0.1",
+    "eslint": "^8.26.0",
+    "jest": "^29.2.2",
     "jest-junit": "^14.0.1",
@@ -55,6 +55,6 @@ "markdownlint-cli": "^0.32.2",
     "ci-logger": "^5.1.0",
-    "commander": "^9.4.0",
-    "gitlab-ci-env": "^6.2.2",
-    "releaselog": "^3.0.1"
+    "commander": "^9.4.1",
+    "gitlab-ci-env": "^6.4.0",
+    "releaselog": "^3.0.2"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

32152

increased by0.01%

Dependency changes

• Updatedcommander@^9.4.1

• Updatedgitlab-ci-env@^6.4.0

• Updatedreleaselog@^3.0.2