EpicKnarvik97/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2025-07-24 08:05:26 +02:00
Code Issues Projects Releases Wiki Activity

cleanup

Browse Source
This commit is contained in:
boy0001
2015-09-11 20:09:22 +10:00
parent 37a8861fa0
commit c386f33df8
380 changed files with 43490 additions and 33913 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
src/main/java/com/intellectualcrafters/plot/commands/GenerateDocs.java
View File

@@ -9,79 +9,86 @@ import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.intellectualcrafters.plot.PS;
import com.intellectualcrafters.plot.object.ConsolePlayer;
import com.intellectualcrafters.plot.object.PlotPlayer;
import com.intellectualcrafters.plot.util.Permissions;
import com.intellectualcrafters.plot.util.StringMan;
import com.plotsquared.general.commands.Command;
public class GenerateDocs {
public static void main(String[] args) {
public class GenerateDocs
{
public static void main(final String[] args)
{
MainCommand.getInstance().addCommand(new WE_Anywhere());
MainCommand.getInstance().addCommand(new Cluster());
ArrayList<Command<PlotPlayer>> commands = MainCommand.getInstance().getCommands();
final ArrayList<Command<PlotPlayer>> commands = MainCommand.getInstance().getCommands();
log("### Want to document some commands?");
log(" - This page is automatically generated");
log(" - Fork the project and add a javadoc comment to one of the command classes");
log(" - Then do a pull request and it will be added to this page");
log("");
log("# Contents");
for (CommandCategory category : CommandCategory.values()) {
for (final CommandCategory category : CommandCategory.values())
{
log("###### " + category.name());
for (Command<PlotPlayer> command : MainCommand.getCommands(category, null)) {
log(" - [/plot " + command.getCommand() + "](https://github.com/IntellectualSites/PlotSquared/wiki/Commands#" + command.getCommand() +") ");
for (final Command<PlotPlayer> command : MainCommand.getCommands(category, null))
{
log(" - [/plot " + command.getCommand() + "](https://github.com/IntellectualSites/PlotSquared/wiki/Commands#" + command.getCommand() + ") ");
}
log("");
}
log("# Commands");
for (Command<PlotPlayer> command : commands) {
for (final Command<PlotPlayer> command : commands)
{
printCommand(command);
}
}
public static void printCommand(Command<PlotPlayer> command) {
try {
String clazz = command.getClass().getSimpleName();
String name = command.getCommand();
public static void printCommand(final Command<PlotPlayer> command)
{
try
{
final String clazz = command.getClass().getSimpleName();
final String name = command.getCommand();
// Header
String source = "https://github.com/IntellectualSites/PlotSquared/tree/master/src/main/java/com/intellectualcrafters/plot/commands/" + clazz + ".java";
final String source = "https://github.com/IntellectualSites/PlotSquared/tree/master/src/main/java/com/intellectualcrafters/plot/commands/" + clazz + ".java";
log("## [" + name.toUpperCase() + "](" + source + ") ");
File file = new File("src/main/java/com/intellectualcrafters/plot/commands/" + clazz + ".java");
List<String> lines = Files.readAllLines(file.toPath(), StandardCharsets.UTF_8);
List<String> perms = getPerms(name, lines);
String comment = getComments(lines);
final File file = new File("src/main/java/com/intellectualcrafters/plot/commands/" + clazz + ".java");
final List<String> lines = Files.readAllLines(file.toPath(), StandardCharsets.UTF_8);
final List<String> perms = getPerms(name, lines);
final String comment = getComments(lines);
log("#### Description");
log("`" + command.getDescription() + "`");
if (comment.length() > 0) {
if (comment.length() > 0)
{
log("##### Comments");
log("``` java");
log(comment);
log("```");
}
log("#### Usage");
log("`" + command.getUsage().replaceAll("\\{label\\}", "plot") + "`");
if (command.getRequiredType() != RequiredType.NONE) {
if (command.getRequiredType() != RequiredType.NONE)
{
log("#### Required callers");
log("`" + command.getRequiredType().name() + "`");
}
Set<String> aliases = command.getAliases();
if (aliases.size() > 0) {
final Set<String> aliases = command.getAliases();
if (aliases.size() > 0)
{
log("#### Aliases");
log("`" + StringMan.getString(command.getAliases()) + "`");
}
log("#### Permissions");
log("##### Primary");
log(" - `" + command.getPermission() + "` ");
if (perms.size() > 0) {
if (perms.size() > 0)
{
log("");
log("##### Other");
log(" - `" + StringMan.join(perms, "`\n - `") + "`");
@@ -90,54 +97,68 @@ public class GenerateDocs {
log("***");
log("");
}
catch (Exception e) {
catch (final Exception e)
{
e.printStackTrace();
}
}
public static List<String> getPerms(String cmd, List<String> lines) {
ArrayList<String> perms = new ArrayList<String>();
Pattern p = Pattern.compile("\"([^\"]*)\"");
for (String line : lines) {
if (line.contains("Permissions.hasPermission(")) {
Matcher m = p.matcher(line);
while (m.find()) {
public static List<String> getPerms(final String cmd, final List<String> lines)
{
final ArrayList<String> perms = new ArrayList<String>();
final Pattern p = Pattern.compile("\"([^\"]*)\"");
for (final String line : lines)
{
if (line.contains("Permissions.hasPermission("))
{
final Matcher m = p.matcher(line);
while (m.find())
{
String perm = m.group(1);
if (perm.endsWith(".")) {
if (perm.endsWith("."))
{
perm += "<arg>";
}
if (perm.startsWith(".")) {
if (perm.startsWith("."))
{
perms.set(perms.size() - 1, perms.get(perms.size() - 1) + perm);
}
else if (perm.contains(".")) {
else if (perm.contains("."))
{
perms.add(perm);
}
}
}
}
switch (cmd.toLowerCase()) {
switch (cmd.toLowerCase())
{
case "auto":
case "claim": {
case "claim":
{
perms.add("plots.plot.#");
break;
}
}
return perms;
}
public static String getComments(List<String> lines) {
StringBuilder result = new StringBuilder();
for (String line : lines) {
public static String getComments(final List<String> lines)
{
final StringBuilder result = new StringBuilder();
for (String line : lines)
{
line = line.trim();
if (line.startsWith("/** ") || line.startsWith("*/ ") || line.startsWith("* ")) {
if (line.startsWith("/** ") || line.startsWith("*/ ") || line.startsWith("* "))
{
line = (line.replaceAll("/[*][*] ", "").replaceAll("[*]/ ", "").replaceAll("[*] ", "")).trim();
result.append(line + "\n");
}
}
return result.toString().trim();
}
public static void log(String s) {
public static void log(final String s)
{
System.out.println(s);
}
}