Todo-issue is a plugin that lets you easily write github issues while you are coding.This plugin enables the developer to add comments in the source code that will be translated to github issues.After the issues are closed in github/gitlab the todo-s will be removed from the source automatically in the next execution of the find goal.This will help the developing team to keep track of the bugs and tasks assigned to specific users.
To se a demo project clone this repository and follow the instructions.
Todo issue from version 1.0.0 uses YAML human friendly data serialization standard for issues.The yaml script is put inside the @todo and @end tags.
/*
@todo
title: Issue title
body: |
# Body of the issue.
### Markdown is also supported.
assignee: kujtimiihoxha
labels: java,todo
milestone: v1.0.6
@end
*/title: Is the title od the issue. REQUIREDbody: Is the body of the issue, the text can be markdown formatted. REQUIREDassignee: Who is assigned to this issue.labels: Labels of this issue.milestone: Milestone title of this issue.
Make sure that the yaml script formatting is met or the plugin will throw parsing error,
title,body,assignee,labels and milestone must have the same white space before them, and the body content
must be spaced one tab inside the body tag.
This is not allowed ❌
/*
@todo
title: Issue title
body: |
# Body of the issue.
### Markdown is also supported.
assignee: kujtimiihoxha
labels: java,todo
milestone: v1.0.6
@end
*/This is not allowed ❌
/*
@todo
title: Issue title
body: |
# Body of the issue.
### Markdown is also supported.
assignee: kujtimiihoxha
labels: java,todo
milestone: v1.0.6
@end
*/If you are using Intellij you can use these settings to add a live template to make it easy to write todo comments, unzip the archive and import the settings to Intellij.
This is how it would look like :
Just start writing @todo and hit enter then Intellij will automatically add the todo.
Before you can run the find goal you must add the file todo.json to the base directory(where the pom.xml is if you ar using maven).
Remember to add todo.json to the .gitignore file because it contains your access token.
{
"git-server":"Github",
"gitlab-url":"https://gitlab.com/",
"repository-username":"kujtimiihoxha",
"issuer-username":"kujtimiihoxha",
"token":"token",
"repository":"todo-issue",
"file-link":true
}git-server: can be "Github" or "Gitlab".gitlab-url: if you are using "Gitlab" you must provide the gitlab server url.repository-username: the repository user.issuer-username: the user who is writing the issues.token: the user access token.repository: the repository to post issues to .file-link: if set to false it will not add the file and line link to the end of the issue, by default it is true .
- To execute
findgoal add the plugin to your build tag.
<build>
<plugins>
<plugin>
<groupId>com.kujtimhoxha.plugins</groupId>
<artifactId>todo-issue-plugin</artifactId>
<version>1.0.6</version>
<configuration>
<sources>
<source>{source folder path }</source>
<source>{any other folder path }</source>
</sources>
</configuration>
<executions>
<execution>
<goals>
<goal>find</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>With this configurations the plugin will search for todo-s in every build by runing.
mvn clean install- Or you can add a dedicated profile for the plugin
<profiles>
<profile>
<id>todo</id>
<build>
<plugins>
<plugin>
<groupId>com.kujtimhoxha.plugins</groupId>
<artifactId>todo-issue-plugin</artifactId>
<version>1.0.6</version>
<configuration>
<sources>
<source>{source folder path }</source>
<source>{any other folder path }</source>
</sources>
</configuration>
<executions>
<execution>
<goals>
<goal>find</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profiles>Now you can run the plugin by executing :
mvn clean install -Ptodo- You can also run todo-issue from the commandline and just add it to your dependencies
<dependencies>
<dependency>
<groupId>com.kujtimhoxha.plugins</groupId>
<artifactId>todo-issue-plugin</artifactId>
<version>1.0.6</version>
</dependency>
</dependencies>Run:
mvn clean com.kujtimhoxha.plugins:todo-issue-plugin:find -Dsources={source folder path },{any other folder path }- Excludes : Folders/Files to exclude from the search.
<configuration>
<sources>
<source>{source folder path }</source>
<source>{any other folder path }</source>
</sources>
<excludes>
<exclude>{folder/file path to exclude}</exclude>
<exclude>{another folder/file path to exclude}</exclude>
</excludes>
</configuration>- Config : Specify the path of the todo.json file, by default it will look for todo.json in the base directory of the project.
<configuration>
<sources>
<source>{source folder path }</source>
<source>{any other folder path }</source>
</sources>
<config>{new path}/todo.json</config>
</configuration>- Types : File types to search for todos, by default it only searches in
.javafiles you can change this property and override the dfault.
<configuration>
<sources>
<source>{source folder path }</source>
<source>{any other folder path }</source>
</sources>
<types>
<type>.java</type>
<type>.html</type>
<type>.js</type>
</types>
</configuration>Although todo-issue is a maven plugin if needed todo-issue can be used in gradle (Android development projects). For use with gradle todo-issue has a special GradleRunner that will be used to run with gradle you must setup the build.gradle to use todo-issue.
- Add buildscript :
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath "com.kujtimhoxha.plugins:todo-issue-plugin:1.0.6"
}
}
- Add maven repository and todo-issue dependency to your project :
repositories {
mavenCentral()
}
dependencies {
compile "com.kujtimhoxha.plugins:todo-issue-plugin:1.0.6"
}
- Add find task :
task find(){
def sources = new ArrayList<File>();
sources.add(new File({source path}));
sources.add(new File({another source path}));
def todo= new com.kujtimhoxha.plugins.todo.GradleRunner(sources)
todo.run()
}
- If you need more configuration just use other constructors :
GradleRunner(final List<File> sources,final List<File> excludes)
GradleRunner(final List<File> sources, final List<File> excludes,final File config,final List<String> types)The defaults for this parameters are the same as the maven defaults.
To run this task just execute :
gradle task:find
To run find on every build just add it to the build dependencies.
build{
dependsOn find
}
Then when you execute :
gradle build
find task will be executed automatically.
You can find a demo gradle project in this repository.
Todo-issue can also be used with visual studio projects but you need to have Java and Maven installed.
To install java follow this tutorial and to install maven follow this tutorial .
To use todo-issue with your Visual Studio project you need to add a simple pom.xml file to your project where your .sln file is in this pom write :
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>your group id </groupId> <!--can be tour domain name like com.kujtimhoxha-->
<artifactId>your artifact name </artifactId> <!--application name -->
<version>1</version>
<build>
<plugins>
<plugin>
<groupId>com.kujtimhoxha.plugins</groupId>
<artifactId>todo-issue-plugin</artifactId>
<version>1.0.6</version>
<configuration>
<sources>
<source>${source-1}</source>
<source>${source-2}</source>
</sources>
<types>
<type>.cs</type>
</types>
</configuration>
<executions>
<execution>
<goals>
<goal>find</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>It is recommended to exclude unnecessary folders like the bin, obj and other folder that do not contain source code, in .net application it is recommended to exclude the scripts folder if you have many third party scripts because this will make the process of reading the files faster. How to exclude folders and files is described here. Then you need to add a todo.json file in the same place, the json file is as described above.
Now to execute this plugin in every build you need to we need to create a custom .bat file and place it where we put the pom.xml and todo.json
SET JAVA_HOME={Path to java home}
cd {Path to your project}
call {Path to maven home}\bin\mvn clean install
Save this file as todo.bat go to your project properties and go to build event and add this line to your post-build events
call {Path to your project}\todo.batNow on every build the plugin will search for todo's in your .cs files.
To help improve todo-issue clone this repo and submit pull requests with suggested changes.
Add unit tests for new features added and/or missing tests.
Please test your changes before sending a pull request by running :
mvn clean install Todo-issue is open-sourced software licensed under the MIT license