Skip to content

Prevent doclet paths from being shortened twice #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Prevent doclet paths from being shortened twice #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions publish.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,20 +99,14 @@ function shortenPaths(files, commonPrefix) {
return files;
}

function resolveSourcePath(filepath) {
return path.resolve(process.cwd(), filepath);
}

function getPathFromDoclet(doclet) {
if (!doclet.meta) {
return;
}

var filepath = doclet.meta.path && doclet.meta.path !== 'null' ?
return doclet.meta.path && doclet.meta.path !== 'null' ?
doclet.meta.path + '/' + doclet.meta.filename :
doclet.meta.filename;

return filepath;
}

function generate(title, docs, filename, resolveLinks) {
Expand All @@ -137,7 +131,7 @@ function generate(title, docs, filename, resolveLinks) {
function generateSourceFiles(sourceFiles) {
Object.keys(sourceFiles).forEach(function(file) {
var source;
// links are keyed to the shortened path in each doclet's `meta.filename` property
// links are keyed to the shortened path in each doclet's `meta.shortpath.` property
var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened);
helper.registerLink(sourceFiles[file].shortened, sourceOutfile);

Expand Down Expand Up @@ -315,15 +309,13 @@ exports.publish = function(taffyData, opts, tutorials) {

// build a list of source files
var sourcePath;
var resolvedSourcePath;
if (doclet.meta) {
sourcePath = getPathFromDoclet(doclet);
resolvedSourcePath = resolveSourcePath(sourcePath);
sourceFiles[sourcePath] = {
resolved: resolvedSourcePath,
resolved: sourcePath,
shortened: null
};
sourceFilePaths.push(resolvedSourcePath);
sourceFilePaths.push(sourcePath);
}
});

Expand Down Expand Up @@ -373,13 +365,13 @@ exports.publish = function(taffyData, opts, tutorials) {
var url = helper.createLink(doclet);
helper.registerLink(doclet.longname, url);

// replace the filename with a shortened version of the full path
// add a shortened version of the full path
var docletPath;
if (doclet.meta) {
docletPath = getPathFromDoclet(doclet);
docletPath = sourceFiles[docletPath].shortened;
if (docletPath) {
doclet.meta.filename = docletPath;
doclet.meta.shortpath = docletPath;
}
}
});
Expand Down
2 changes: 1 addition & 1 deletion tmpl/method.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ var self = this;

<?js if (data.meta) {?>
<div class="tag-source">
<?js= self.linkto(meta.filename) ?>, <?js= self.linkto(meta.filename, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
<?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
</div>
<?js } ?>
</div>
Expand Down