@koobiq/components 20.4.2 → 21.0.0

package/schematics/migrations/v21-upgrade/index.js

@@ -0,0 +1,94 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utility = require('@schematics/angular/utility');
+var utils_messages = require('../../utils/messages.js');
+var replacementDriver = require('../../replacement-driver-8o5P9eyQ.js');
+var migrations_v21Upgrade_data = require('./data.js');
+require('../../list-item-pattern-D95Y1KIk.js');
+require('../../package-config-BhU2TfC8.js');
+require('@angular-devkit/schematics');
+require('../../tag-patterns-CNbEB0iT.js');
+
+/** Rewrites a `styles` entry: a path, or an object with an `input` path. */
+function rewriteStyleEntry(entry, replacements) {
+    if (typeof entry === 'string')
+        return replacementDriver.applyReplacements(entry, replacements).content;
+    if (entry && typeof entry === 'object' && !Array.isArray(entry) && typeof entry.input === 'string') {
+        const input = replacementDriver.applyReplacements(entry.input, replacements).content;
+        return input === entry.input ? entry : { ...entry, input };
+    }
+    return entry;
+}
+/** Rewrites the entries of a `styles` array and drops the duplicates a rewrite produces; `null` if unchanged. */
+function migrateStyleEntries(entries, replacements) {
+    // The key of each kept entry → whether it was rewritten.
+    const kept = new Map();
+    const result = [];
+    let changed = false;
+    for (const entry of entries) {
+        const next = rewriteStyleEntry(entry, replacements);
+        const rewritten = next !== entry;
+        const key = JSON.stringify(next);
+        if (rewritten)
+            changed = true;
+        if (kept.has(key)) {
+            if (rewritten || kept.get(key)) {
+                changed = true;
+                continue;
+            }
+        }
+        else {
+            kept.set(key, rewritten);
+        }
+        result.push(next);
+    }
+    return changed ? result : null;
+}
+/**
+ * Rewrites the `styles` of every target and configuration of `project` (every project when omitted) in
+ * `angular.json`, which lies outside the project directory the rest of the migration walks. Returns whether
+ * anything changed.
+ */
+async function migrateWorkspaceStyles(tree, context, project, fix, replacements) {
+    let workspace;
+    try {
+        workspace = await utility.readWorkspace(tree);
+    }
+    catch {
+        return false;
+    }
+    let changed = false;
+    for (const [name, definition] of workspace.projects) {
+        if (project && name !== project)
+            continue;
+        for (const target of definition.targets.values()) {
+            for (const options of [target.options, ...Object.values(target.configurations ?? {})]) {
+                const styles = options?.styles;
+                if (!options || !Array.isArray(styles))
+                    continue;
+                const migrated = migrateStyleEntries(styles, replacements);
+                if (!migrated)
+                    continue;
+                options.styles = migrated;
+                changed = true;
+            }
+        }
+    }
+    if (!changed)
+        return false;
+    if (fix) {
+        await utility.writeWorkspace(tree, workspace);
+    }
+    else {
+        utils_messages.logMessage(context.logger, ['[v21-upgrade] would update the styles in angular.json (run with --fix to apply)']);
+    }
+    return true;
+}
+function v21Upgrade(options) {
+    const styleEntries = replacementDriver.compileReplacements(migrations_v21Upgrade_data.styleEntryReplacements);
+    return replacementDriver.replacementMigrationRule({ label: '[v21-upgrade]', tsReplacements: migrations_v21Upgrade_data.tsReplacements, templateReplacements: migrations_v21Upgrade_data.templateReplacements, scssReplacements: migrations_v21Upgrade_data.scssReplacements, warnPatterns: migrations_v21Upgrade_data.warnPatterns }, options, (tree, context, fix) => migrateWorkspaceStyles(tree, context, options.project, fix, styleEntries));
+}
+
+exports.default = v21Upgrade;

package/schematics/migrations/v21-upgrade/schema.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "$id": "koobiq-components-v21-upgrade",
+    "title": "Koobiq components v21.0.0 upgrade",
+    "type": "object",
+    "properties": {
+        "project": {
+            "type": "string",
+            "description": "Name of the project to migrate. If omitted, the migration runs over the whole tree.",
+            "$default": {
+                "$source": "projectName"
+            }
+        },
+        "fix": {
+            "type": "boolean",
+            "default": true,
+            "description": "When true, applies all auto-fix replacements. When false, prints what would change without writing."
+        }
+    }
+}

