mirror/pnpm
1
0
Fork 0
mirror of https://github.com/pnpm/pnpm.git synced 2026-02-08 22:22:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix: patch should print instructions about how to commit the changes (#5809)

Browse Source 
Co-authored-by: Zoltan Kochan <z@kochan.io>
This commit is contained in:
NullVoxPopuli
2022-12-20 19:59:17 -05:00
committed by GitHub
parent b77651d14d
commit e8aafe393c
3 changed files with 19 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.changeset/bright-apricots-rest.md Normal file
View File

@@ -0,0 +1,6 @@
---
"@pnpm/plugin-commands-patching": patch
"pnpm": patch
---
`pnpm patch` should print instructions about how to commit the changes.

4
packages/plugin-commands-patching/src/patch.ts
View File

@@ -53,5 +53,7 @@ export async function handler (opts: PatchCommandOptions, params: string[]) {
}
const editDir = opts.editDir ?? tempy.directory()
await writePackage(params[0], editDir, opts)
return `You can now edit the following folder: ${editDir}`
return `You can now edit the following folder: ${editDir}
Once you're done with your changes, run "pnpm patch-commit ${editDir}"`
}

15
packages/plugin-commands-patching/test/patch.test.ts
View File

@@ -36,7 +36,7 @@ describe('patch and commit', () => {
test('patch and commit', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = output.substring(output.indexOf(':') + 1).trim()
const patchDir = getPatchDirFromPatchOutput(output)
const tempDir = os.tmpdir() // temp dir depends on the operating system (@see tempy)
// store patch files in a temporary directory when not given editDir option
@@ -71,7 +71,7 @@ describe('patch and commit', () => {
const editDir = path.join(tempy.directory())
const output = await patch.handler({ ...defaultPatchOption, editDir }, ['is-positive@1.0.0'])
const patchDir = output.substring(output.indexOf(':') + 1).trim()
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toBe(editDir)
expect(fs.existsSync(patchDir)).toBe(true)
@@ -98,7 +98,7 @@ describe('patch and commit', () => {
const editDir = path.join(tempy.directory()) + (os.platform() === 'win32' ? '\\' : '/')
const output = await patch.handler({ ...defaultPatchOption, editDir }, ['is-positive@1.0.0'])
const patchDir = output.substring(output.indexOf(':') + 1).trim()
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toBe(editDir)
expect(fs.existsSync(patchDir)).toBe(true)
@@ -141,7 +141,7 @@ describe('patching should work when there is a no EOL in the patched file', () =
})
it('should work when adding content on a newline', async () => {
const output = await patch.handler(defaultPatchOption, ['safe-execa@0.1.2'])
const userPatchDir = output.substring(output.indexOf(':') + 1).trim()
const userPatchDir = getPatchDirFromPatchOutput(output)
const tempDir = os.tmpdir()
expect(userPatchDir).toContain(tempDir)
@@ -167,7 +167,7 @@ describe('patching should work when there is a no EOL in the patched file', () =
})
it('should work fine when new content is appended', async () => {
const output = await patch.handler(defaultPatchOption, ['safe-execa@0.1.2'])
const userPatchDir = output.substring(output.indexOf(':') + 1).trim()
const userPatchDir = getPatchDirFromPatchOutput(output)
const tempDir = os.tmpdir()
expect(userPatchDir).toContain(tempDir)
@@ -190,3 +190,8 @@ describe('patching should work when there is a no EOL in the patched file', () =
expect(fs.readFileSync('node_modules/safe-execa/lib/index.js', 'utf8')).toContain('//# sourceMappingURL=index.js.map// patch without newline')
})
})
function getPatchDirFromPatchOutput (output: string) {
const [firstLine] = output.split('\n')
return firstLine.substring(firstLine.indexOf(':') + 1).trim()
}