diff --git a/README.md b/README.md index ea7e93cb625967d1233e9f69a2df1ee40c8ffa25..7bc94a3e6cfbea1a4c68e031497d00706a55d27f 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,10 @@ Usage: | Parameter Name | Default | Description | Used in/for | |---|---|---|---| -| `repo_name` | `"test_repo"` | Name used in the URL of the project | Initialize `project_url`, `repo_url`, Generated directory | +| `repo_name` | `"test_repo"` | Name used in the URL of the project | Initialize `project_url`, `repo_url`, Generated project directory, last part of the Java package, prefix of version file, name of the published artifact | | `project_name` | `"My New Relational RAG Project"` | (Long) name of the project | Title in README, pages | | `project_short_name` | `"NewRelAST"` | (Short) name of the project | Name of the grammar, partly name of the test | -| `project_slug` | `"{{cookiecutter.project_name\|replace(' ','_')\|lower}}"` | (pre-computed) canonical name of the project without spaces | Last part of the Java package, prefix of version file, name of the published artifact | -| `package` | `"jastadd"` | Namespace used in the URL of the project | where? | -| `project_url` | `"git@git-st.inf.tu-dresden.de:{{cookiecutter.package}}/{{cookiecutter.repo_name}}.git"` | (pre-computed) URL to clone the project using SSH | Setting git `origin` remote | -| `repo_url` | `"https://git-st.inf.tu-dresden.de/{{cookiecutter.package}}/{{cookiecutter.repo_name}}"` | (pre-computed) URL of the project | Back-link to repository in pages | +| `namespace` | `"jastadd"` | Namespace of the gitlab repository | Namespace used in the URL of the project | +| `project_url` | `"git@git-st.inf.tu-dresden.de:{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}.git"` | (pre-computed) URL to clone the project using SSH | Setting git `origin` remote | +| `repo_url` | `"https://git-st.inf.tu-dresden.de/{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}"` | (pre-computed) URL of the project | Back-link to repository in pages | | `version` | `"0.0.1"` | Initial version of the project | version file | diff --git a/cookiecutter.json b/cookiecutter.json index 3620b4660834e5409ec86924a451212fa69c9811..6fda5b4f5213eef8f18b14c64fb2e7fa684cb953 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -2,10 +2,9 @@ "repo_name": "test_repo", "project_name": "My New Relational RAG Project", "project_short_name": "NewRelAST", - "project_slug": "{{cookiecutter.project_name|replace(' ','_')|lower}}", - "package": "jastadd", - "project_url": "git@git-st.inf.tu-dresden.de:{{cookiecutter.package}}/{{cookiecutter.repo_name}}.git", - "repo_url": "https://git-st.inf.tu-dresden.de/{{cookiecutter.package}}/{{cookiecutter.repo_name}}", + "namespace": "jastadd", + "project_url": "git@git-st.inf.tu-dresden.de:{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}.git", + "repo_url": "https://git-st.inf.tu-dresden.de/{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}", "version": "0.0.1", "_copy_without_render": [ "pages/custom_theme/footer.html" diff --git a/{{cookiecutter.repo_name}}/README.md b/{{cookiecutter.repo_name}}/README.md index 90ac361551082dd8db49134c5e44754fa649d319..b5b238ca73444e09dab7a80f006dadc1687d749e 100644 --- a/{{cookiecutter.repo_name}}/README.md +++ b/{{cookiecutter.repo_name}}/README.md @@ -1,3 +1,3 @@ # {{cookiecutter.project_name}} -For documentation, please see https://{{cookiecutter.package}}.pages.st.inf.tu-dresden.de/{{cookiecutter.repo_name}} +For documentation, please see https://{{cookiecutter.namespace}}.pages.st.inf.tu-dresden.de/{{cookiecutter.repo_name}} diff --git a/{{cookiecutter.repo_name}}/build.gradle b/{{cookiecutter.repo_name}}/build.gradle index 8e768bb9c5b99d5d1c68bd87d705681e51b47e3c..15e67b55e0cf781dfc1301cd7fdf75657d69b3bf 100644 --- a/{{cookiecutter.repo_name}}/build.gradle +++ b/{{cookiecutter.repo_name}}/build.gradle @@ -9,7 +9,7 @@ plugins { group 'de.tudresden.inf.st' ext { - mainClassName = 'de.tudresden.inf.st.{{cookiecutter.project_slug}}.Main' + mainClassName = 'de.tudresden.inf.st.{{cookiecutter.repo_name}}.Main' } // set the main class name for `gradle run` @@ -43,7 +43,7 @@ dependencies { testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: "${jupyter_version}" } -def versionFile = 'src/main/resources/{{cookiecutter.project_slug}}Version.properties' +def versionFile = 'src/main/resources/{{cookiecutter.repo_name}}Version.properties' def oldProps = new Properties() try { @@ -156,11 +156,11 @@ jastadd { // TODO uncomment of parser is used // parser.name = '{{cookiecutter.project_short_name}}Parser' - // scanner.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/scanner' - // parser.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/parser' + // scanner.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/scanner' + // parser.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/parser' module = 'relast-module' - astPackage = 'de.tudresden.inf.st.{{cookiecutter.project_slug}}.ast' + astPackage = 'de.tudresden.inf.st.{{cookiecutter.repo_name}}.ast' genDir = 'src/gen/java' buildInfoDir = 'src/gen-res' @@ -173,9 +173,9 @@ jastadd { publishing { publications { maven(MavenPublication) { - artifactId = '{{cookiecutter.project_slug}}' + artifactId = '{{cookiecutter.repo_name}}' // from components.java - artifact("build/libs/{{cookiecutter.project_slug}}-${version}.jar") { + artifact("build/libs/{{cookiecutter.repo_name}}-${version}.jar") { extension 'jar' } } diff --git a/{{cookiecutter.repo_name}}/pages/main.py b/{{cookiecutter.repo_name}}/pages/main.py index 3c7cffad934929410cbe39270c9487dade39d29f..5e4173b07555f077d5782e05e9cb1c56448f210d 100644 --- a/{{cookiecutter.repo_name}}/pages/main.py +++ b/{{cookiecutter.repo_name}}/pages/main.py @@ -1,9 +1,9 @@ -{{cookiecutter.project_slug}}VersionFileName = '../src/main/resources/{{cookiecutter.project_slug}}Version.properties' +{{cookiecutter.repo_name}}VersionFileName = '../src/main/resources/{{cookiecutter.repo_name}}Version.properties' def get_version(): - with open({{cookiecutter.project_slug}}VersionFileName) as {{cookiecutter.project_slug}}VersionFile: - versionFileContent = {{cookiecutter.project_slug}}VersionFile.read() + with open({{cookiecutter.repo_name}}VersionFileName) as {{cookiecutter.repo_name}}VersionFile: + versionFileContent = {{cookiecutter.repo_name}}VersionFile.read() return versionFileContent[versionFileContent.rindex('version=') + 8:].strip() @@ -17,7 +17,7 @@ def define_env(env): env.conf['site_name'] = '{{cookiecutter.project_name}} ' + get_version() @env.macro - def {{cookiecutter.project_slug}}_version(): + def {{cookiecutter.repo_name}}_version(): return get_version() diff --git a/{{cookiecutter.repo_name}}/settings.gradle b/{{cookiecutter.repo_name}}/settings.gradle index 69ba99157b6e657bd3479ce176a618383075a7b0..fec6f680ff33d8ac867669660202dd74e86e7577 100644 --- a/{{cookiecutter.repo_name}}/settings.gradle +++ b/{{cookiecutter.repo_name}}/settings.gradle @@ -1,2 +1,2 @@ -rootProject.name = '{{cookiecutter.project_slug}}' +rootProject.name = '{{cookiecutter.repo_name}}' diff --git a/{{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/Main.java b/{{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/Main.java similarity index 58% rename from {{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/Main.java rename to {{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/Main.java index f055a444a13bd4272cecd0666f24ec666e508707..fdce0c056b74fd23cb57eb9e3b9c23e5458de746 100644 --- a/{{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/Main.java +++ b/{{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/Main.java @@ -1,6 +1,6 @@ -package de.tudresden.inf.st.{{cookiecutter.project_slug}}; +package de.tudresden.inf.st.{{cookiecutter.repo_name}}; -import de.tudresden.inf.st.{{cookiecutter.project_slug}}.ast.*; +import de.tudresden.inf.st.{{cookiecutter.repo_name}}.ast.*; public class Main { diff --git a/{{cookiecutter.repo_name}}/src/main/resources/{{cookiecutter.project_slug}}Version.properties b/{{cookiecutter.repo_name}}/src/main/resources/{{cookiecutter.repo_name}}Version.properties similarity index 100% rename from {{cookiecutter.repo_name}}/src/main/resources/{{cookiecutter.project_slug}}Version.properties rename to {{cookiecutter.repo_name}}/src/main/resources/{{cookiecutter.repo_name}}Version.properties diff --git a/{{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/{{cookiecutter.project_short_name}}Test.java b/{{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/{{cookiecutter.project_short_name}}Test.java similarity index 63% rename from {{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/{{cookiecutter.project_short_name}}Test.java rename to {{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/{{cookiecutter.project_short_name}}Test.java index 0ccdd429fe29a220c473101e73d310b048b89af5..590a0bc416f21bbda34756376e6639ece8803a70 100644 --- a/{{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/{{cookiecutter.project_short_name}}Test.java +++ b/{{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/{{cookiecutter.project_short_name}}Test.java @@ -1,6 +1,6 @@ -package de.tudresden.inf.st.{{cookiecutter.project_slug}}; +package de.tudresden.inf.st.{{cookiecutter.repo_name}}; -import de.tudresden.inf.st.{{cookiecutter.project_slug}}.ast.*; +import de.tudresden.inf.st.{{cookiecutter.repo_name}}.ast.*; import org.junit.jupiter.api.Test; import static org.assertj.core.api.Assertions.assertThat;