@robineb/project-cli 1.0.2 → 1.1.1

package/dist/index.js

@@ -26,7 +26,12 @@ const STACKS = [
         label: "PlatformIO / ESP32 (Arduino)",
         template: "esp32",
     },
-    // TODO: hier deine weiteren Stacks eintragen (python, ...)
+    {
+        id: "python",
+        label: "Python Package (eigenes Template)",
+        template: "python",
+    },
+    // TODO: hier deine weiteren Stacks eintragen
 ];
 class GiteaProvider {
     baseUrl;
@@ -128,6 +133,19 @@ async function resolveGiteaCredentials() {
 // ---------------------------------------------------------------------------
 // 3. Die einzelnen Arbeitsschritte
 // ---------------------------------------------------------------------------
+// Deckt sowohl Gitea (Regel "AlphaDashDot") als auch GitHub ab: nur
+// alphanumerische Zeichen, "-", "_" und ".", muss mit alphanumerisch
+// beginnen und enden. Leerzeichen wie in "esp 32" fallen damit sofort auf,
+// statt erst nach Scaffold + erstem Commit bei der Remote-Erstellung.
+const PROJECT_NAME_PATTERN = /^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$/;
+function validateProjectName(name) {
+    if (!name?.trim())
+        return "Name darf nicht leer sein";
+    if (!PROJECT_NAME_PATTERN.test(name)) {
+        return "Name darf nur Buchstaben, Ziffern, '-', '_' und '.' enthalten (muss mit Buchstabe/Ziffer beginnen und enden)";
+    }
+    return undefined;
+}
 async function scaffold(stack, targetDir, name) {
     if (stack.command) {
         const { file, args } = stack.command(name);
@@ -139,7 +157,13 @@ async function scaffold(stack, targetDir, name) {
         const src = path.join(import.meta.dirname, "templates", stack.template);
         await fs.cp(src, targetDir, { recursive: true });
         await restoreGitignore(targetDir);
-        await replacePlaceholders(targetDir, { projectName: name });
+        // pythonPackageName: Bindestriche/Punkte sind in Projektnamen erlaubt
+        // (Gitea/GitHub-Repo-Namen), aber kein gültiger Python-Bezeichner ->
+        // eigener, bereinigter Platzhalter fürs Python-Template.
+        await replacePlaceholders(targetDir, {
+            projectName: name,
+            pythonPackageName: name.toLowerCase().replace(/[^a-z0-9_]+/g, "_"),
+        });
         return;
     }
     throw new Error(`Stack ${stack.id} hat weder command noch template`);
@@ -175,6 +199,29 @@ async function replacePlaceholders(dir, vars) {
         if (replaced !== content)
             await fs.writeFile(full, replaced, "utf8");
     }
+    await renamePlaceholderPaths(dir, vars);
+}
+// Datei-/Ordnernamen mit Platzhaltern umbenennen (z.B. src/{{projectName}}/
+// für ein Python-Package). Läuft rekursiv pro Verzeichnisebene von außen
+// nach innen und fragt bei jedem Schritt den aktuellen Verzeichnisinhalt
+// neu ab -> ein umbenannter Ordner wird mitsamt seinem (noch nicht
+// umbenannten) Inhalt an die neue Stelle verschoben, bevor wir tiefer
+// absteigen. Eine vorab gesammelte Pfadliste würde hier stale werden,
+// sobald ein Vorfahre umbenannt ist.
+async function renamePlaceholderPaths(dir, vars) {
+    const entries = await fs.readdir(dir, { withFileTypes: true });
+    for (const entry of entries) {
+        let renamedName = entry.name;
+        for (const [key, value] of Object.entries(vars)) {
+            renamedName = renamedName.replaceAll(`{{${key}}}`, value);
+        }
+        const oldPath = path.join(dir, entry.name);
+        const newPath = path.join(dir, renamedName);
+        if (renamedName !== entry.name)
+            await fs.rename(oldPath, newPath);
+        if (entry.isDirectory())
+            await renamePlaceholderPaths(newPath, vars);
+    }
 }
 async function initGit(targetDir) {
     const git = simpleGit(targetDir);
@@ -259,10 +306,20 @@ async function run(nameArg, opts) {
     const name = nameArg ??
         (await p.text({
             message: "Wie soll das Projekt heißen?",
-            validate: (v) => (v?.trim() ? undefined : "Name darf nicht leer sein"),
+            validate: (v) => validateProjectName(v),
         }));
     if (p.isCancel(name))
         return p.cancel("Abgebrochen.");
+    // nameArg kommt am Prompt vorbei (CLI-Argument statt p.text) -> hier
+    // nochmal prüfen. Sonst scheitert erst die Remote-Erstellung nach
+    // Scaffold + erstem Commit (Gitea/GitHub lehnen z.B. Leerzeichen im
+    // Namen mit "AlphaDashDot" bzw. 422 ab), und die lokale Arbeit ist
+    // bereits passiert, ohne dass ein Remote konfiguriert wurde.
+    const nameError = validateProjectName(name);
+    if (nameError) {
+        p.cancel(nameError);
+        return;
+    }
     const stackId = await p.select({
         message: "Welcher Stack?",
         options: STACKS.map((s) => ({ value: s.id, label: s.label })),

package/dist/templates/python/.gitattributes

@@ -0,0 +1 @@
+* text=auto

package/dist/templates/python/README.md

@@ -0,0 +1,15 @@
+# {{projectName}}
+
+## Entwicklung
+
+    python -m venv .venv
+    .venv\Scripts\activate      # Windows
+    source .venv/bin/activate   # macOS/Linux
+    pip install -e ".[dev]"
+
+    python -c "import {{pythonPackageName}}; {{pythonPackageName}}.main()"
+
+## Tests & Linting
+
+    pytest
+    ruff check .

package/dist/templates/python/gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

package/dist/templates/python/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "{{projectName}}"
+version = "0.1.0"
+requires-python = ">=3.12"
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "ruff>=0.6"]
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

package/dist/templates/python/src/{{pythonPackageName}}/__init__.py

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("{{projectName}} läuft")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robineb/project-cli",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "My own Project cli tool to start projecs",
   "license": "MIT",
   "repository": {