@contentful/app-scripts 2.3.1 → 2.4.0

package/lib/bin.js

@@ -89,6 +89,7 @@ async function runCommand(command, options) {
         .option('-n, --name <name>', 'Name of the function')
         .option('-e, --example <example>', 'Name of the reference example')
         .option('-l, --language <language>', 'Select a language for the function')
+        .option('--keep-package-json', 'The package.json file will create or overwrite the existing package.json file in the main directory')
         .action(async (options) => {
         await runCommand(index_1.generateFunction, options);
     });

package/lib/generate-function/build-generate-function-settings.d.ts

@@ -1,4 +1,4 @@
-import { GenerateFunctionSettings } from '../types';
+import { GenerateFunctionSettings, GenerateFunctionSettingsCLI } from '../types';
 export declare function buildGenerateFunctionSettingsInteractive(): Promise<GenerateFunctionSettings>;
-export declare function validateArguments(options: GenerateFunctionSettings): void;
-export declare function buildGenerateFunctionSettingsCLI(options: GenerateFunctionSettings): Promise<GenerateFunctionSettings>;
+export declare function validateArguments(options: GenerateFunctionSettingsCLI): void;
+export declare function buildGenerateFunctionSettingsCLI(options: GenerateFunctionSettingsCLI): Promise<GenerateFunctionSettingsCLI>;

package/lib/generate-function/build-generate-function-settings.js

@@ -66,6 +66,8 @@ function validateArguments(options) {
     }
     // Convert options to lowercase and trim whitespace
     for (const key in options) {
+        if (key === 'keepPackageJson')
+            continue;
         const optionKey = key;
         const value = options[optionKey].toLowerCase().trim();
         if (optionKey === 'language') {
@@ -92,6 +94,9 @@ async function buildGenerateFunctionSettingsCLI(options) {
         settings.language = options.language;
         settings.example = options.example;
         settings.name = options.name;
+        if (options.keepPackageJson !== undefined) {
+            settings.keepPackageJson = options.keepPackageJson;
+        }
         return settings;
     }
     catch (err) {

package/lib/generate-function/clone.d.ts

@@ -1,14 +1,14 @@
-import { GenerateFunctionSettings } from '../types';
-export declare function cloneFunction(localPath: string, settings: GenerateFunctionSettings): Promise<void>;
-export declare function getCloneURL(settings: GenerateFunctionSettings): string;
-export declare function touchupAppManifest(localPath: string, settings: GenerateFunctionSettings, renameFunctionFile: string): Promise<void>;
-export declare function moveFilesToFinalDirectory(localTmpPath: string, localFunctionsPath: string): void;
-export declare function renameClonedFiles(localTmpPath: string, settings: GenerateFunctionSettings): string;
+import { GenerateFunctionSettingsInput } from '../types';
+export declare function cloneFunction(localPath: string, settings: GenerateFunctionSettingsInput): Promise<void>;
+export declare function getCloneURL(settings: GenerateFunctionSettingsInput): string;
+export declare function touchupAppManifest(localPath: string, settings: GenerateFunctionSettingsInput, renameFunctionFile: string): Promise<void>;
+export declare function moveFilesToFinalDirectory(localTmpPath: string, localFunctionsPath: string, localPath: string): void;
+export declare function renameClonedFiles(localTmpPath: string, settings: GenerateFunctionSettingsInput): string;
 export declare function resolvePaths(localPath: string): {
     localTmpPath: string;
     localFunctionsPath: string;
 };
-export declare function cloneAndResolveManifests(cloneURL: string, localTmpPath: string, localPath: string, localFunctionsPath: string): Promise<void>;
+export declare function cloneAndResolveManifests(cloneURL: string, localTmpPath: string, localPath: string, localFunctionsPath: string, keepPackageJson?: boolean): Promise<void>;
 export declare function clone(cloneURL: string, localFunctionsPath: string): Promise<any>;
 export declare function mergeAppManifest(localPath: string, localTmpPath: string): Promise<void>;
 export declare function updatePackageJsonWithBuild(localPath: string, localTmpPath: string): Promise<void>;

package/lib/generate-function/clone.js

@@ -31,11 +31,13 @@ async function cloneFunction(localPath, settings) {
         console.log((0, logger_1.highlight)(`---- Cloning function ${chalk_1.default.cyan(settings.name)}...`));
         const { localTmpPath, localFunctionsPath } = resolvePaths(localPath);
         const cloneURL = getCloneURL(settings);
-        await cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath);
+        // Pass keepPackageJson if available in settings (from GenerateFunctionSettingsCLI)
+        const keepPackageJson = 'keepPackageJson' in settings && typeof settings.keepPackageJson === 'boolean' ? settings.keepPackageJson : false;
+        await cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath, keepPackageJson);
         // now rename the function file. Find the file with a .ts or .js extension
         const renameFunctionFile = renameClonedFiles(localTmpPath, settings);
         // copy the cloned files to the functions directory
-        moveFilesToFinalDirectory(localTmpPath, localFunctionsPath);
+        moveFilesToFinalDirectory(localTmpPath, localFunctionsPath, localPath);
         // now alter the app-manifest.json to point to the new function file
         await touchupAppManifest(localPath, settings, renameFunctionFile);
     }
@@ -58,8 +60,25 @@ async function touchupAppManifest(localPath, settings, renameFunctionFile) {
     entry.entryFile = `functions/${renameFunctionFile}`;
     await node_fs_1.default.writeFileSync(appManifestPath, JSON.stringify(appManifest, null, 2));
 }
-function moveFilesToFinalDirectory(localTmpPath, localFunctionsPath) {
-    node_fs_1.default.cpSync(localTmpPath, localFunctionsPath, { recursive: true });
+function moveFilesToFinalDirectory(localTmpPath, localFunctionsPath, localPath) {
+    // Create functions directory if it doesn't exist
+    if (!node_fs_1.default.existsSync(localFunctionsPath)) {
+        node_fs_1.default.mkdirSync(localFunctionsPath, { recursive: true });
+    }
+    // Get all files from tmp directory
+    const files = node_fs_1.default.readdirSync(localTmpPath);
+    // Copy each file except package.json, if it exists
+    for (const file of files) {
+        const sourcePath = (0, node_path_1.resolve)(localTmpPath, file);
+        if (file === 'package.json') {
+            const destPath = (0, node_path_1.resolve)(localPath, 'package.json');
+            node_fs_1.default.cpSync(sourcePath, destPath);
+            continue;
+        }
+        const destPath = (0, node_path_1.resolve)(localFunctionsPath, file);
+        node_fs_1.default.cpSync(sourcePath, destPath, { recursive: true });
+    }
+    // Clean up tmp directory
     node_fs_1.default.rmSync(localTmpPath, { recursive: true, force: true });
 }
 function renameClonedFiles(localTmpPath, settings) {
@@ -77,14 +96,18 @@ function resolvePaths(localPath) {
     const localFunctionsPath = (0, node_path_1.resolve)(localPath, 'functions');
     return { localTmpPath, localFunctionsPath };
 }
-async function cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath) {
+async function cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath, keepPackageJson = false) {
     const tigedInstance = await clone(cloneURL, localTmpPath);
     // merge the manifest from the template folder to the root folder
     await mergeAppManifest(localPath, localTmpPath);
-    // modify package.json build commands
-    await updatePackageJsonWithBuild(localPath, localTmpPath);
+    // create a deep copy of the IGNORED_CLONED_FILES array
+    const ignoredFiles = Array.from(constants_1.IGNORED_CLONED_FILES);
+    if (!keepPackageJson) {
+        // modify package.json build commands
+        await updatePackageJsonWithBuild(localPath, localTmpPath);
+        ignoredFiles.push('package.json');
+    }
     // check if a tsconfig.json file exists already
-    const ignoredFiles = constants_1.IGNORED_CLONED_FILES;
     const tsconfigExists = await (0, file_1.exists)((0, node_path_1.resolve)(localFunctionsPath, 'tsconfig.json'));
     if (tsconfigExists) {
         ignoredFiles.push('tsconfig.json');
@@ -137,6 +160,6 @@ async function updatePackageJsonWithBuild(localPath, localTmpPath) {
         });
     }
     else {
-        (0, logger_1.warn)("Failed to add function build commands: ${packageJsonLocation} does not exist.");
+        (0, logger_1.warn)(`Failed to add function build commands: ${packageJsonLocation} does not exist.`);
     }
 }

package/lib/generate-function/constants.js

@@ -4,7 +4,7 @@ exports.BANNED_FUNCTION_NAMES = exports.CONTENTFUL_FUNCTIONS_EXAMPLE_REPO_PATH =
 exports.EXAMPLES_PATH = 'contentful/apps/function-examples/';
 exports.APP_MANIFEST = 'app-manifest.json';
 exports.CONTENTFUL_APP_MANIFEST = 'contentful-app-manifest.json';
-exports.IGNORED_CLONED_FILES = [exports.APP_MANIFEST, exports.CONTENTFUL_APP_MANIFEST, `package.json`];
+exports.IGNORED_CLONED_FILES = [exports.APP_MANIFEST, exports.CONTENTFUL_APP_MANIFEST];
 exports.REPO_URL = 'https://github.com/contentful/apps/function-examples';
 exports.ACCEPTED_EXAMPLE_FOLDERS = [
     'appevent-handler',

package/lib/generate-function/index.d.ts

@@ -1,5 +1,5 @@
-import { GenerateFunctionSettings } from "../types";
+import { GenerateFunctionSettingsCLI } from "../types";
 export declare const generateFunction: {
     interactive: () => Promise<void>;
-    nonInteractive: (options: GenerateFunctionSettings) => Promise<void>;
+    nonInteractive: (options: GenerateFunctionSettingsCLI) => Promise<void>;
 };

package/lib/types.d.ts

@@ -78,6 +78,10 @@ export interface GenerateFunctionSettings {
     example: string;
     language: Language;
 }
+export interface GenerateFunctionSettingsCLI extends GenerateFunctionSettings {
+    keepPackageJson?: boolean;
+}
+export type GenerateFunctionSettingsInput = GenerateFunctionSettings | GenerateFunctionSettingsCLI;
 export interface AddLocationsOptions {
     organizationId?: string;
     definitionId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -67,7 +67,7 @@
     "tiged": "^2.12.7",
     "zod": "^3.24.1"
   },
-  "gitHead": "5569e704260c531e9e33ced31ad5d4820f867b1a",
+  "gitHead": "571371b92e6f7a3542d76192a15f002771708a86",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",