feat: add option removePackageKeywords (#5814)

Co-authored-by: Keith Rocheck <749812+krocheck@users.noreply.github.com>
electron-userland · Apr 23, 2021 · dcf570f · dcf570f
1 parent 79c9f6b
commit dcf570f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/packages/app-builder-lib/scheme.json b/packages/app-builder-lib/scheme.json
@@ -6470,6 +6470,11 @@
       "description": "Whether to remove `scripts` field from `package.json` files.",
       "type": "boolean"
     },
+	"removePackageKeywords": {
+	  "default": true,
+	  "description": "Whether to remove `keywords` field from `package.json` files.",
+	  "type": "boolean"
+	},
     "rpm": {
       "anyOf": [
         {

diff --git a/packages/app-builder-lib/src/configuration.ts b/packages/app-builder-lib/src/configuration.ts
@@ -247,6 +247,13 @@ export interface Configuration extends PlatformSpecificBuildOptions {
    * @default true
    */
   readonly removePackageScripts?: boolean
+
+  /**
+   * Whether to remove `keywords` field from `package.json` files.
+   *
+   * @default true
+   */
+  readonly removePackageKeywords?: boolean
 }
 
 export interface AfterPackContext {

diff --git a/packages/app-builder-lib/src/fileTransformer.ts b/packages/app-builder-lib/src/fileTransformer.ts
@@ -28,10 +28,11 @@ export function hasDep(name: string, info: Packager) {
 export function createTransformer(srcDir: string, configuration: Configuration, extraMetadata: any, extraTransformer: FileTransformer | null): FileTransformer {
   const mainPackageJson = path.join(srcDir, "package.json")
   const isRemovePackageScripts = configuration.removePackageScripts !== false
+  const isRemovePackageKeywords = configuration.removePackageKeywords !== false
   const packageJson = path.sep + "package.json"
   return file => {
     if (file === mainPackageJson) {
-      return modifyMainPackageJson(file, extraMetadata, isRemovePackageScripts)
+      return modifyMainPackageJson(file, extraMetadata, isRemovePackageScripts, isRemovePackageKeywords)
     }
 
     if (file.endsWith(packageJson) && file.includes(NODE_MODULES_PATTERN)) {
@@ -40,6 +41,7 @@ export function createTransformer(srcDir: string, configuration: Configuration,
           cleanupPackageJson(JSON.parse(it), {
             isMain: false,
             isRemovePackageScripts,
+            isRemovePackageKeywords
           })
         )
         .catch(e => log.warn(e))
@@ -64,10 +66,11 @@ export function createElectronCompilerHost(projectDir: string, cacheDir: string)
   return require(path.join(electronCompilePath, "config-parser")).createCompilerHostFromProjectRoot(projectDir, cacheDir)
 }
 
-const ignoredPackageMetadataProperties = new Set(["dist", "gitHead", "keywords", "build", "jspm", "ava", "xo", "nyc", "eslintConfig", "contributors", "bundleDependencies", "tags"])
+const ignoredPackageMetadataProperties = new Set(["dist", "gitHead", "build", "jspm", "ava", "xo", "nyc", "eslintConfig", "contributors", "bundleDependencies", "tags"])
 
 interface CleanupPackageFileOptions {
   readonly isRemovePackageScripts: boolean
+  readonly isRemovePackageKeywords: boolean
   readonly isMain: boolean
 }
 
@@ -83,6 +86,7 @@ function cleanupPackageJson(data: any, options: CleanupPackageFileOptions): any
         prop[0] === "_" ||
         ignoredPackageMetadataProperties.has(prop) ||
         (options.isRemovePackageScripts && prop === "scripts") ||
+        (options.isRemovePackageKeywords && prop === "keywords") ||
         (options.isMain && prop === "devDependencies") ||
         (!options.isMain && prop === "bugs") ||
         (isRemoveBabel && prop === "babel")
@@ -102,7 +106,7 @@ function cleanupPackageJson(data: any, options: CleanupPackageFileOptions): any
   return null
 }
 
-async function modifyMainPackageJson(file: string, extraMetadata: any, isRemovePackageScripts: boolean) {
+async function modifyMainPackageJson(file: string, extraMetadata: any, isRemovePackageScripts: boolean, isRemovePackageKeywords: boolean) {
   const mainPackageData = JSON.parse(await readFile(file, "utf-8"))
   if (extraMetadata != null) {
     deepAssign(mainPackageData, extraMetadata)
@@ -112,6 +116,7 @@ async function modifyMainPackageJson(file: string, extraMetadata: any, isRemoveP
   const serializedDataIfChanged = cleanupPackageJson(mainPackageData, {
     isMain: true,
     isRemovePackageScripts,
+    isRemovePackageKeywords
   })
   if (serializedDataIfChanged != null) {
     return serializedDataIfChanged