chore: home page configuration (#195)

* chore: changed home page title and moved navDocumentationLabel to config file * chore: config eslint and use optional chain in converter * chore: rebrand config
SoftwareBrothers · Feb 9, 2022 · 5d39022 · 5d39022
1 parent 09912a3
commit 5d39022
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 49 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,42 +1,60 @@
 module.exports = {
-    'env': {
-        'es6': true,
-        'node': true,
-        'mocha': true
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint", "mocha"],
+  env: {
+    es6: true,
+    node: true,
+    mocha: true,
+  },
+  extends: [
+    "airbnb",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:vue/essential",
+  ],
+  parserOptions: {
+    ecmaVersion: 2015,
+    sourceType: "module",
+  },
+  rules: {
+    indent: ["error", 2],
+    "linebreak-style": ["error", "unix"],
+    quotes: ["error", "single"],
+    semi: ["error", "never"],
+    "import/no-unresolved": "off",
+    "no-underscore-dangle": "off",
+    "guard-for-in": "off",
+    "no-restricted-syntax": "off",
+    "no-await-in-loop": "off",
+    "object-curly-newline": "off",
+  },
+  overrides: [
+    {
+      files: [
+        "*-test.js",
+        "*.spec.js",
+        "*-test.ts",
+        "*.spec.ts",
+        "*.spec.tsx",
+        "*.factory.ts",
+        "*.factory.js",
+      ],
+      rules: {
+        "no-unused-expressions": "off",
+        "func-names": "off",
+        "prefer-arrow-callback": "off",
+      },
     },
-    "extends": [
-        "plugin:vue/essential",
-        "eslint:recommended",
-        // 'airbnb'
-    ],
-    'parserOptions': {
-        'ecmaVersion': 2015,
-        'sourceType': 'module'
+    {
+      files: ["*.jsx", "*.js"],
+      rules: { "@typescript-eslint/explicit-function-return-type": "off" },
     },
-    'rules': {
-        'indent': ['error', 2],
-        'linebreak-style': ['error', 'unix'],
-        'quotes': ['error', 'single'],
-        'semi': ['error', 'never'],
-        'import/no-unresolved': 'off',
-        'no-underscore-dangle': 'off',
-        'guard-for-in': 'off',
-        'no-restricted-syntax': 'off',
-        'no-await-in-loop': 'off',
-        'object-curly-newline': 'off'
+    {
+      files: ["*.tsx"],
+      rules: { "react/prop-types": "off" },
     },
-    overrides: [
-        {
-          files: ['*-test.js', '*.spec.js'],
-          rules: {
-            'no-unused-expressions': 'off',
-            'func-names': 'off',
-            'prefer-arrow-callback': 'off',
-            "react/jsx-filename-extension": 'off'
-          }
-        }
-    ],
-    globals: {
-        'expect': true,
-    }
-}
+  ],
+  globals: {
+    expect: true,
+    window: true,
+  },
+};
diff --git a/README.md b/README.md
@@ -442,7 +442,7 @@ _(To read more about passing options - scroll down to __Customization__ section)
     "opts": {...},
     "templates": {
         "better-docs": {
-            "name": "AdminBro Documentation",
+            "name": "Sample Documentation",
             "component": {
               "wrapper": "./path/to/your/wrapper-component.js",
             },
@@ -533,7 +533,7 @@ So let's say you want to add `babel-polyfill` and 'bulma.css' framework to your
     "opts": {...},
     "templates": {
         "better-docs": {
-            "name": "AdminBro Documentation",
+            "name": "Sample Documentation",
             "component": {
                 "entry": [
                     "import 'babel-polyfill';",
@@ -592,7 +592,7 @@ Example configuration file with settings for both `default` and `better-docs` te
             }
         },
         "better-docs": {
-            "name": "AdminBro Documentation",
+            "name": "Sample Documentation",
             "logo": "images/logo.png",
             "title": "", // HTML title
             "css": "style.css",

diff --git a/fixtures/typescript/type3.js b/fixtures/typescript/type3.js
@@ -1,8 +1,8 @@
 const input =
 `
 /**
- * Type representing the AdminBro.Router
- * @memberof AdminBro
+ * Type representing the Sample.Router
+ * @memberof Sample
  * @alias RouterType
  */
 export type RouterType = {
@@ -21,7 +21,7 @@ export type RouterType = {
 `
 
 const outputs = [
-  '* @memberof AdminBro',
+  '* @memberof Sample',
   '* @alias RouterType',
   '* @typedef {object} RouterType',
   '* @property {Array<object>} assets',

diff --git a/jsdoc.json b/jsdoc.json
@@ -22,8 +22,7 @@
     },
     "templates": {
         "better-docs": {
-            "name": "AdminBro Documentation",
-            "logo": "images/logo.png"
+            "name": "Sample Documentation"
         }
     }
 }
diff --git a/publish.js b/publish.js
@@ -721,7 +721,7 @@ exports.publish = function(taffyData, opts, tutorials) {
     generateSourceFiles(sourceFiles, opts.encoding)
   }
 
-  if (members.globals.length) { generate('Global', 'Title', [{kind: 'globalobj'}], globalUrl) }
+  if (members.globals.length) { generate('Global', null, [{kind: 'globalobj'}], globalUrl) }
 
   // index page displays information from package.json and lists files
   files = find({kind: 'file'})

diff --git a/tmpl/topnav.tmpl b/tmpl/topnav.tmpl
@@ -39,7 +39,7 @@
                     href="<?js= betterDocs.landing ? 'docs.html' : 'index.html' ?>"
                     class="link"
                 >
-                    API Documentation
+                    <?js= betterDocs.navDocumentationLabel || 'Documentation' ?>
                 </a>
                 <?js if (this.tutorials.length) { ?>
                 <div class="dropdown is-hoverable is-right">

diff --git a/typescript/type-converter.js b/typescript/type-converter.js
@@ -42,7 +42,7 @@ const getTypeName = (type, src) => {
  * Fetches name from a node.
  */
 const getName = (node, src) => {
-  let name = node.name && node.name.escapedText
+  let name = node.name?.escapedText
   || node.parameters && src.substring(node.parameters.pos, node.parameters.end)
 
   // changing type [key: string] to {...} - otherwise it wont be parsed by @jsdoc