@payfit/nx-core 5.29.1 → 5.29.2

package/dist/src/generators/sync/files/nx-core-agents.md.template

@@ -0,0 +1,5 @@
+## nx-core
+
+- Release and publishing are handled by the `@payfit/nx-core` plugin, dry-run command is `npx nx run <root-nx-project>:release --dry-run`
+- CI should run Nx commands only (`nx run`, `nx run-many`, `nx affected`) rather than invoking underlying tooling directly.
+- Be careful when defining Nx targets: optimize `inputs`/`outputs` for Nx Cloud caching and validate with `npx nx-cloud conformance`.

package/dist/src/generators/sync/sync-agents.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from '@nx/devkit';
+import { SyncGeneratorResult } from 'nx/src/utils/sync-generators';
+export declare function syncAgents(tree: Tree): Promise<SyncGeneratorResult>;
+export default syncAgents;
+//# sourceMappingURL=sync-agents.d.ts.map

package/dist/src/generators/sync/sync-agents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-agents.d.ts","sourceRoot":"","sources":["../../../../src/generators/sync/sync-agents.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AAoClE,wBAAsB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,mBAAmB,CAAC,CA4CzE;AAED,eAAe,UAAU,CAAA"}

package/dist/src/generators/sync/sync-agents.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncAgents = syncAgents;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const AGENTS_FILE_PATH = 'AGENTS.md';
+const NX_CORE_START_MARKER = '<!-- nx-core start -->';
+const NX_CORE_MARKER_DESCRIPTION = '<!-- Leave the start & end comments to automatically receive updates. -->';
+const NX_CORE_END_MARKER = '<!-- nx-core end -->';
+const NX_CORE_RULES_REGEX = new RegExp(`${NX_CORE_START_MARKER}[\\s\\S]*?${NX_CORE_END_MARKER}`, 'm');
+function getReleaseManagedArtifactsTemplate() {
+    return (0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, 'files', 'nx-core-agents.md.template'), 'utf-8');
+}
+function getWrappedReleaseDocs(content) {
+    const trimmedContent = content.trim();
+    if (!trimmedContent) {
+        return `${NX_CORE_START_MARKER}\n${NX_CORE_MARKER_DESCRIPTION}\n${NX_CORE_END_MARKER}`;
+    }
+    return `${NX_CORE_START_MARKER}\n${NX_CORE_MARKER_DESCRIPTION}\n\n${trimmedContent}\n\n${NX_CORE_END_MARKER}`;
+}
+function contentOnly(content) {
+    return content
+        .replace(NX_CORE_START_MARKER, '')
+        .replace(NX_CORE_MARKER_DESCRIPTION, '')
+        .replace(NX_CORE_END_MARKER, '')
+        .replace(/\s/g, '');
+}
+async function syncAgents(tree) {
+    const expectedRules = getWrappedReleaseDocs(getReleaseManagedArtifactsTemplate());
+    if (!tree.exists(AGENTS_FILE_PATH)) {
+        tree.write(AGENTS_FILE_PATH, expectedRules);
+        return {
+            outOfSyncMessage: '/AGENTS.md file needs to be created',
+        };
+    }
+    const existingContent = tree.read(AGENTS_FILE_PATH, 'utf-8');
+    if (!existingContent) {
+        tree.write(AGENTS_FILE_PATH, expectedRules);
+        return {
+            outOfSyncMessage: '/AGENTS.md file needs to be updated',
+        };
+    }
+    const existingNxCoreBlock = existingContent.match(NX_CORE_RULES_REGEX);
+    if (existingNxCoreBlock) {
+        if (contentOnly(existingNxCoreBlock[0]) === contentOnly(expectedRules)) {
+            return;
+        }
+        const updatedContent = existingContent.replace(NX_CORE_RULES_REGEX, expectedRules);
+        tree.write(AGENTS_FILE_PATH, updatedContent);
+        return {
+            outOfSyncMessage: '/AGENTS.md file needs to be updated',
+        };
+    }
+    const updatedContent = `${existingContent}\n\n${expectedRules}`;
+    tree.write(AGENTS_FILE_PATH, updatedContent);
+    return {
+        outOfSyncMessage: '/AGENTS.md file needs to be updated',
+    };
+}
+exports.default = syncAgents;
+//# sourceMappingURL=sync-agents.js.map

