forked from bazelbuild/bazel
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Simple Markdown rendering for skydoc
This uses apache velocity engine templates to create markdown-HTML. There are other alternatives, but there is already precedent for depending on this library from docgen. RELNOTES: None. PiperOrigin-RevId: 203795431
- Loading branch information
Showing
22 changed files
with
626 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
src/main/java/com/google/devtools/build/skydoc/rendering/AttributeInfo.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
// Copyright 2018 The Bazel Authors. All rights reserved. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package com.google.devtools.build.skydoc.rendering; | ||
|
||
/** | ||
* Stores information about a skylark attribute definition. | ||
*/ | ||
public class AttributeInfo { | ||
|
||
private final String name; | ||
private final String docString; | ||
|
||
public AttributeInfo(String name, String docString) { | ||
this.name = name; | ||
this.docString = docString; | ||
} | ||
|
||
public String getName() { | ||
return name; | ||
} | ||
|
||
public String getDocString() { | ||
return docString; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
// Copyright 2018 The Bazel Authors. All rights reserved. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package com.google.devtools.build.skydoc.rendering; | ||
|
||
import com.google.common.base.Joiner; | ||
import java.io.IOException; | ||
import java.io.StringWriter; | ||
import java.util.List; | ||
import java.util.stream.Collectors; | ||
import org.apache.velocity.VelocityContext; | ||
import org.apache.velocity.app.VelocityEngine; | ||
import org.apache.velocity.exception.MethodInvocationException; | ||
import org.apache.velocity.exception.ParseErrorException; | ||
import org.apache.velocity.exception.ResourceNotFoundException; | ||
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader; | ||
import org.apache.velocity.runtime.resource.loader.JarResourceLoader; | ||
|
||
/** | ||
* Produces skydoc output in markdown form. | ||
*/ | ||
public class MarkdownRenderer { | ||
|
||
private static final String TEMPLATE_FILENAME = | ||
"com/google/devtools/build/skydoc/rendering/templates/test.vm"; | ||
|
||
private final VelocityEngine velocityEngine; | ||
|
||
public MarkdownRenderer() { | ||
this.velocityEngine = new VelocityEngine(); | ||
velocityEngine.setProperty("resource.loader", "classpath, jar"); | ||
velocityEngine.setProperty("classpath.resource.loader.class", | ||
ClasspathResourceLoader.class.getName()); | ||
velocityEngine.setProperty("jar.resource.loader.class", JarResourceLoader.class.getName()); | ||
velocityEngine.setProperty("input.encoding", "UTF-8"); | ||
velocityEngine.setProperty("output.encoding", "UTF-8"); | ||
velocityEngine.setProperty("runtime.references.strict", true); | ||
} | ||
|
||
/** | ||
* Returns a markdown rendering of rule documentation for the given rule information object with | ||
* the given rule name. | ||
*/ | ||
public String render(String ruleName, RuleInfo ruleInfo) throws IOException { | ||
VelocityContext context = new VelocityContext(); | ||
// TODO(cparsons): Attributes in summary form should have links. | ||
context.put("summaryform", getSummaryForm(ruleName, ruleInfo)); | ||
context.put("ruleName", ruleName); | ||
context.put("ruleInfo", ruleInfo); | ||
|
||
StringWriter stringWriter = new StringWriter(); | ||
try { | ||
velocityEngine.mergeTemplate(TEMPLATE_FILENAME, "UTF-8", context, stringWriter); | ||
} catch (ResourceNotFoundException | ParseErrorException | MethodInvocationException e) { | ||
throw new IOException(e); | ||
} | ||
return stringWriter.toString(); | ||
} | ||
|
||
private static String getSummaryForm(String ruleName, RuleInfo ruleInfo) { | ||
List<String> attributeNames = ruleInfo.getAttributes().stream() | ||
.map(attr -> attr.getName()) | ||
.collect(Collectors.toList()); | ||
return String.format("%s(%s)", ruleName, Joiner.on(", ").join(attributeNames)); | ||
} | ||
} |
Oops, something went wrong.