开源项目教程:JetBrains ReSharper Rider 插件
1. 项目的目录结构及介绍
目录结构
resharper-rider-plugin/
├── .github/
├── .idea/
├── build/
├── docs/
├── gradle/
├── resharper/
├── rider/
├── shared/
├── .gitignore
├── .gradle
├── build.gradle
├── gradlew
├── gradlew.bat
├── README.md
├── settings.gradle
目录介绍
- .github/: 包含GitHub相关的配置文件,如CI/CD配置。
- .idea/: 包含IntelliJ IDEA的项目配置文件。
- build/: 包含构建过程中生成的文件和目录。
- docs/: 包含项目的文档文件。
- gradle/: 包含Gradle的配置文件和脚本。
- resharper/: 包含ReSharper插件的源代码和资源文件。
- rider/: 包含Rider插件的源代码和资源文件。
- shared/: 包含共享的代码和资源文件。
- .gitignore: 指定Git版本控制系统忽略的文件和目录。
- .gradle: 包含Gradle的缓存和配置文件。
- build.gradle: 项目的Gradle构建脚本。
- gradlew: Gradle的Unix/Linux启动脚本。
- gradlew.bat: Gradle的Windows启动脚本。
- README.md: 项目的说明文档。
- settings.gradle: Gradle的多项目配置文件。
2. 项目的启动文件介绍
启动文件
- gradlew: Unix/Linux系统下的Gradle启动脚本。
- gradlew.bat: Windows系统下的Gradle启动脚本。
启动命令
-
对于Rider插件的开发和调试,可以使用以下命令启动IDE:
./gradlew :runIde
-
对于ReSharper插件的开发和调试,可以使用以下命令启动Visual Studio:
powershell \runVisualStudio.ps1
3. 项目的配置文件介绍
配置文件
- build.gradle: 项目的Gradle构建脚本,包含插件的版本、依赖、任务等配置。
- settings.gradle: Gradle的多项目配置文件,指定包含的子项目。
- plugin.xml: 插件的元数据文件,包含插件的ID、名称、版本、依赖等信息。
plugin.xml 示例
<idea-plugin>
<depends>com.intellij.modules.rider</depends>
<idea-version since-build="181.4379" until-build="182.*"/>
<id>com.company.plugin</id>
<version>1.3.3.7</version>
<name>MyCompanyPlugin</name>
</idea-plugin>
build.gradle 示例
plugins {
id 'java'
id 'org.jetbrains.intellij' version '1.1.4'
}
group 'com.company'
version '1.3.3.7'
repositories {
mavenCentral()
}
dependencies {
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'
}
intellij {
version = '2021.1'
type = 'RD'
plugins = ['com.intellij.modules.rider']
}
patchPluginXml {
sinceBuild = '181.4379'
untilBuild = '182.*'
}
test {
useJUnitPlatform()
}
以上是JetBrains ReSharper Rider 插件项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。