From 154a42e1009a51706f583f9ecb81538596a0d2a4 Mon Sep 17 00:00:00 2001
From: rschoene <rene.schoene@tu-dresden.de>
Date: Fri, 11 Mar 2022 18:30:48 +0100
Subject: [PATCH] Replace project_slug with repo_name, and rename package to
namespace
---
README.md | 9 ++++-----
cookiecutter.json | 7 +++----
{{cookiecutter.repo_name}}/README.md | 2 +-
{{cookiecutter.repo_name}}/build.gradle | 14 +++++++-------
{{cookiecutter.repo_name}}/pages/main.py | 8 ++++----
{{cookiecutter.repo_name}}/settings.gradle | 2 +-
.../Main.java | 4 ++--
...> {{cookiecutter.repo_name}}Version.properties} | 0
.../{{cookiecutter.project_short_name}}Test.java | 4 ++--
9 files changed, 24 insertions(+), 26 deletions(-)
rename {{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{{cookiecutter.project_slug}} => {{cookiecutter.repo_name}}}/Main.java (58%)
rename {{cookiecutter.repo_name}}/src/main/resources/{{{cookiecutter.project_slug}}Version.properties => {{cookiecutter.repo_name}}Version.properties} (100%)
rename {{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{{cookiecutter.project_slug}} => {{cookiecutter.repo_name}}}/{{cookiecutter.project_short_name}}Test.java (63%)
diff --git a/README.md b/README.md
index ea7e93c..7bc94a3 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 3620b46..6fda5b4 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 90ac361..b5b238c 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 8e768bb..15e67b5 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 3c7cffa..5e4173b 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 69ba991..fec6f68 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 f055a44..fdce0c0 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 0ccdd42..590a0bc 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;
--
GitLab