Tai e Template
1.0.0
Примечание
Нажмите кнопку « Использовать этот шаблон» (не вилка ).
Это шаблонный проект, предназначенный для демонстрации того, как разработать свой собственный статический анализ, используя Tai-E (простая в разработке/использование статического анализа структуры для Java) в качестве зависимости в проекте Gradle или Maven.
Основная цель этого шаблон-проекта-ускорить фазу настройки статического анализа разработки поверх Tai-E как для новых, так и для опытных разработчиков путем предварительного фигура проектного каркаса и поддержания всего организованного.
Этот шаблонный проект содержит как связанные с Градл, так и связанные с Maven файлы. Таким образом, вам нужно выбрать используемый инструмент сборки, сосредоточиться на необходимых в нем файлах и удалить другие неактуальные файлы.
Для пользователей Gradle требуются следующие файлы, в то время как другие могут быть удалены:
.
├── gradle (Gradle Wrapper)
├── src (Source code folder)
├── build.gradle.kts (Gradle configuration)
├── gradlew (*nix Gradle Wrapper script)
└── gradlew.bat (Windows Gradle Wrapper script)
Для пользователей Maven требуются следующие файлы, в то время как другие можно удалить:
.
├── .mvn (Maven Wrapper)
├── src (Source code folder)
├── mvnw (*nix Maven Wrapper script)
├── mvnw.cmd (Windows Maven Wrapper script)
└── pom.xml (Maven configuration)
Предупреждение
Обязательно удалите все незамеченные файлы из вашего проекта.
Прежде чем погрузиться в разработку статического анализа и все, что связано с ним, стоит упомянуть преимущества использования шаблонов GitHub. Создавая новый проект, используя текущий шаблон, вы начинаете без истории или ссылки на этот репозиторий. Это позволяет легко создавать новый репозиторий без копирования и вставки предыдущего контента, репозиториев клонов или очистки истории вручную.
Все, что вам нужно сделать, это нажать кнопку Use this template (вы должны войти в систему со своей учетной записью GitHub).
Как только это будет завершено, проект готов к клонированию в вашей местной среде и открыт Intellij Idea.
Следующий шаг, после открытия вашего проекта в Intellij Idea, - установить правильный SDK на Java в версии 17 в настройках структуры проекта. Тогда вы можете приступить к работе, реализуя свои идеи.
Подготовленный шаблон обеспечивает как можно меньше кода, потому что общий каркас невозможно выполнить все конкретные требования для всех статических анализов поверх Tai-E. Следовательно, шаблон содержит только следующие файлы:
.
└── src
├── main
│ └── java
│ └── org
│ └── example
│ └── MyMain.java (Your analyzer code)
└── test
└── resources
├── MyClass.java (The program analyzed by your analyzer)
└── *.class (All the .class files obtained by compiling MyClass.java with Java 17)
Файлы build.gradle.kts и pom.xml являются файлами конфигурации проекта для Gradle и Maven, соответственно. Есть некоторые общие свойства, которые вам нужно изменить позже при работе над собственным кодом анализатора.
Метаданные проекта:
group = " org.example "
description = " tai-e-template "
version = " 0.0.1-SNAPSHOT "Точка входа класса вашего анализатора:
application {
mainClass.set( " org.example.MyMain " )
}Указанная версия Tai-E:
val taieVersion = " 0.2.2 "Метаданные проекта:
< groupId >org.example</ groupId >
< artifactId >tai-e-template</ artifactId >
< version >0.0.1-SNAPSHOT</ version >Точка входа класса вашего анализатора:
< build >
...
< mainClass >org.example.MyMain</ mainClass >
...
</ build >Указанная версия Tai-E:
< properties >
...
< tai-e .version>0.2.2</ tai-e .version>
</ properties >Если вам нужно проверить, как запустить свой анализатор из командной строки (например, при разработке в средах без головы, таких как удаленные серверы):
Для пользователей Gradle запустите ./gradlew run , чтобы выполнить свой анализатор.
Для пользователей Maven запустите ./mvnw test , чтобы выполнить свой анализатор.
