fix(helpers): make deep props optional

Author: zardoy

src/index.ts

@@ -1,6 +1,6 @@
 import fs from 'graceful-fs'
 import { join } from 'path'
-import { PackageJson, TsConfigJson } from 'type-fest'
+import { PackageJson, PartialDeep, TsConfigJson } from 'type-fest'
 import { JsonRoot, loadJsonFile } from './loadJsonFile'
 
 type MaybePromise<T> = T | Promise<T>
@@ -128,22 +128,18 @@ export const modifyJsonFile: ModifyJsonFileGenericFunction = async (path, modify
 
 // todo: use read-pkg / write-pkg for normalization
 
-type TEST = 'HAYA'
-
-/** Use {@linkcode TEST instead}  */
-const d = 5
-
 /**
  * Almost the same is sindresorhus/write-pkg, but with proper typing support and setters for properties
  */
-export const modifyPackageJsonFile: ModifyJsonFileFunction<PackageJson, true> = (path, modify, options = {}) => {
+// TODO remove workaround once my pr is merged
+export const modifyPackageJsonFile: ModifyJsonFileFunction<PartialDeep<PackageJson>, true> = (path, modify, options = {}) => {
     if (typeof path === 'object') {
         path = join(path.dir, 'package.json')
     }
     return modifyJsonFile(path, modify, { removeJsonc: true, ...options })
 }
 
-export const modifyTsConfigJsonFile: ModifyJsonFileFunction<TsConfigJson, true> = (path, modify, options = {}) => {
+export const modifyTsConfigJsonFile: ModifyJsonFileFunction<PartialDeep<TsConfigJson>, true> = (path, modify, options = {}) => {
     if (typeof path === 'object') {
         path = join(path.dir, 'tsconfig.json')
     }

test-d/index.test-d.ts

@@ -2,6 +2,7 @@ import { expectType } from 'tsd'
 
 // TODO-high map to build/ only on script run somehow
 import { modifyJsonFile, modifyPackageJsonFile } from 'modify-json-file'
+import { PackageJson, PartialDeep } from 'type-fest';
 
 modifyJsonFile('path.json', {
     value: 5,
@@ -23,7 +24,7 @@ modifyJsonFile<number>('path.json', n => {
     return n + 5
 })
 
-modifyPackageJsonFile('someDirWithPackageJson', {
+modifyPackageJsonFile('', {
     name: name => `@supertf/${name}`,
     dependencies: {
         string: 'string',
@@ -34,6 +35,18 @@ modifyPackageJsonFile('someDirWithPackageJson', {
     },
     files: undefined,
     // removing react-scripts from devDependencies
-    // TODO
-    // devDependencies: deps => ({ ...deps, 'react-script': undefined }),
+    devDependencies: deps => ({ ...deps, 'react-script': undefined }),
 })
+
+const b: PartialDeep<PackageJson> = {
+    // typesVersions: {
+    //     ">=4": {
+    //         "*": undefined
+    //     }
+    // }
+    scripts: {
+        install: undefined
+    }
+}
+
+modifyPackageJsonFile({ dir: '.' }, old => ({ files: undefined }))