package/schematics/migrations/zoneless-change-detection/README.md

@@ -0,0 +1,30 @@
+# zoneless-change-detection
+
+Migration schematic invoked automatically by `ng update @koobiq/components@21`
+(registered for `21.0.0-0`). Reports the uses of the removed `MockNgZone` testing helper. It never
+writes to the tree.
+
+## Background
+
+Koobiq components no longer depend on zone.js. They render in applications bootstrapped with
+`provideZonelessChangeDetection()` and keep working with `provideZoneChangeDetection()`. Nothing in the
+library waits for `NgZone.onStable` any more: the work it deferred to that event now runs after the next
+render (`afterNextRender`).
+
+`MockNgZone` existed to fire `onStable` on demand in specs, so it is removed from
+`@koobiq/components/core`.
+
+## What it does _not_ do
+
+Nothing is rewritten: what a spec should do instead depends on what it was waiting for.
+
+| Pattern               | Manual migration                                                                     |
+| --------------------- | ------------------------------------------------------------------------------------ |
+| `MockNgZone`          | Remove the import and the `{ provide: NgZone, useFactory: () => new MockNgZone() }`  |
+| `.simulateZoneExit()` | `fixture.detectChanges()`, or `await fixture.whenStable()` (`tick()` in `fakeAsync`) |
+
+## Running it manually
+
+```
+ng generate @koobiq/components:zoneless-change-detection --project my-app
+```

package/schematics/migrations/zoneless-change-detection/data.js

@@ -0,0 +1,29 @@
+'use strict';
+
+/**
+ * Data for the `zoneless-change-detection` migration.
+ *
+ * The library no longer depends on zone.js: nothing in it waits for `NgZone.onStable` any more, so the
+ * `MockNgZone` testing helper, which existed to fire that event on demand, is removed from
+ * `@koobiq/components/core`. Warn-only: what a spec should wait for instead depends on what it was waiting for.
+ */
+const warnPatterns = [
+    {
+        pattern: '\\bMockNgZone\\b',
+        message: 'MockNgZone was removed from @koobiq/components/core: no Koobiq component waits for NgZone.onStable any ' +
+            'more. Drop the import and the `{ provide: NgZone, useFactory: () => new MockNgZone() }` override.'
+    },
+    {
+        pattern: '\\.simulateZoneExit\\s*\\(',
+        message: 'simulateZoneExit() has nothing left to flush. Render with fixture.detectChanges(), or wait with ' +
+            '`await fixture.whenStable()` (tick() / flush() inside fakeAsync).'
+    }
+];
+const SUMMARY = [
+    'Koobiq components now render without zone.js, and keep working in applications that still provide',
+    'provideZoneChangeDetection(). Specs that relied on zone.js running change detection after every event have',
+    'to render explicitly, see "Zoneless change detection" in the migration guide.'
+];
+
+exports.SUMMARY = SUMMARY;
+exports.warnPatterns = warnPatterns;

package/schematics/migrations/zoneless-change-detection/index.js

@@ -0,0 +1,20 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var warnOnlyMigration = require('../../warn-only-migration-BISJBODk.js');
+var migrations_zonelessChangeDetection_data = require('./data.js');
+require('../../utils/messages.js');
+require('../../package-config-BhU2TfC8.js');
+require('@angular-devkit/schematics');
+require('@schematics/angular/utility');
+
+/**
+ * Reports the uses of the removed `MockNgZone` testing helper. Never writes: a spec that waited for
+ * `NgZone.onStable` has to render or wait explicitly, and which of the two depends on the spec.
+ */
+function zonelessChangeDetection(options) {
+    return warnOnlyMigration.warnOnlyRule({ label: '[zoneless-change-detection]', warnPatterns: migrations_zonelessChangeDetection_data.warnPatterns, summary: migrations_zonelessChangeDetection_data.SUMMARY }, options);
+}
+
+exports.default = zonelessChangeDetection;

package/schematics/migrations/zoneless-change-detection/schema.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "$id": "koobiq-components-zoneless-change-detection",
+    "title": "Koobiq components zoneless change detection migration",
+    "type": "object",
+    "properties": {
+        "project": {
+            "type": "string",
+            "description": "Name of the project to inspect. If omitted, the migration runs over the whole tree.",
+            "$default": {
+                "$source": "projectName"
+            }
+        }
+    }
+}