feat: generate-function accepts keepPackageJson flag [EXT-6292] (#2419)

* feat: generate-function accepts keepPackageJson flag

fix: package.json in correct directory

* fix: Generic GFSettingsInput, [...IGNORED_FILES] -> Array.from(...), other recommended changes

Author: michaelpineirocontentful

packages/contentful--app-scripts/src/bin.ts

@@ -126,6 +126,10 @@ async function runCommand(command: Command, options?: any) {
     .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(generateFunction, options);
     });

packages/contentful--app-scripts/src/generate-function/build-generate-function-settings.ts

@@ -2,7 +2,7 @@ import inquirer from 'inquirer';
 import path from 'node:path';
 import { getGithubFolderNames } from './get-github-folder-names';
 import { ACCEPTED_LANGUAGES, BANNED_FUNCTION_NAMES } from './constants';
-import { GenerateFunctionSettings, Language } from '../types';
+import { GenerateFunctionSettings, GenerateFunctionSettingsCLI, Language } from '../types';
 import ora from 'ora';
 import chalk from 'chalk';
 import { warn } from './logger';
@@ -51,7 +51,7 @@ function validateFunctionName(baseSettings: GenerateFunctionSettings) {
   }
 }
 
-export function validateArguments(options: GenerateFunctionSettings) {
+export function validateArguments(options: GenerateFunctionSettingsCLI) {
   const requiredParams = ['name', 'example', 'language'];
   if (!requiredParams.every((key) => key in options)) {
      throw new ValidationError(chalk.red('You must specify a function name, an example, and a language'));
@@ -66,6 +66,8 @@ export function validateArguments(options: GenerateFunctionSettings) {
 
   // Convert options to lowercase and trim whitespace
   for (const key in options) {
+    if (key === 'keepPackageJson') continue;
+    
     const optionKey = key as keyof GenerateFunctionSettings;
     const value = options[optionKey].toLowerCase().trim();
 
@@ -79,9 +81,9 @@ export function validateArguments(options: GenerateFunctionSettings) {
   }
 }
 
-export async function buildGenerateFunctionSettingsCLI(options: GenerateFunctionSettings) : Promise<GenerateFunctionSettings> {
+export async function buildGenerateFunctionSettingsCLI(options: GenerateFunctionSettingsCLI) : Promise<GenerateFunctionSettingsCLI> {
   const validateSpinner = ora('Validating your input\n').start();
-  const settings: GenerateFunctionSettings = {} as GenerateFunctionSettings;
+  const settings: GenerateFunctionSettingsCLI = {} as GenerateFunctionSettingsCLI;
     try {
       validateArguments(options);
 
@@ -93,6 +95,11 @@ export async function buildGenerateFunctionSettingsCLI(options: GenerateFunction
       settings.language = options.language;
       settings.example = options.example;
       settings.name = options.name;
+      
+      if (options.keepPackageJson !== undefined) {
+        settings.keepPackageJson = options.keepPackageJson;
+      }
+      
       return settings;
     } catch (err: any) {
       console.log(`

packages/contentful--app-scripts/src/generate-function/clone.ts

@@ -8,7 +8,7 @@ import { APP_MANIFEST, CONTENTFUL_APP_MANIFEST, IGNORED_CLONED_FILES, REPO_URL }
 import { error, highlight, warn } from './logger';
 import { exists, mergeJsonIntoFile, whichExists } from './utils/file';
 import { getAddBuildCommandFn } from './utils/package';
-import { GenerateFunctionSettings } from '../types';
+import { GenerateFunctionSettingsInput } from '../types';
 
 const addBuildCommand = getAddBuildCommandFn({
   name: 'build:functions',
@@ -17,20 +17,22 @@ const addBuildCommand = getAddBuildCommandFn({
 
 export async function cloneFunction(
   localPath: string,
-  settings: GenerateFunctionSettings
+  settings: GenerateFunctionSettingsInput
 ) {
   try {
     console.log(highlight(`---- Cloning function ${chalk.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);
@@ -40,11 +42,11 @@ export async function cloneFunction(
   }
 }
 
-export function getCloneURL(settings: GenerateFunctionSettings) {
+export function getCloneURL(settings: GenerateFunctionSettingsInput) {
   return `${REPO_URL}/${settings.example}/${settings.language}`;
 }
 
-export async function touchupAppManifest(localPath: string, settings: GenerateFunctionSettings, renameFunctionFile: string) {
+export async function touchupAppManifest(localPath: string, settings: GenerateFunctionSettingsInput, renameFunctionFile: string) {
   const appManifestPath = resolve(localPath, CONTENTFUL_APP_MANIFEST);
   const appManifest = JSON.parse(fs.readFileSync(appManifestPath, 'utf-8'));
   const entry = appManifest["functions"][appManifest["functions"].length - 1];
@@ -56,12 +58,32 @@ export async function touchupAppManifest(localPath: string, settings: GenerateFu
   await fs.writeFileSync(appManifestPath, JSON.stringify(appManifest, null, 2));
 }
 
-export function moveFilesToFinalDirectory(localTmpPath: string, localFunctionsPath: string) {
-  fs.cpSync(localTmpPath, localFunctionsPath, { recursive: true });
+export function moveFilesToFinalDirectory(localTmpPath: string, localFunctionsPath: string, localPath: string) {
+  // Create functions directory if it doesn't exist
+  if (!fs.existsSync(localFunctionsPath)) {
+    fs.mkdirSync(localFunctionsPath, { recursive: true });
+  }
+
+  // Get all files from tmp directory
+  const files = fs.readdirSync(localTmpPath);
+  
+  // Copy each file except package.json, if it exists
+  for (const file of files) {
+    const sourcePath = resolve(localTmpPath, file);
+    if (file === 'package.json') {
+      const destPath = resolve(localPath, 'package.json');
+      fs.cpSync(sourcePath, destPath);
+      continue;
+    }
+    const destPath = resolve(localFunctionsPath, file);
+    fs.cpSync(sourcePath, destPath, { recursive: true });
+  }
+  
+  // Clean up tmp directory
   fs.rmSync(localTmpPath, { recursive: true, force: true });
 }
 
-export function renameClonedFiles(localTmpPath: string, settings: GenerateFunctionSettings) {
+export function renameClonedFiles(localTmpPath: string, settings: GenerateFunctionSettingsInput) {
   const files = fs.readdirSync(localTmpPath);
   const functionFile: string | undefined = files.find((file: string) => file.endsWith('.ts') || file.endsWith('.js'));
   if (!functionFile) {
@@ -78,17 +100,21 @@ export function resolvePaths(localPath: string) {
   return { localTmpPath, localFunctionsPath };
 }
 
-export async function cloneAndResolveManifests(cloneURL: string, localTmpPath: string, localPath: string, localFunctionsPath: string) {
+export async function cloneAndResolveManifests(cloneURL: string, localTmpPath: string, localPath: string, localFunctionsPath: string, 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(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 = IGNORED_CLONED_FILES
   const tsconfigExists = await exists(resolve(localFunctionsPath, 'tsconfig.json'));
   if (tsconfigExists) {
     ignoredFiles.push('tsconfig.json')
@@ -144,6 +170,6 @@ export async function updatePackageJsonWithBuild(localPath: string, localTmpPath
       mergeFn: addBuildCommand,
     });
   } else {
-    warn("Failed to add function build commands: ${packageJsonLocation} does not exist.");
+    warn(`Failed to add function build commands: ${packageJsonLocation} does not exist.`);
   }
 }

packages/contentful--app-scripts/src/generate-function/constants.ts

@@ -1,7 +1,7 @@
 export const EXAMPLES_PATH = 'contentful/apps/function-examples/';
 export const APP_MANIFEST = 'app-manifest.json';
 export const CONTENTFUL_APP_MANIFEST = 'contentful-app-manifest.json';
-export const IGNORED_CLONED_FILES = [APP_MANIFEST, CONTENTFUL_APP_MANIFEST, `package.json`];
+export const IGNORED_CLONED_FILES = [APP_MANIFEST, CONTENTFUL_APP_MANIFEST];
 export const REPO_URL = 'https://github.com/contentful/apps/function-examples';
 
 export const ACCEPTED_EXAMPLE_FOLDERS = [

packages/contentful--app-scripts/src/generate-function/index.ts

@@ -1,4 +1,4 @@
-import { GenerateFunctionSettings } from "../types";
+import { GenerateFunctionSettings, GenerateFunctionSettingsCLI } from "../types";
 import { buildGenerateFunctionSettingsInteractive, buildGenerateFunctionSettingsCLI } from "./build-generate-function-settings";
 import { create } from "./create-function";
 import { ValidationError } from "./types";
@@ -16,7 +16,7 @@ const interactive = async () => {
   }
 };
 
-const nonInteractive = async (options: GenerateFunctionSettings) => {
+const nonInteractive = async (options: GenerateFunctionSettingsCLI) => {
   try {
     const generateFunctionSettings = await buildGenerateFunctionSettingsCLI(options);
     return create(generateFunctionSettings);

packages/contentful--app-scripts/src/types.ts

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