feat(utils): update jsdocs

nx-dotnet · Apr 26, 2021 · 83bec44 · 83bec44
1 parent a91700b
commit 83bec44
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 13 deletions.
diff --git a/.commitlintrc b/.commitlintrc
@@ -0,0 +1,31 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ],
+  "rules": {
+    "scope-enum": [
+      1,
+      "always",
+      [
+        "repo",
+        "dotnet",
+        "core",
+        "utils",
+        "typescript",
+        "ci",
+        "release"
+      ]
+    ],
+    "type-enum": [
+      1,
+      "always",
+      [
+        "test",
+        "docs",
+        "chore",
+        "feat",
+        "fix"
+      ]
+    ]
+  }
+}
diff --git a/commitlint.config.js b/commitlint.config.js
diff --git a/packages/utils/src/lib/parameters.ts b/packages/utils/src/lib/parameters.ts
@@ -1,5 +1,10 @@
 import { cmdLineParameter } from './models';
 
+/**
+ * Transforms an array of cmdLineParameter into a string.
+ * @param parameters Parameters to transform into CLI arguments
+ * @returns Parameter string to be appended to CLI command
+ */
 export function getParameterString(parameters: cmdLineParameter[]): string {
   return parameters.reduce((acc, current) => {
     if (typeof current.value === 'boolean' && current.value) {