forked from pnpm/pnpm
/
index.ts
233 lines (168 loc) · 7.8 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/// <reference path="../../../__typings__/index.d.ts"/>
import { promises as fs } from 'fs'
import path from 'path'
import { readProjectManifest, tryReadProjectManifest } from '@pnpm/read-project-manifest'
import tempy from 'tempy'
const fixtures = path.join(__dirname, '../fixtures')
test('readProjectManifest()', async () => {
expect(
(await tryReadProjectManifest(path.join(fixtures, 'package-json'))).manifest
).toStrictEqual(
{ name: 'foo', version: '1.0.0' }
)
expect(
(await tryReadProjectManifest(path.join(fixtures, 'package-json5'))).manifest
).toStrictEqual(
{ name: 'foo', version: '1.0.0' }
)
expect(
(await tryReadProjectManifest(path.join(fixtures, 'package-yaml'))).manifest
).toStrictEqual(
{ name: 'foo', version: '1.0.0' }
)
expect(
(await tryReadProjectManifest(fixtures)).manifest
).toStrictEqual(null)
})
test('preserve tab indentation in json file', async () => {
process.chdir(tempy.directory())
await fs.writeFile('package.json', '{\n\t"name": "foo"\n}\n', 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({ ...manifest, dependencies: { bar: '1.0.0' } })
const rawManifest = await fs.readFile('package.json', 'utf8')
expect(rawManifest).toBe('{\n\t"name": "foo",\n\t"dependencies": {\n\t\t"bar": "1.0.0"\n\t}\n}\n')
})
test('preserve space indentation in json file', async () => {
process.chdir(tempy.directory())
await fs.writeFile('package.json', '{\n "name": "foo"\n}\n', 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({ ...manifest, dependencies: { bar: '1.0.0' } })
const rawManifest = await fs.readFile('package.json', 'utf8')
expect(rawManifest).toBe('{\n "name": "foo",\n "dependencies": {\n "bar": "1.0.0"\n }\n}\n')
})
test('preserve tab indentation in json5 file', async () => {
process.chdir(tempy.directory())
await fs.writeFile('package.json5', "{\n\tname: 'foo',\n}\n", 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({ ...manifest, dependencies: { bar: '1.0.0' } })
const rawManifest = await fs.readFile('package.json5', 'utf8')
expect(rawManifest).toBe("{\n\tname: 'foo',\n\tdependencies: {\n\t\tbar: '1.0.0',\n\t},\n}\n")
})
test('preserve space indentation in json5 file', async () => {
process.chdir(tempy.directory())
await fs.writeFile('package.json5', "{\n name: 'foo'\n}\n", 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({ ...manifest, dependencies: { bar: '1.0.0' } })
const rawManifest = await fs.readFile('package.json5', 'utf8')
expect(rawManifest).toBe("{\n name: 'foo',\n dependencies: {\n bar: '1.0.0',\n },\n}\n")
})
test('preserve comments in json5 file', async () => {
const originalManifest = await fs.readFile(
path.join(fixtures, 'commented-package-json5/package.json5'), 'utf8')
const modifiedManifest = await fs.readFile(
path.join(fixtures, 'commented-package-json5/modified.json5'), 'utf8')
process.chdir(tempy.directory())
await fs.writeFile('package.json5', originalManifest, 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
// Have to make a change to get it to write anything:
const newManifest = Object.assign({}, manifest, { type: 'commonjs' })
await writeProjectManifest(newManifest)
const resultingManifest = await fs.readFile('package.json5', 'utf8')
expect(resultingManifest).toBe(modifiedManifest)
})
/* FIXME
test('preserve comments in YAML file', async () => {
const originalManifest = await fs.readFile(
path.join(fixtures, 'commented-package-yaml/package.yaml'), 'utf8')
const modifiedManifest = await fs.readFile(
path.join(fixtures, 'commented-package-yaml/modified.yaml'), 'utf8')
process.chdir(tempy.directory())
await fs.writeFile('package.yaml', originalManifest, 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
// Have to make a change to get it to write anything:
const newManifest = Object.assign({}, manifest, { type: 'commonjs' })
await writeProjectManifest(newManifest)
const resultingManifest = await fs.readFile('package.yaml', 'utf8')
expect(resultingManifest).toBe(modifiedManifest)
})*/
test('do not save manifest if it had no changes', async () => {
process.chdir(tempy.directory())
await fs.writeFile(
'package.json5',
JSON.stringify({
dependencies: { foo: '*', bar: '*' },
devDependencies: {},
}),
'utf8'
)
const { writeProjectManifest } = await readProjectManifest(process.cwd())
const stat1 = await fs.stat('package.json5')
await writeProjectManifest({
dependencies: { bar: '*', foo: '*' },
peerDependencies: {},
})
const stat2 = await fs.stat('package.json5')
expect(stat1.ino).toBe(stat2.ino)
})
test('fail on invalid JSON', async () => {
let err!: Error & { code: string }
try {
await readProjectManifest(path.join(fixtures, 'invalid-package-json'))
} catch (_err: any) { // eslint-disable-line
err = _err
}
expect(err).toBeTruthy()
expect(err.code).toBe('ERR_PNPM_JSON_PARSE')
const nodeMajorVersion = parseInt(process.version.slice(1).split('.')[0])
const expectedMessage = nodeMajorVersion >= 19
? 'Expected \',\' or \'}\' after property value in JSON at position 20 while parsing \'{ "name": "foo" "version": "1.0.0"}\' in'
: 'Unexpected string in JSON at position 20 while parsing \'{ "name": "foo" "version": "1.0.0"}\' in '
expect(err.message).toContain(expectedMessage)
})
test('fail on invalid JSON5', async () => {
let err!: Error & { code: string }
try {
await readProjectManifest(path.join(fixtures, 'invalid-package-json5'))
} catch (_err: any) { // eslint-disable-line
err = _err
}
expect(err).toBeTruthy()
expect(err.code).toBe('ERR_PNPM_JSON5_PARSE')
expect(err.message).toMatch(/^JSON5: invalid character 'v' at 3:3 in/)
})
test('fail on invalid YAML', async () => {
let err!: Error & { code: string }
try {
await readProjectManifest(path.join(fixtures, 'invalid-package-yaml'))
} catch (_err: any) { // eslint-disable-line
err = _err
}
expect(err).toBeTruthy()
expect(err.code).toBe('ERR_PNPM_YAML_PARSE')
expect(err.message).toMatch(/^missed comma between flow collection entries \(3:3\)/)
})
test('preserve trailing new line at the end of package.json', async () => {
process.chdir(tempy.directory())
await fs.writeFile('package.json', '{}', 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({ ...manifest, dependencies: { bar: '1.0.0' } })
const rawManifest = await fs.readFile('package.json', 'utf8')
expect(rawManifest).toBe('{"dependencies":{"bar":"1.0.0"}}')
})
test('preserve trailing new line at the end of package.json5', async () => {
process.chdir(tempy.directory())
await fs.writeFile('package.json5', '{}', 'utf8')
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({ ...manifest, dependencies: { bar: '1.0.0' } })
const rawManifest = await fs.readFile('package.json5', 'utf8')
expect(rawManifest).toBe("{dependencies:{bar:'1.0.0'}}")
})
test('canceling changes to a manifest', async () => {
process.chdir(tempy.directory())
await fs.writeFile('package.json', JSON.stringify({ name: 'foo' }), 'utf8')
const { writeProjectManifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({ name: 'bar' })
expect(await fs.readFile('package.json', 'utf8')).toBe(JSON.stringify({ name: 'bar' }))
await writeProjectManifest({ name: 'foo' })
expect(await fs.readFile('package.json', 'utf8')).toBe(JSON.stringify({ name: 'foo' }))
})