itw-python-builder 0.1.31__tar.gz → 0.1.33__tar.gz

{itw_python_builder-0.1.31 → itw_python_builder-0.1.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: itw_python_builder
-Version: 0.1.31
+Version: 0.1.33
 Summary: Standardized Django deployment pipeline with Docker, testing, and SonarQube integration
 Author-email: IT-Works <contact@it-works.io>
 License: MIT

{itw_python_builder-0.1.31 → itw_python_builder-0.1.33}/itw_python_builder/ssr_tasks.py

@@ -43,6 +43,147 @@ def _angular_core_installed_version() -> str:
         return json.load(fp).get('version', '')
 
 
+def _read_angular_json() -> dict:
+    """Read angular.json from cwd. Returns empty dict if missing/invalid."""
+    path = os.path.join(os.getcwd(), 'angular.json')
+    if not os.path.isfile(path):
+        return {}
+    try:
+        with open(path, 'r', encoding='utf-8') as fp:
+            return json.load(fp)
+    except (OSError, json.JSONDecodeError):
+        return {}
+
+
+def _detect_angular_project(angular_json: dict) -> tuple:
+    """Return (project_name, project_data) for the project SSR was scaffolded into.
+
+    Priority: package.json `name` match → defaultProject → only project in repo.
+    Returns (None, None) if angular.json has no usable projects.
+    """
+    projects = angular_json.get('projects') or {}
+    if not projects:
+        return (None, None)
+    try:
+        pkg_name = _read_package_name()
+        if pkg_name in projects:
+            return (pkg_name, projects[pkg_name])
+    except Exception:
+        pass
+    default = angular_json.get('defaultProject')
+    if default and default in projects:
+        return (default, projects[default])
+    if len(projects) == 1:
+        name = next(iter(projects))
+        return (name, projects[name])
+    return (None, None)
+
+
+def _maybe_add_ssr_scripts(ctx: Context) -> None:
+    """Add build:ssr, build:ssr:staging, build:ssr:dev npm scripts based on angular.json.
+
+    Reads angular.json to detect:
+      - The builder (legacy `:browser` + separate `server` target, or modern `:application`)
+      - The project name (for `ng run <name>:server:<config>` in the legacy form)
+      - Which configurations exist (only writes scripts for configs that exist in both
+        `build` and, for legacy, `server` targets)
+
+    Never overwrites a script that already exists in package.json. Prints a summary
+    of what was added vs preserved vs skipped (no matching config).
+    """
+    angular_json = _read_angular_json()
+    if not angular_json:
+        print('[itw] No angular.json found — skipping SSR script setup.')
+        return
+
+    project_name, project = _detect_angular_project(angular_json)
+    if not project:
+        print('[itw] Could not detect Angular project in angular.json — skipping SSR script setup.')
+        return
+
+    arch = project.get('architect') or project.get('targets') or {}
+    build = arch.get('build') or {}
+    server = arch.get('server') or {}
+    builder = build.get('builder', '')
+
+    is_legacy = builder == '@angular-devkit/build-angular:browser' and bool(server)
+    is_modern = builder == '@angular-devkit/build-angular:application'
+    if not (is_legacy or is_modern):
+        print(f'[itw] Unrecognized build builder {builder!r} — skipping SSR script setup.')
+        return
+
+    build_configs = set((build.get('configurations') or {}).keys())
+    if is_legacy:
+        server_configs = set((server.get('configurations') or {}).keys())
+        usable_configs = build_configs & server_configs
+        builder_label = 'legacy (browser + server targets)'
+    else:
+        usable_configs = build_configs
+        builder_label = 'modern (application builder)'
+
+    print(f"[itw] Detected {builder_label} for project '{project_name}'.")
+
+    def cmd_for(config: str) -> str:
+        if is_legacy:
+            return f'ng build --configuration={config} && ng run {project_name}:server:{config}'
+        return f'ng build --configuration={config}'
+
+    script_map = {
+        'production': 'build:ssr',
+        'staging': 'build:ssr:staging',
+        'development': 'build:ssr:dev',
+    }
+
+    pkg_path = os.path.join(os.getcwd(), 'package.json')
+    with open(pkg_path, 'r', encoding='utf-8') as fp:
+        data = json.load(fp)
+    scripts = data.setdefault('scripts', {})
+
+    # The "ng add" schematic writes `build:ssr` as the implicit form
+    # `ng build && ng run <name>:server` (relies on Angular defaults). It works
+    # but it's not explicit. We normalize JUST that exact stub to the explicit
+    # form; any other existing value (custom prebuild steps, etc.) is preserved.
+    ng_add_stub = f'ng build && ng run {project_name}:server'
+
+    added, normalized, preserved, skipped = [], [], [], []
+    for config_name, script_name in script_map.items():
+        if config_name not in usable_configs:
+            skipped.append((script_name, config_name))
+            continue
+        existing = scripts.get(script_name)
+        is_stub = (
+            script_name == 'build:ssr'
+            and existing is not None
+            and ' '.join(existing.split()) == ng_add_stub
+        )
+        if existing is not None and not is_stub:
+            preserved.append(script_name)
+            continue
+        new_cmd = cmd_for(config_name)
+        scripts[script_name] = new_cmd
+        if is_stub:
+            normalized.append((script_name, new_cmd))
+        else:
+            added.append((script_name, new_cmd))
+
+    if added or normalized:
+        with open(pkg_path, 'w', encoding='utf-8') as fp:
+            json.dump(data, fp, indent=2)
+            fp.write('\n')
+
+    print('[itw] SSR npm scripts:')
+    for name, cmd in added:
+        print(f'       + added:      {name}  →  {cmd}')
+    for name, cmd in normalized:
+        print(f'       ~ normalized: {name}  →  {cmd}  (was ng-add\'s implicit form)')
+    for name in preserved:
+        print(f'       = preserved:  {name}  (already in package.json, not overwritten)')
+    for name, cfg in skipped:
+        print(f"       - skipped:    {name}  (no '{cfg}' config in angular.json)")
+    if not (added or normalized or preserved):
+        print('       (nothing added)')
+
+
 def _pin_ssr_deps_in_package_json(target_version: str) -> list:
     """Pin @angular/ssr and @angular/platform-server in package.json to exact target_version.
 
@@ -118,6 +259,24 @@ def _run_ng_add_ssr(ctx: Context) -> None:
     print(f'[itw] Running `ng add {package_spec}` (Angular {major}, this may take a minute)...')
     ctx.run(f'npx ng add {package_spec} {flags}')
 
+    # `ng add` typically rewrites package.json with a caret prefix (e.g. "^18.2.14"),
+    # and its internal `npm install` then resolves that range to the LATEST patch
+    # (often newer than the installed @angular/core), reintroducing the strict-peer
+    # conflict and pulling in @angular/ssr versions that reference symbols not in
+    # the installed @angular/platform-browser. Force-pin again post-ng-add and
+    # reinstall with --save-exact to lock the exact versions across package.json,
+    # package-lock.json, and node_modules.
+    if installed_core:
+        re_pinned = _pin_ssr_deps_in_package_json(installed_core)
+        if re_pinned:
+            print(f'[itw] Re-pinned {", ".join(re_pinned)} → {installed_core} (ng add introduced a caret range).')
+        print(f'[itw] Locking installed versions to {installed_core} with --save-exact...')
+        ctx.run(
+            f'npm install --save-exact '
+            f'@angular/ssr@{installed_core} '
+            f'@angular/platform-server@{installed_core}'
+        )
+
 
 def _install_ngx_seo_helper(ctx: Context) -> None:
     print('[itw] Installing ngx-seo-helper...')
@@ -182,29 +341,12 @@ def _print_next_steps(project_name: str) -> None:
     print()
     print('  1. Add `NgxSeoModule` to your AppModule imports.')
     print('  2. Fill in src/sitemap.routes.ts with your route tree.')
-    print('  3. Add `staging` (and optionally `development`) configurations to')
-    print('     angular.json under projects.' + project_name + '.architect.build.configurations.')
-    print('     ng add @angular/ssr only creates the `production` configuration.')
-    print()
-    print('  4. Add these two npm scripts to package.json — the deploy pipeline')
-    print('     calls them by name:')
-    print()
-    print('       "build:ssr":          "<build command for production>"')
-    print('       "build:ssr:staging":  "<build command for staging>"')
-    print()
-    print('     The exact command depends on which builder angular.json uses:')
-    print()
-    print('     • Modern application builder (default for fresh ng add @angular/ssr):')
-    print('         "build:ssr":         "ng build --configuration=production"')
-    print('         "build:ssr:staging": "ng build --configuration=staging"')
-    print()
-    print('     • Legacy browser builder (older projects with a separate server target):')
-    print(f'         "build:ssr":         "ng build --configuration=production && ng run {project_name}:server:production"')
-    print(f'         "build:ssr:staging": "ng build --configuration=staging && ng run {project_name}:server:staging"')
-    print()
-    print('  5. Verify locally: npm run build:ssr && npm run serve:ssr')
-    print('  6. Commit the new files.')
-    print('  7. Deploy with: itw incrementrc --ssr  (or incrementpatch/release --ssr)')
+    print('  3. If `build:ssr:staging` was skipped above, add a `staging` configuration')
+    print(f'     to angular.json (and the `server` target, if legacy builder), then re-run')
+    print('     `itw ssr-init --force` to add the missing scripts.')
+    print('  4. Verify locally: npm run build:ssr && npm run serve:ssr')
+    print('  5. Commit the new files.')
+    print('  6. Deploy with: itw incrementrc --ssr  (or incrementpatch/release --ssr)')
     print('=' * 70)
 
 
@@ -212,8 +354,9 @@ def _print_next_steps(project_name: str) -> None:
 def ssr_init(ctx: Context, force: bool = False) -> None:
     """One-time SSR scaffold: ng add @angular/ssr, ngx-seo-helper, sitemap stub, server.ts patch.
 
-    Does NOT write package.json scripts — those depend on which builder Angular
-    chose. The post-run message tells you the two scripts the pipeline expects.
+    Auto-adds the build:ssr / build:ssr:staging / build:ssr:dev npm scripts based
+    on angular.json (detects builder type and available configs). Existing scripts
+    are never overwritten.
     """
     if detect_project_type() != 'frontend':
         raise RuntimeError('ssr-init only runs on frontend (Angular) projects.')
@@ -230,6 +373,7 @@ def ssr_init(ctx: Context, force: bool = False) -> None:
     if not is_ssr_project():
         _run_ng_add_ssr(ctx)
 
+    _maybe_add_ssr_scripts(ctx)
     _install_ngx_seo_helper(ctx)
     _write_sitemap_template()
     _patch_server_ts()

{itw_python_builder-0.1.31 → itw_python_builder-0.1.33}/itw_python_builder.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: itw_python_builder
-Version: 0.1.31
+Version: 0.1.33
 Summary: Standardized Django deployment pipeline with Docker, testing, and SonarQube integration
 Author-email: IT-Works <contact@it-works.io>
 License: MIT

{itw_python_builder-0.1.31 → itw_python_builder-0.1.33}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "itw_python_builder"
-version = "0.1.31"
+version = "0.1.33"
 description = "Standardized Django deployment pipeline with Docker, testing, and SonarQube integration"
 readme = "README.md"
 requires-python = ">=3.10"