Skip to content
Source
Sign inSign up
TanStack/cli
Open History to see the last commit

ignored-npmrc.test.ts

100 lines3.7 KB

1import { afterEach, describe, expect, it, vi } from 'vitest'
2import { mkdtemp, readFile, rm, writeFile, access } from 'node:fs/promises'
3import { tmpdir } from 'node:os'
4import { join } from 'node:path'
5​
6import { createDefaultEnvironment } from '../src/environment.js'
7import { writeFiles } from '../src/add-to-app.js'
8import { mergePnpmWorkspace } from '../src/pnpm-workspace.js'
9​
10let directory: string | undefined
11​
12async function fixture(npmrc: string) {
13 directory = await mkdtemp(join(tmpdir(), 'tanstack-ignored-config-'))
14 const pkg = JSON.stringify({
15 name: 'fixture',
16 pnpm: { onlyBuiltDependencies: ['esbuild'] },
17 })
18 await writeFile(join(directory, 'package.json'), pkg)
19 await writeFile(join(directory, '.gitignore'), '.npmrc\nnotes.txt\n')
20 await writeFile(join(directory, '.npmrc'), npmrc)
21 const environment = createDefaultEnvironment()
22 const confirm = vi.fn(async () => false)
23 environment.confirm = confirm
24 const output = {
25 files: {
26 [join(directory, 'package.json')]: pkg,
27 [join(directory, 'pnpm-workspace.yaml')]: await mergePnpmWorkspace(
28 undefined,
29 ['esbuild'],
30 ),
31 },
32 deletedFiles: [],
33 }
34 return { cwd: directory, environment, confirm, output }
36​
37afterEach(async () => {
38 if (directory) await rm(directory, { recursive: true, force: true })
39 directory = undefined
40})
41​
42describe('ignored existing add-on targets', () => {
43 const original =
44 '# fixture only\nregistry=https://registry.example.invalid/\n//registry.example.invalid/:_authToken=fake-test-value\n'
45​
46 it('preserves ignored registry settings when adding standalone pnpm settings', async () => {
47 const { cwd, environment, output } = await fixture(original)
48 await writeFiles(environment, cwd, output, true)
49 expect(await readFile(join(cwd, '.npmrc'), 'utf8')).toBe(
50 'ignore-workspace-root-check=true\n' + original,
51 )
52 })
53​
54 it('asks before changing an ignored npmrc and leaves all files alone on cancellation', async () => {
55 const { cwd, environment, output, confirm } = await fixture(original)
56 await expect(writeFiles(environment, cwd, output, false)).rejects.toThrow(
57 'User cancelled',
58 )
59 expect(confirm).toHaveBeenCalledOnce()
60 expect(await readFile(join(cwd, '.npmrc'), 'utf8')).toBe(original)
61 await expect(access(join(cwd, 'pnpm-workspace.yaml'))).rejects.toThrow()
62 })
63​
64 it('retains an ignored explicit root-check choice without an unnecessary prompt', async () => {
65 const explicit = 'ignore-workspace-root-check=false\n' + original
66 const { cwd, environment, output, confirm } = await fixture(explicit)
67 await writeFiles(environment, cwd, output, false)
68 expect(await readFile(join(cwd, '.npmrc'), 'utf8')).toBe(explicit)
69 expect(confirm).not.toHaveBeenCalled()
70 })
71​
72 it('recognizes an existing empty ignored npmrc as an overwrite', async () => {
73 const { cwd, environment, output, confirm } = await fixture('')
74 await expect(writeFiles(environment, cwd, output, false)).rejects.toThrow(
75 'User cancelled',
76 )
77 expect(confirm).toHaveBeenCalledOnce()
78 expect(await readFile(join(cwd, '.npmrc'), 'utf8')).toBe('')
79 })
80​
81 it('also protects other ignored output targets from silent overwrites', async () => {
82 const { cwd, environment, confirm } = await fixture(original)
83 await writeFile(join(cwd, 'notes.txt'), 'keep this private fixture text')
84 await expect(
85 writeFiles(
86 environment,
87 cwd,
88 {
89 files: { [join(cwd, 'notes.txt')]: 'replacement' },
90 deletedFiles: [],
91 },
92 false,
93 ),
94 ).rejects.toThrow('User cancelled')
95 expect(confirm).toHaveBeenCalledOnce()
96 expect(await readFile(join(cwd, 'notes.txt'), 'utf8')).toBe(
97 'keep this private fixture text',
98 )
99 })
100})