CodeMaker - GitLite

KO | EN

gitlite — search

#javascript #ai #typescript #llm #android #deep-learning #linux #nodejs #macos #cli #awesome-list #ios #mcp #openai

CodeMaker

(★ 520)

A idea-plugin for Java/Scala, support custom code template.

파일 탐색기

최종 버전 다운로드 (.zip)

.gitignore
build.gradle
LICENSE
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/x-hansong/CodeMaker

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd CodeMaker

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# CodeMaker
A idea-plugin for Java/Scala to generate code, support custom code template.

![demonstration](https://blog.xiaohansong.com/media/15473672636863/15473884273212.gif)

This plugin generates code from right click 'Generate...' menu while focused on a Java/Scala class. The output class can be customized using a provided velocity template to format the code based on the origin class and optional selected classes. There are many features are contributed by [Dmitry Karlinsky](https://github.com/dkarlinsky) and I appreciate that.

The following features are available:

- Support add custom template to generate more code.(Velocity templates and groovy templates)
- Generate the model class for the persistent class.
- Generate the converter class for the model class and the persistent class.
- Generate `@see` doc for override method.
- Support Scala.
- Generate api table from code

# Install
## Option 1
- Search 'CodeMaker' in Idea plugins repository.

## Option 2
Download [Releases](https://github.com/x-hansong/CodeMaker/releases)

To install a plugin from the disk in idea

1. Open the Settings/Preferences dialog box and select Plugins on the left pane.
2. On the right pane of the dialog, click the Install plugin from disk button.
3. In the dialog that opens, select the desired plugin. You can quickly locate and select the necessary file if you drag-and-drop the corresponding item from your file browser (Explorer, Finder, etc.) into the area where the tree is shown. Click OK to proceed.
4. Click Apply button of the Settings/Preferences dialog.
5. Following the system prompt that appears, restart IntelliJ IDEA to activate the installed plugin, or postpone it, at your choice.

# Usage
This plugin generates code from right click 'Generate...' menu while focused on a Java/Scala class. 
![Generate](https://blog.xiaohansong.com/media/15473672636863/15473884589294.png)

The plugin support multiple class to generate one code, you can set the class number of template to select multiple classes to use.

![select class](https://blog.xiaohansong.com/media/15473672636863/15473884679965.png)

# Configuration
![configure](https://blog.xiaohansong.com/media/15473672636863/15473884761333.png)
- **Add template**: click "Add Template" button to add a template, after saving changes.
- **Delete template**: click "Delete Template" button to delete a template.

![property](https://blog.xiaohansong.com/media/15473672636863/15473884844568.png)
- **classNumber**: The template context will contain the class which user select when trigger the generate action. for example, the number is 1, the template context only has the focused class: $class0; if the number is 2, when you trigger the generate action, you need select a class, then the template context will have two class entry: $class0, $class1
- **className**: The class name support velocity and the template context.

## Template Context
```
########################################################################################
##
## Common variables:
##  $YEAR - yyyy
##  $TIME - yyyy-MM-dd HH:mm:ss
##  $USER - user.name
##
## Available variables:
##  $class0 - the context class, alias: $class
##  $class1 - the selected class, like $class1, $class2
##  $ClassName - generate by the config of "Class Name", the generated class name
##
## Class Entry Structure:
##  $class0.className - the class Name
##  $class0.packageName - the packageName
##  $class0.importList - the list of imported classes name
##  $class0.fields - the list of the class fields
##          - type: the field type
##          - name: the field name
##          - modifier: the field modifier, like "private",or "@Setter private" if include annotations
##  $class0.allFields - the list of the class fields include all fields of superclass
##          - type: the field type
##          - name: the field name
##          - modifier: the field modifier, like "private",or "@Setter private" if include annotations
##  $class0.methods - the list of class methods
##          - name: the method name
##          - modifier: the method modifier, like "private static"
##          - returnType: the method returnType
##          - params: the method params, like "(String name)"
##  $class0.allMethods - the list of class methods include all methods of superclass
##          - name: the method name
##          - modifier: the method modifier, like "private static"
##          - returnType: the method returnType
##          - params: the method params, like "(String name)"#
########################################################################################
```

### Advance
If you want to add variables into template context, you can modified the source and package the plugin to meet your needs.

The injection of template context is executed by `com.xiaohansong.codemaker.action.CodeMakerAction.generateCode`

```
private String generateCode(CodeTemplate codeTemplate, List<ClassEntry> selectClasses) {
        Map<String, Object> map = new HashMap<>();
        for (int i = 0; i < selectClasses.size(); i++) {
            map.put("class" + i, selectClasses.get(i));
        }
        Date now = new Date();
        map.put("class", selectClasses.get(0));
        map.put("YEAR", DateFormatUtils.format(now, "yyyy"));
        map.put("TIME", DateFormatUtils.format(new Date(), "yyyy-MM-dd HH:mm:ss"));
        map.put("USER", System.getProperty("user.name"));
        String className = VelocityUtil.evaluate(codeTemplate.getClassNameVm(), map);
        map.put("ClassName", className);
        map.put("utils", new Utils());
        map.put("BR", "\n");

return VelocityUtil.evaluate(codeTemplate.getCodeTemplate(), map);
    }
```