package/dist/src/generators/sync/sync-agents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-agents.js","sourceRoot":"","sources":["../../../../src/generators/sync/sync-agents.ts"],"names":[],"mappings":";;AAwCA,gCA4CC;AApFD,qCAAsC;AACtC,yCAAgC;AAKhC,MAAM,gBAAgB,GAAG,WAAW,CAAA;AACpC,MAAM,oBAAoB,GAAG,wBAAwB,CAAA;AACrD,MAAM,0BAA0B,GAC9B,2EAA2E,CAAA;AAC7E,MAAM,kBAAkB,GAAG,sBAAsB,CAAA;AACjD,MAAM,mBAAmB,GAAG,IAAI,MAAM,CACpC,GAAG,oBAAoB,aAAa,kBAAkB,EAAE,EACxD,GAAG,CACJ,CAAA;AAED,SAAS,kCAAkC;IACzC,OAAO,IAAA,sBAAY,EACjB,IAAA,gBAAI,EAAC,SAAS,EAAE,OAAO,EAAE,4BAA4B,CAAC,EACtD,OAAO,CACR,CAAA;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAe;IAC5C,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;IACrC,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,GAAG,oBAAoB,KAAK,0BAA0B,KAAK,kBAAkB,EAAE,CAAA;IACxF,CAAC;IAED,OAAO,GAAG,oBAAoB,KAAK,0BAA0B,OAAO,cAAc,OAAO,kBAAkB,EAAE,CAAA;AAC/G,CAAC;AAED,SAAS,WAAW,CAAC,OAAe;IAClC,OAAO,OAAO;SACX,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC;SACjC,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC;SACvC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;SAC/B,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;AACvB,CAAC;AAEM,KAAK,UAAU,UAAU,CAAC,IAAU;IACzC,MAAM,aAAa,GAAG,qBAAqB,CACzC,kCAAkC,EAAE,CACrC,CAAA;IAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAA;QAC3C,OAAO;YACL,gBAAgB,EAAE,qCAAqC;SACxD,CAAA;IACH,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;IAE5D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAA;QAC3C,OAAO;YACL,gBAAgB,EAAE,qCAAqC;SACxD,CAAA;IACH,CAAC;IAED,MAAM,mBAAmB,GAAG,eAAe,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAEtE,IAAI,mBAAmB,EAAE,CAAC;QACxB,IAAI,WAAW,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;YACvE,OAAM;QACR,CAAC;QAED,MAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAC5C,mBAAmB,EACnB,aAAa,CACd,CAAA;QACD,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAA;QAC5C,OAAO;YACL,gBAAgB,EAAE,qCAAqC;SACxD,CAAA;IACH,CAAC;IAED,MAAM,cAAc,GAAG,GAAG,eAAe,OAAO,aAAa,EAAE,CAAA;IAC/D,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAA;IAE5C,OAAO;QACL,gBAAgB,EAAE,qCAAqC;KACxD,CAAA;AACH,CAAC;AAED,kBAAe,UAAU,CAAA"}

package/generators.json

@@ -9,6 +9,11 @@
       "factory": "./dist/src/generators/sync/sync-list-lambda-functions",
       "schema": "./dist/src/generators/sync/schema.json",
       "description": "sync-list-lambda-functions generator"
+    },
+    "sync-agents": {
+      "factory": "./dist/src/generators/sync/sync-agents",
+      "schema": "./dist/src/generators/sync/schema.json",
+      "description": "sync-agents generator"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payfit/nx-core",
-  "version": "5.29.1",
+  "version": "5.29.2",
   "type": "commonjs",
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",