[INTERNAL] JSDoc: Make API private by default

.eslintrc.js

@@ -7,6 +7,9 @@ module.exports = {
         "ecmaVersion": 8
     },
     "extends": ["eslint:recommended", "google"],
+    "plugins": [
+        "jsdoc"
+    ],
     "rules": {
         "indent": [
             "error",
@@ -36,15 +39,32 @@ module.exports = {
         "comma-dangle": "off",
         "no-tabs": "off",
         "no-console": "off", // sometimes needed by CLI
-        'valid-jsdoc': [
-            2,
-            {
-                requireParamDescription: false,
-                requireReturnDescription: false,
-                requireReturn: false,
-                prefer: {return: 'returns'},
+        "valid-jsdoc": 0,
+        "jsdoc/check-examples": 2,
+        "jsdoc/check-param-names": 2,
+        "jsdoc/check-tag-names": 2,
+        "jsdoc/check-types": 2,
+        "jsdoc/newline-after-description": 2,
+        "jsdoc/no-undefined-types": 0,
+        "jsdoc/require-description": 0,
+        "jsdoc/require-description-complete-sentence": 0,
+        "jsdoc/require-example": 0,
+        "jsdoc/require-hyphen-before-param-description": 0,
+        "jsdoc/require-param": 2,
+        "jsdoc/require-param-description": 0,
+        "jsdoc/require-param-name": 2,
+        "jsdoc/require-param-type": 2,
+        "jsdoc/require-returns": 0,
+        "jsdoc/require-returns-description": 0,
+        "jsdoc/require-returns-type": 2,
+        "jsdoc/valid-types": 0
+    },
+    "settings": {
+        "jsdoc": {
+            "tagNamePreference": {
+                "return": "returns"
             }
-        ],
+        }
     },
     "root": true
 };

index.js

@@ -1,5 +1,7 @@
-const ui5Cli = {
+/**
+ * @module @ui5/cli
+ * @private
+ */
+module.exports = {
 	init: require("./lib/init/init").init
 };
-
-module.exports = ui5Cli;

jsdoc.json

@@ -1,9 +1,9 @@
 {
     "tags": {
-        "allowUnknownTags": true
+        "allowUnknownTags": false
     },
     "source": {
-        "include": ["README.md"],
+        "include": ["README.md", "index.js"],
         "includePattern": ".+\\.js$",
         "excludePattern": "(node_modules(\\\\|/))"
     },
@@ -13,10 +13,48 @@
         "encoding": "utf8",
         "destination": "jsdocs/",
         "recurse": true,
-        "verbose": true
+        "verbose": true,
+        "access": "public"
     },
     "templates": {
         "cleverLinks": false,
-        "monospaceLinks": false
+        "monospaceLinks": false,
+        "default": {
+            "useLongnameInNav": true
+        }
+    },
+    "openGraph": {
+        "title": "UI5 Build and Development Tooling - API Reference",
+        "type": "website",
+        "image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png",
+        "site_name": "UI5 Build and Development Tooling - API Reference",
+        "url": "https://sap.github.io/ui5-tooling/"
+    },
+    "docdash": {
+        "sectionOrder": [
+            "Modules",
+            "Namespaces",
+            "Classes",
+            "Externals",
+            "Events",
+            "Mixins",
+            "Tutorials",
+            "Interfaces"
+        ],
+        "meta": {
+            "title": "UI5 Build and Development Tooling - API Reference - UI5 CLI",
+            "description": "UI5 Build and Development Tooling - API Reference - UI5 CLI",
+            "keyword": "openui5 sapui5 ui5 build development tool api reference"
+        },
+        "search": true,
+        "wrap": true,
+        "menu": {
+            "GitHub": {
+                "href": "https://github.com/SAP/ui5-cli",
+                "target": "_blank",
+                "class": "menu-item",
+                "id": "github_link"
+            }
+        }
     }
 }

lib/cli/middlewares/base.js

@@ -3,6 +3,7 @@ const logger = require("./logger");
  * Base middleware for CLI commands.
  *
  * This middleware should be executed for every CLI command to enable basic features (e.g. logging).
+ *
  * @param {Object} argv The CLI arguments
  * @returns {Object}
  */

lib/cli/middlewares/logger.js

@@ -1,7 +1,6 @@
 /**
- * Logger middleware
- *
  * Logger middleware used as one of default middlewares by tooling
+ *
  * @param {Object} argv logger arguments
  * @returns {Object} logger instance or null
  */

lib/init/init.js

@@ -60,7 +60,8 @@ function getProjectType(hasWebapp, hasSrc, hasTest) {
  *
  * Checks the package.json and tries to determine the project type. If the <b>ui5.yaml</b> file does not exist,
  * it is created with the basic project configuration.
- * @module init/init
+ *
+ * @module @ui5/cli/init
  * @param {string} cwd Current working directory
  * @returns {Promise} Promise resolving with the project configuration object
  */