From 068af321a24e9cbb58ee75e4211ed60aaa566e5d Mon Sep 17 00:00:00 2001 From: craig-clephane Date: Mon, 7 Jun 2021 13:11:19 +0100 Subject: [PATCH 1/3] Update publish.js Applied dropdowns on categories, and added search by file name --- publish.js | 98 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 68 insertions(+), 30 deletions(-) diff --git a/publish.js b/publish.js index 2ca79b1..163150a 100644 --- a/publish.js +++ b/publish.js @@ -1,5 +1,4 @@ 'use strict' - var doop = require('jsdoc/util/doop') var env = require('jsdoc/env') var fs = require('jsdoc/fs') @@ -240,6 +239,7 @@ function generate(title, subtitle, docs, filename, resolveLinks) { } outpath = path.join(outdir, filename) + html = view.render('container.tmpl', docData) if (resolveLinks) { @@ -261,6 +261,7 @@ function generateSourceFiles(sourceFiles, encoding) { try { source = { kind: 'source', + file: sourceFiles[file].shortened, code: helper.htmlsafe( fs.readFileSync(sourceFiles[file].resolved, encoding) ) } } @@ -318,6 +319,7 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { const subCategories = items.reduce((memo, item) => { const subCategory = item.subCategory || '' memo[subCategory] = memo[subCategory] || [] + console.log(memo[subCategory]) return { ...memo, [subCategory]: [...memo[subCategory], item] @@ -327,7 +329,7 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { const subCategoryNames = Object.keys(subCategories) var nav = '' - + // console.log(items, itemHeading, itemsSeen, linktoFn) subCategoryNames.forEach((subCategoryName) => { const subCategoryItems = subCategories[subCategoryName] if (subCategoryItems.length) { @@ -335,9 +337,11 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { subCategoryItems.forEach(function(item) { var displayName + + var filename = item.filename if ( !hasOwnProp.call(item, 'longname') ) { - itemsNav += '
  • ' + linktoFn('', item.name) + '
    • ' + itemsNav += '
  • ' + linktoFn('', item.name) + '

    '+filename+'

    ' + '
    • ' } else if ( !hasOwnProp.call(itemsSeen, item.longname) ) { if (env.conf.templates.default.useLongnameInNav) { @@ -345,7 +349,7 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { } else { displayName = item.name } - itemsNav += '
  • ' + linktoFn(item.longname, displayName.replace(/\b(module|event):/g, '')) + itemsNav += '
  • '+ linktoFn(item.longname, displayName.replace(/\b(module|event):/g, '')) + '

    '+filename+'

    ' if (item.children && item.children.length) { itemsNav += '' } @@ -371,8 +377,15 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { if (subCategoryName) { heading = heading + ' / ' + subCategoryName } - nav += '

    ' + heading + '

    ' - } + + // Dropdown extra + // var buttonheading = "'" + heading +"'" + // nav += '

    ' + heading + '

    ' + // } + + + nav += '

    ' + heading + '

    ' + itemsNav + '' + } } }) @@ -392,10 +405,15 @@ function buildGroupNav (members, title) { var seenTutorials = {} var nav = '' var seen = {} - nav += '
    ' + nav += '
    ' if (title) { - nav += '

    ' + title + '

    ' + var titleRef = "'" + title + "'" + var titleRefMenuIcon = "'" + title +"_arrow" + "'" + nav += '

    ' + title +'

    ' + '
    ' + '
    ' + +//

    view

    } + nav += '
    ' nav += buildMemberNav(members.tutorials || [], 'Tutorials', seenTutorials, linktoTutorial) nav += buildMemberNav(members.modules || [], 'Modules', {}, linkto) nav += buildMemberNav(members.externals || [], 'Externals', seen, linktoExternal) @@ -405,25 +423,29 @@ function buildGroupNav (members, title) { nav += buildMemberNav(members.events || [], 'Events', seen, linkto) nav += buildMemberNav(members.mixins || [], 'Mixins', seen, linkto) nav += buildMemberNav(members.components || [], 'Components', seen, linkto) - - if (members.globals && members.globals.length) { - globalNav = '' - members.globals.forEach(function(g) { - if ( g.kind !== 'typedef' && !hasOwnProp.call(seen, g.longname) ) { - globalNav += '
  • ' + linkto(g.longname, g.name) + '
    • ' - } - seen[g.longname] = true - }) + - if (!globalNav) { - // turn the heading into a link so you can actually get to the global page - nav += '

    ' + linkto('global', 'Global') + '

    ' - } - else { - nav += '

    Global

    ' + if (members.globals && members.globals.length) { + globalNav = '' + + members.globals.forEach(function(g) { + var filename = g.filename + if ( g.kind !== 'typedef' && !hasOwnProp.call(seen, g.longname) ) { + globalNav += '
  • ' + linkto(g.longname, g.name) + '

    '+filename+'

    '+ '
    • ' + } + seen[g.longname] = true + }) + + if (!globalNav) { + // turn the heading into a link so you can actually get to the global page + nav += '

    ' + linkto('global', 'Global') + '

    ' + } + else { + nav += '

    Global

    ' + globalNav + } } - } + nav += '' nav += '' return nav } @@ -445,7 +467,8 @@ function buildGroupNav (members, title) { */ function buildNav(members, navTypes = null, betterDocs) { const href = betterDocs.landing ? 'docs.html' : 'index.html' - var nav = navTypes ? '' : `

    Documentation

    ` + var nav = navTypes ? '' : '' + // var nav = navTypes ? '' : `

    Documentation

    ` var categorised = {} var rootScope = {} @@ -467,8 +490,8 @@ function buildNav(members, navTypes = null, betterDocs) { } }) }) - - nav += buildGroupNav(rootScope) + + nav += buildGroupNav(rootScope, 'Core') Object.keys(categorised).sort().forEach(function (category) { nav += buildGroupNav(categorised[category], category) }) @@ -476,6 +499,16 @@ function buildNav(members, navTypes = null, betterDocs) { return nav } +function addFilename (f, filename) { + f.filename = filename + + // var types = f.type ? buildItemTypeStrings(f) : [] + + // f.signature = (f.signature || '') + '' + + // (types.length ? ' :' + types.join('|') : '') + '' + +} + /** @param {TAFFY} taffyData See . @param {object} opts @@ -654,6 +687,12 @@ exports.publish = function(taffyData, opts, tutorials) { addSignatureReturns(doclet) addAttribs(doclet) } + if(doclet.meta) { + var filename = getPathFromDoclet(doclet) + filename = sourceFiles[filename].shortened + addFilename(doclet, filename) + } + }) // do this after the urls have all been generated @@ -673,7 +712,6 @@ exports.publish = function(taffyData, opts, tutorials) { }) view.smallHeader = !conf.betterDocs.navButtons - members = helper.getMembers(data) if (opts.tutorials) { // sort tutorials @@ -707,8 +745,8 @@ exports.publish = function(taffyData, opts, tutorials) { view.tutoriallink = tutoriallink; view.htmlsafe = htmlsafe view.outputSourceFiles = outputSourceFiles - // once for all + // console.log(members) view.nav = buildNav(members, null, conf.betterDocs) view.tutorialsNav = buildNav(members, ['tutorials'], conf.betterDocs) From bde40e8d1695e8977bc78b3bd3eb15a85b638feb Mon Sep 17 00:00:00 2001 From: craig-clephane Date: Tue, 8 Jun 2021 11:51:09 +0100 Subject: [PATCH 2/3] Update publish.js Added file structure, swapped categories to files --- publish.js | 150 ++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 137 insertions(+), 13 deletions(-) diff --git a/publish.js b/publish.js index 163150a..a7c9a2a 100644 --- a/publish.js +++ b/publish.js @@ -11,6 +11,7 @@ var util = require('util') const { getParser } = require('jsdoc/util/markdown') var bundler = require('./bundler') +const { exit } = require('process') const markdownParser = getParser() var htmlsafe = helper.htmlsafe @@ -319,7 +320,7 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { const subCategories = items.reduce((memo, item) => { const subCategory = item.subCategory || '' memo[subCategory] = memo[subCategory] || [] - console.log(memo[subCategory]) + // console.log(memo[subCategory]) return { ...memo, [subCategory]: [...memo[subCategory], item] @@ -349,6 +350,7 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { } else { displayName = item.name } + itemsNav += '
  • '+ linktoFn(item.longname, displayName.replace(/\b(module|event):/g, '')) + '

    '+filename+'

    ' if (item.children && item.children.length) { @@ -406,13 +408,20 @@ function buildGroupNav (members, title) { var nav = '' var seen = {} nav += '
    ' + + + + if (title) { var titleRef = "'" + title + "'" var titleRefMenuIcon = "'" + title +"_arrow" + "'" - nav += '

    ' + title +'

    ' + '
    ' + '
    ' + nav += '

    ' + title +'

    ' + '
    ' + '
    ' //

    view

    } + + // nav += '

    '+members.shortFilename+'

    ' + nav += '
    ' nav += buildMemberNav(members.tutorials || [], 'Tutorials', seenTutorials, linktoTutorial) nav += buildMemberNav(members.modules || [], 'Modules', {}, linkto) @@ -439,10 +448,10 @@ function buildGroupNav (members, title) { if (!globalNav) { // turn the heading into a link so you can actually get to the global page - nav += '

    ' + linkto('global', 'Global') + '

    ' + nav += '

    ' + linkto('global', 'Global') + '

    ' } else { - nav += '

    Global

    ' + globalNav + nav += '

    Global

    ' + globalNav } } nav += '
    ' @@ -470,30 +479,130 @@ function buildNav(members, navTypes = null, betterDocs) { var nav = navTypes ? '' : '' // var nav = navTypes ? '' : `

    Documentation

    ` - var categorised = {} + var fileCategories = {} + var categories = {} var rootScope = {} + // var experiment = { } + var types = navTypes || ['modules', 'externals', 'namespaces', 'classes', 'components', 'interfaces', 'events', 'mixins', 'globals'] types.forEach(function(type) { if (!members[type]) { return } members[type].forEach(function(element) { + if (element.access && element.access === 'private') { return } - if (element.category) { - if (!categorised[element.category]){ categorised[element.category] = [] } - if (!categorised[element.category][type]){ categorised[element.category][type] = [] } - categorised[element.category][type].push(element) + + // if (element.category) { + // if (!categorised[element.category]){ categorised[element.category] = [] } + // if (!categorised[element.category][type]){ categorised[element.category][type] = [] } + // categorised[element.category][type].push(element) + // } else { + // rootScope[type] ? rootScope[type].push(element) : rootScope[type] = [element] + // } + + if(element.shortFilename) { + if (!fileCategories[element.shortFilename]){ fileCategories[element.shortFilename] = [] } + if (!fileCategories[element.shortFilename][type]){ fileCategories[element.shortFilename][type] = [] } + fileCategories[element.shortFilename][type].push(element) } else { rootScope[type] ? rootScope[type].push(element) : rootScope[type] = [element] } + + if(element.category) { + if (!categories[element.category]){ categories[element.category] = [] } + if (!categories[element.category][type]){ categories[element.category][type] = [] } + categories[element.category][type].push(element) + } + + // if (element.category) { + // if (!categorised[element.category]){ categorised[element.category] = [] } + // if (!categorised[element.category][type]){ categorised[element.category][type] = [] } + // categorised[element.category][type].push(element) + // } else { + // rootScope[type] ? rootScope[type].push(element) : rootScope[type] = [element] + // } + + // { + // "demo.js" : { + // "class" : [] + // } + // } + // { + // "root" : { + // "demo.js" : { + // "class" : [] + // } + // "core" : { + // "demo2.js" : { + // "class" : [] + // } + // } + // } + // } + + // // Build file path + // if(element.filename) { + // var spiltedStr = element.filename.split('/'); + // if(Array.isArray(spiltedStr)) { + // // Is in files. + // if(spiltedStr.length > 1) { + // for(let i = 0; i < spiltedStr.length; i++) { + + // if (!experiment[spiltedStr[i]]){ experiment[spiltedStr[i]] = [] } + + // } + // spiltedStr.forEach(function(path) { + + // if (!experiment[element.path]){ experiment[element.path] = [] } + + + // if (!experiment[element.fileName][type]){ experiment[element.fileName][type] = [] } + // experiment[element.fileName][type].push(element) + + // }) + // } + + // } + + // } + }) }) - nav += buildGroupNav(rootScope, 'Core') - Object.keys(categorised).sort().forEach(function (category) { - nav += buildGroupNav(categorised[category], category) + nav += '

    Files

    ' + + if(Object.keys(categories).length > 0) { + nav += '

    Categories

    ' + } + + nav += '
    ' + + nav += '
    ' + + nav += buildGroupNav(rootScope, 'Unlisted') + + // Object.keys(categorised).sort().forEach(function (category) { + // nav += buildGroupNav(categorised[category], category) + // }) + + Object.keys(fileCategories).sort().forEach(function (category) { + + nav += buildGroupNav(fileCategories[category], category) + + }) + + nav += '
    ' + + Object.keys(categories).sort().forEach(function (category) { + nav += '
    ' + + nav += buildGroupNav(categories[category], category) + + nav += '
    ' + }) return nav @@ -509,6 +618,16 @@ function addFilename (f, filename) { } +function addShortFilename (f, filename) { + f.shortFilename = filename + + // var types = f.type ? buildItemTypeStrings(f) : [] + + // f.signature = (f.signature || '') + '' + + // (types.length ? ' :' + types.join('|') : '') + '' + +} + /** @param {TAFFY} taffyData See . @param {object} opts @@ -590,6 +709,7 @@ exports.publish = function(taffyData, opts, tutorials) { } }) } + if (doclet.see) { doclet.see.forEach(function(seeItem, i) { doclet.see[i] = hashToLink(doclet, seeItem) @@ -689,8 +809,11 @@ exports.publish = function(taffyData, opts, tutorials) { } if(doclet.meta) { var filename = getPathFromDoclet(doclet) + filename = sourceFiles[filename].shortened + var shortFilename = doclet.meta.filename addFilename(doclet, filename) + addShortFilename(doclet, shortFilename) } }) @@ -712,7 +835,9 @@ exports.publish = function(taffyData, opts, tutorials) { }) view.smallHeader = !conf.betterDocs.navButtons + members = helper.getMembers(data) + if (opts.tutorials) { // sort tutorials try { @@ -726,7 +851,6 @@ exports.publish = function(taffyData, opts, tutorials) { } members.tutorials = tutorials.children } - } else { members.tutorials = tutorials.children } From 128838a5efa18d98467efa784d1bffdc08379985 Mon Sep 17 00:00:00 2001 From: craig-clephane Date: Wed, 9 Jun 2021 10:24:57 +0100 Subject: [PATCH 3/3] Update publish.js Updated unlisted --- publish.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/publish.js b/publish.js index a7c9a2a..a22e81e 100644 --- a/publish.js +++ b/publish.js @@ -572,6 +572,10 @@ function buildNav(members, navTypes = null, betterDocs) { }) }) + Object.keys(categories).length + + // nav += '

    Total files '+ Object.keys(categories).length+' documented

    ' + nav += '

    Files

    ' if(Object.keys(categories).length > 0) { @@ -582,7 +586,6 @@ function buildNav(members, navTypes = null, betterDocs) { nav += '
    ' - nav += buildGroupNav(rootScope, 'Unlisted') // Object.keys(categorised).sort().forEach(function (category) { // nav += buildGroupNav(categorised[category], category) @@ -594,6 +597,8 @@ function buildNav(members, navTypes = null, betterDocs) { }) + nav += buildGroupNav(rootScope, 'Unlisted') + nav += '
    ' Object.keys(categories).sort().forEach(function (category) { @@ -605,6 +610,7 @@ function buildNav(members, navTypes = null, betterDocs) { }) + return nav }