Refactor shared logic for generating package.json scripts for FF and …

…FE (#2386) * refactoring shared logic for adding package json scriots for FF and FE * add changeset * add docs * pnpm recursive install * revert translations mockOnlyWarning * fix sonar issues * resolving conflictas after merge * revise export of function * change name to getPackageScripts * fix test name * test fix * add lint ignore escape chars * add lint ignore escape chars * es lint * add a comment explaining not to remove escape chars from command --------- Co-authored-by: Austin Devine <[email protected]>
SAP · Oct 11, 2024 · 26d9fb8 · 26d9fb8
1 parent 7ef7727
commit 26d9fb8
Show file tree

Hide file tree

Showing 18 changed files with 325 additions and 296 deletions.
diff --git a/.changeset/eighty-ways-approve.md b/.changeset/eighty-ways-approve.md
@@ -0,0 +1,7 @@
+---
+'@sap-ux/fiori-freestyle-writer': minor
+'@sap-ux/fiori-generator-shared': minor
+'@sap-ux/fiori-elements-writer': minor
+---
+
+Refactor shared logic for generating package.json scripts for FF and FE
diff --git a/packages/fiori-elements-writer/src/index.ts b/packages/fiori-elements-writer/src/index.ts
@@ -5,7 +5,6 @@ import type { App, Package } from '@sap-ux/ui5-application-writer';
 import { generate as generateUi5Project } from '@sap-ux/ui5-application-writer';
 import { generate as addOdataService, OdataVersion, ServiceType } from '@sap-ux/odata-service-writer';
 import { generateOPAFiles } from '@sap-ux/ui5-test-writer';
-import { getPackageJsonTasks } from './packageConfig';
 import cloneDeep from 'lodash/cloneDeep';
 import type { FioriElementsApp } from './types';
 import { TemplateType } from './types';
@@ -20,7 +19,7 @@ import {
 import { extendManifestJson } from './data/manifestSettings';
 import semVer from 'semver';
 import { initI18n } from './i18n';
-import { getBootstrapResourceUrls } from '@sap-ux/fiori-generator-shared';
+import { getBootstrapResourceUrls, getPackageScripts } from '@sap-ux/fiori-generator-shared';
 import { generateFpmConfig } from './fpmConfig';
 
 export const V2_FE_TYPES_AVAILABLE = '1.108.0';
@@ -177,7 +176,7 @@ async function generate<T extends {}>(basePath: string, data: FioriElementsApp<T
     if (isEdmxProjectType) {
         // Add scripts to package.json only for non-CAP projects
         packageJson.scripts = Object.assign(packageJson.scripts ?? {}, {
-            ...getPackageJsonTasks({
+            ...getPackageScripts({
                 localOnly: !feApp.service?.url,
                 addMock: !!feApp.service?.metadata,
                 addTest,

diff --git a/packages/fiori-elements-writer/src/packageConfig.ts b/packages/fiori-elements-writer/src/packageConfig.ts
diff --git a/packages/fiori-elements-writer/src/types.ts b/packages/fiori-elements-writer/src/types.ts
@@ -116,15 +116,3 @@ export interface FioriElementsApp<T> extends Ui5App {
 
 // We need this for the service version
 export { OdataVersion } from '@sap-ux/odata-service-writer';
-
-/**
-Represents a set of scripts defined in a package.json file.
- */
-export interface PackageJsonScripts {
-    start: string;
-    'start-local': string;
-    'start-noflp'?: string;
-    'start-mock'?: string;
-    'int-test'?: string;
-    'start-variants-management'?: string;
-}
diff --git a/packages/fiori-freestyle-writer/src/index.ts b/packages/fiori-freestyle-writer/src/index.ts
@@ -4,14 +4,13 @@ import { render } from 'ejs';
 import type { Package } from '@sap-ux/ui5-application-writer';
 import { generate as generateUi5Project } from '@sap-ux/ui5-application-writer';
 import { generate as addOdataService } from '@sap-ux/odata-service-writer';
-import { getPackageJsonTasks } from './packageConfig';
 import cloneDeep from 'lodash/cloneDeep';
 import type { BasicAppSettings } from './types';
 import { FreestyleApp, TemplateType } from './types';
 import { setDefaults, escapeFLPText } from './defaults';
 import { UI5Config } from '@sap-ux/ui5-config';
 import { initI18n } from './i18n';
-import { getBootstrapResourceUrls } from '@sap-ux/fiori-generator-shared';
+import { getBootstrapResourceUrls, getPackageScripts } from '@sap-ux/fiori-generator-shared';
 
 /**
  * Generate a UI5 application based on the specified Fiori Freestyle floorplan template.
@@ -98,7 +97,7 @@ async function generate<T>(basePath: string, data: FreestyleApp<T>, fs?: Editor)
         // Add scripts for non-CAP applications
         packageJson.scripts = {
             ...packageJson.scripts,
-            ...getPackageJsonTasks({
+            ...getPackageScripts({
                 localOnly: !!ffApp.service && !ffApp.service?.url,
                 addMock: !!ffApp.service?.metadata,
                 sapClient: ffApp.service?.client,

diff --git a/packages/fiori-freestyle-writer/src/packageConfig.ts b/packages/fiori-freestyle-writer/src/packageConfig.ts
diff --git a/packages/fiori-freestyle-writer/src/types.ts b/packages/fiori-freestyle-writer/src/types.ts
@@ -42,14 +42,3 @@ export interface FreestyleApp<T> extends Ui5App {
 
 // We need this for the service version
 export { OdataVersion } from '@sap-ux/odata-service-writer';
-
-/**
-Represents a set of scripts defined in a package.json file.
- */
-export interface PackageJsonScripts {
-    start: string;
-    'start-local': string;
-    'start-noflp'?: string;
-    'start-mock'?: string;
-    'start-variants-management'?: string;
-}
diff --git a/packages/fiori-freestyle-writer/test/packageConfig.test.ts b/packages/fiori-freestyle-writer/test/packageConfig.test.ts
diff --git a/packages/fiori-generator-shared/package.json b/packages/fiori-generator-shared/package.json
@@ -30,6 +30,7 @@
     "dependencies": {
         "@sap-ux/btp-utils": "workspace:*",
         "@sap-ux/project-access": "workspace:*",
+        "i18next": "20.6.1",
         "mem-fs": "2.1.0",
         "mem-fs-editor": "9.4.0"
     },