refactor(templates): Simplify tap template file names with `post_gen_…

…project.py` hook (#2060) * refactor(templates): simplify file names with `post_gen_project.py` hook * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * revert(templates): undo changes within client files and only keep rename * chore: remove template ci files from `check-yaml` pre-commit hook * refactor(template): simplify folder remove in `post_gen_project.py` by using `shutil.rmtree` --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Edgar Ramírez Mondragón <[email protected]>
meltano · Nov 21, 2023 · 424e777 · 424e777
1 parent 206c38e
commit 424e777
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 3 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,7 +17,9 @@ repos:
     exclude: |
         (?x)^(
             cookiecutter/.*/meltano.yml|
-            cookiecutter/.*/.pre-commit-config.yaml
+            cookiecutter/.*/.pre-commit-config.yaml|
+            cookiecutter/.*/dependabot.yml|
+            cookiecutter/.*/test.yml
         )$
   - id: end-of-file-fixer
     exclude: |

diff --git a/cookiecutter/tap-template/cookiecutter.json b/cookiecutter/tap-template/cookiecutter.json
@@ -14,8 +14,8 @@
     "JWT",
     "Custom or N/A"
   ],
-  "include_ci_files": ["GitHub", "None (Skip)"],
-  "license": ["Apache-2.0"],
+  "include_ci_files": ["GitHub", "None"],
+  "license": ["Apache-2.0", "None"],
   "__prompts__": {
     "source_name": "The name of the source, in CamelCase",
     "admin_name": "Provide your [bold yellow]full name[/]",

diff --git a/cookiecutter/tap-template/hooks/post_gen_project.py b/cookiecutter/tap-template/hooks/post_gen_project.py
@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+from pathlib import Path
+import shutil
+
+
+BASE_PATH = Path('{{cookiecutter.library_name}}')
+
+
+if __name__ == '__main__':
+
+    # Rename stream type client and delete others
+    target = Path(BASE_PATH, 'client.py')
+    Path(BASE_PATH, '{{cookiecutter.stream_type|lower}}-client.py').rename(target)
+    [c.unlink() for c in Path(BASE_PATH).rglob("*-client.py")]
+
+    if '{{ cookiecutter.auth_method }}' not in ('OAuth2', 'JWT'):
+        Path(BASE_PATH, 'auth.py').unlink()
+
+    if '{{ cookiecutter.stream_type }}' == 'SQL':
+        Path(BASE_PATH, 'streams.py').unlink()
+
+    if '{{ cookiecutter.license }}' != 'Apache-2.0':
+        Path('LICENSE').unlink()
+
+    if '{{ cookiecutter.include_ci_files }}' != 'GitHub':
+        shutil.rmtree(Path('.github'))
+
diff --git a/...les == 'GitHub' %}dependabot.yml{%endif%} → ...kiecutter.tap_id}}/.github/dependabot.yml b/...les == 'GitHub' %}dependabot.yml{%endif%} → ...kiecutter.tap_id}}/.github/dependabot.yml
diff --git a/..._ci_files == 'GitHub' %}test.yml{%endif%} → ...utter.tap_id}}/.github/workflows/test.yml b/..._ci_files == 'GitHub' %}test.yml{%endif%} → ...utter.tap_id}}/.github/workflows/test.yml
diff --git a/...= cookiecutter.license %}LICENSE{%endif%} → ...-template/{{cookiecutter.tap_id}}/LICENSE b/...= cookiecutter.license %}LICENSE{%endif%} → ...-template/{{cookiecutter.tap_id}}/LICENSE
diff --git a/...utter.tap_id}}/tests/{{ 'test' }}_core.py → ...{cookiecutter.tap_id}}/tests/test_core.py b/...utter.tap_id}}/tests/{{ 'test' }}_core.py → ...{cookiecutter.tap_id}}/tests/test_core.py
diff --git a/...od in ('OAuth2', 'JWT')%}auth.py{%endif%} → ...d}}/{{cookiecutter.library_name}}/auth.py b/...od in ('OAuth2', 'JWT')%}auth.py{%endif%} → ...d}}/{{cookiecutter.library_name}}/auth.py
diff --git a/...iecutter.stream_type %}client.py{%endif%} → ...iecutter.library_name}}/graphql-client.py b/...iecutter.stream_type %}client.py{%endif%} → ...iecutter.library_name}}/graphql-client.py
diff --git a/...iecutter.stream_type %}client.py{%endif%} → ...okiecutter.library_name}}/other-client.py b/...iecutter.stream_type %}client.py{%endif%} → ...okiecutter.library_name}}/other-client.py
diff --git a/...iecutter.stream_type %}client.py{%endif%} → ...ookiecutter.library_name}}/rest-client.py b/...iecutter.stream_type %}client.py{%endif%} → ...ookiecutter.library_name}}/rest-client.py
diff --git a/...iecutter.stream_type %}client.py{%endif%} → ...cookiecutter.library_name}}/sql-client.py b/...iecutter.stream_type %}client.py{%endif%} → ...cookiecutter.library_name}}/sql-client.py
diff --git a/...ecutter.stream_type %}streams.py{%endif%} → .../{{cookiecutter.library_name}}/streams.py b/...ecutter.stream_type %}streams.py{%endif%} → .../{{cookiecutter.library_name}}/streams.py