Skip to content

Commit f9adcb5

Browse files
jtoarTobbe
authored andcommitted
chore(cli): make fs modules used in the CLI consistent (#9746)
I was sizing up the CLI code as part of ESM work. Since I was looking at it wholesale, @Josh-Walker-GM and I were exchanging notes on what we'd like to improve about it. While a lot of what we talked about was out of scope, there were a few things that are low hanging fruit, one of which is this one, which amounted to a simple search and replace. We just figured if we're using `fs-extra` half the time in the CLI, we may as well use it everywhere to remove the overhead of why it'd be different in one place vs another.
1 parent a1d5e8f commit f9adcb5

File tree

74 files changed

+90
-79
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+90
-79
lines changed

packages/cli/src/__tests__/fs.test.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
jest.mock('fs')
22

3-
import fs from 'fs'
43
import path from 'path'
54

5+
import fs from 'fs-extra'
6+
67
const INITIAL_FS = {
78
file_a: 'content_a',
89
[path.join('fake_dir', 'mock_dir', 'made_up_file')]: 'made_up_content',

packages/cli/src/__tests__/plugin.test.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
import fs from 'fs'
2-
1+
import fs from 'fs-extra'
32
import yargs from 'yargs'
43
import { hideBin } from 'yargs/helpers'
54

packages/cli/src/commands/buildHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import execa from 'execa'
4+
import fs from 'fs-extra'
55
import { Listr } from 'listr2'
66
import { rimraf } from 'rimraf'
77
import terminalLink from 'terminal-link'

packages/cli/src/commands/consoleHandler.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
import fs from 'fs'
21
import path from 'path'
32
import repl from 'repl'
43

4+
import fs from 'fs-extra'
5+
56
import { registerApiSideBabelHook } from '@redwoodjs/babel-config'
67
import { recordTelemetryAttributes } from '@redwoodjs/cli-helpers'
78

packages/cli/src/commands/deploy/__tests__/nftPack.test.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
4+
45
import { buildApi } from '@redwoodjs/internal/dist/build/api'
56
import { findApiDistFunctions } from '@redwoodjs/internal/dist/files'
67

packages/cli/src/commands/deploy/baremetal.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import toml from '@iarna/toml'
54
import boxen from 'boxen'
5+
import fs from 'fs-extra'
66
import { Listr } from 'listr2'
77
import { env as envInterpolation } from 'string-env-interpolation'
88
import terminalLink from 'terminal-link'

packages/cli/src/commands/deploy/serverless.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import boxen from 'boxen'
54
import chalk from 'chalk'
65
import { config } from 'dotenv-defaults'
76
import execa from 'execa'
7+
import fs from 'fs-extra'
88
import { Listr } from 'listr2'
99
import prompts from 'prompts'
1010
import terminalLink from 'terminal-link'

packages/cli/src/commands/destroy/cell/__tests__/cell.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jest.mock('@redwoodjs/structure', () => {
1616
}
1717
})
1818

19-
import fs from 'fs'
19+
import fs from 'fs-extra'
2020

2121
import '../../../../lib/test'
2222

packages/cli/src/commands/destroy/component/__tests__/component.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jest.mock('../../../../lib', () => {
77
}
88
})
99

10-
import fs from 'fs'
10+
import fs from 'fs-extra'
1111

1212
import '../../../../lib/test'
1313

packages/cli/src/commands/destroy/directive/__tests__/directive.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jest.mock('../../../../lib', () => {
88
}
99
})
1010

11-
import fs from 'fs'
11+
import fs from 'fs-extra'
1212

1313
import '../../../../lib/test'
1414

packages/cli/src/commands/destroy/function/__tests__/function.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jest.mock('../../../../lib', () => {
77
}
88
})
99

10-
import fs from 'fs'
10+
import fs from 'fs-extra'
1111

1212
import '../../../../lib/test'
1313

packages/cli/src/commands/destroy/layout/__tests__/layout.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jest.mock('../../../../lib', () => {
77
}
88
})
99

10-
import fs from 'fs'
10+
import fs from 'fs-extra'
1111

1212
import '../../../../lib/test'
1313

packages/cli/src/commands/destroy/page/__tests__/page.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jest.mock('../../../../lib', () => {
77
}
88
})
99

10-
import fs from 'fs'
10+
import fs from 'fs-extra'
1111

1212
import '../../../../lib/test'
1313

packages/cli/src/commands/destroy/scaffold/__tests__/scaffold.test.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
globalThis.__dirname = __dirname
22

3-
import fs from 'fs'
43
import path from 'path'
54

5+
import fs from 'fs-extra'
6+
67
import '../../../../lib/test'
78

89
import { getPaths, getDefaultArgs } from '../../../../lib'

packages/cli/src/commands/destroy/scaffold/__tests__/scaffoldNoNest.test.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
globalThis.__dirname = __dirname
22

3-
import fs from 'fs'
43
import path from 'path'
54

5+
import fs from 'fs-extra'
6+
67
import '../../../../lib/test'
78

89
import { getPaths, getDefaultArgs } from '../../../../lib'

packages/cli/src/commands/destroy/sdl/__tests__/sdl.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
globalThis.__dirname = __dirname
22

3-
import fs from 'fs'
3+
import fs from 'fs-extra'
44

55
import '../../../../lib/test'
66

packages/cli/src/commands/destroy/service/__tests__/service.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
globalThis.__dirname = __dirname
2-
import fs from 'fs'
2+
import fs from 'fs-extra'
33

44
import '../../../../lib/test'
55

packages/cli/src/commands/devHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import fs from 'fs'
21
import { argv } from 'process'
32

43
import concurrently from 'concurrently'
4+
import fs from 'fs-extra'
55

66
import { recordTelemetryAttributes } from '@redwoodjs/cli-helpers'
77
import { shutdownPort } from '@redwoodjs/internal/dist/dev'

packages/cli/src/commands/experimental/setupOpentelemetryHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import execa from 'execa'
4+
import fs from 'fs-extra'
55
import { Listr } from 'listr2'
66

77
import { addApiPackages } from '@redwoodjs/cli-helpers'

packages/cli/src/commands/experimental/setupRealtimeHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
44
import { Listr } from 'listr2'
55

66
import { addApiPackages } from '@redwoodjs/cli-helpers'

packages/cli/src/commands/experimental/setupSentryHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
44
import { Listr } from 'listr2'
55

66
import {

packages/cli/src/commands/experimental/setupServerFileHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
44
import { Listr } from 'listr2'
55

66
import { addApiPackages } from '@redwoodjs/cli-helpers'

packages/cli/src/commands/experimental/studioHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import fs from 'fs'
1+
import fs from 'fs-extra'
22

33
import { getConfigPath } from '@redwoodjs/project-config'
44

packages/cli/src/commands/experimental/util.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import chalk from 'chalk'
4+
import fs from 'fs-extra'
55
import terminalLink from 'terminal-link'
66

77
import { getPaths } from '../../lib'

packages/cli/src/commands/generate/__tests__/helpers.test.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
4+
45
// Setup test mocks
56
globalThis.__dirname = __dirname
67
import '../../../lib/test'

packages/cli/src/commands/generate/dataMigration/dataMigration.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
44
import { Listr } from 'listr2'
55
import { paramCase } from 'param-case'
66
import terminalLink from 'terminal-link'

packages/cli/src/commands/generate/dbAuth/__tests__/dbAuth.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ global.__dirname = __dirname
22

33
jest.mock('fs')
44

5-
import fs from 'fs'
65
import path from 'path'
76

87
// Load mocks
98
import '../../../../lib/test'
109

1110
const realfs = jest.requireActual('fs')
1211
import Enquirer from 'enquirer'
12+
import fs from 'fs-extra'
1313

1414
import { getPaths } from '../../../../lib'
1515
import * as dbAuth from '../dbAuth'

packages/cli/src/commands/generate/dbAuth/dbAuth.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import { camelCase } from 'camel-case'
54
import Enquirer from 'enquirer'
5+
import fs from 'fs-extra'
66
import { Listr } from 'listr2'
77
import terminalLink from 'terminal-link'
88
import { titleCase } from 'title-case'

packages/cli/src/commands/generate/helpers.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
44
import { Listr } from 'listr2'
55
import { paramCase } from 'param-case'
66
import pascalcase from 'pascalcase'

packages/cli/src/commands/generate/page/__tests__/page.test.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ jest.mock('fs', () => {
3636
}
3737
})
3838

39-
import fs from 'fs'
4039
import path from 'path'
4140

41+
import fs from 'fs-extra'
42+
4243
// Load mocks
4344
import '../../../../lib/test'
4445

packages/cli/src/commands/generate/scaffold/__tests__/shouldUseTailwindCSS.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
globalThis.__dirname = __dirname
22

3-
import fs from 'fs'
3+
import fs from 'fs-extra'
44

55
import '../../../../lib/test'
66
import { shouldUseTailwindCSS } from '../scaffold'

packages/cli/src/commands/generate/scaffold/scaffold.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import camelcase from 'camelcase'
54
import execa from 'execa'
5+
import fs from 'fs-extra'
66
import humanize from 'humanize-string'
77
import { Listr } from 'listr2'
88
import { paramCase } from 'param-case'

packages/cli/src/commands/generate/script/script.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
44
import { Listr } from 'listr2'
55
import terminalLink from 'terminal-link'
66

packages/cli/src/commands/generate/sdl/__tests__/sdl.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ jest.mock('fs', () => {
2424
}
2525
})
2626

27-
import fs from 'fs'
2827
import path from 'path'
2928

29+
import fs from 'fs-extra'
3030
import prompts from 'prompts'
3131

3232
// Load mocks

packages/cli/src/commands/lint.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
import fs from 'fs'
2-
31
import execa from 'execa'
2+
import fs from 'fs-extra'
43
import terminalLink from 'terminal-link'
54

65
import { recordTelemetryAttributes } from '@redwoodjs/cli-helpers'

packages/cli/src/commands/prerenderHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs'
21
import path from 'path'
32

3+
import fs from 'fs-extra'
44
import { Listr } from 'listr2'
55

66
import { recordTelemetryAttributes } from '@redwoodjs/cli-helpers'

packages/cli/src/commands/prismaHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import boxen from 'boxen'
54
import execa from 'execa'
5+
import fs from 'fs-extra'
66

77
import { recordTelemetryAttributes } from '@redwoodjs/cli-helpers'
88
import { errorTelemetry } from '@redwoodjs/telemetry'

packages/cli/src/commands/serve.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import chalk from 'chalk'
54
import execa from 'execa'
5+
import fs from 'fs-extra'
66
import terminalLink from 'terminal-link'
77

88
import { recordTelemetryAttributes } from '@redwoodjs/cli-helpers'

packages/cli/src/commands/setup/cache/cacheHandler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import chalk from 'chalk'
4+
import fs from 'fs-extra'
55
import { Listr } from 'listr2'
66

77
import { addEnvVarTask } from '@redwoodjs/cli-helpers'

packages/cli/src/commands/setup/custom-web-index/custom-web-index-handler.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import chalk from 'chalk'
4+
import fs from 'fs-extra'
55
import { Listr } from 'listr2'
66

77
import { errorTelemetry } from '@redwoodjs/telemetry'

packages/cli/src/commands/setup/deploy/__tests__/netlify.test.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
// Automock fs using ../..../__mocks__/fs
22
jest.mock('fs')
33

4-
import fs from 'fs'
54
import path from 'path'
65

6+
import fs from 'fs-extra'
7+
78
import { getPaths } from '../../../../lib'
89
import { updateApiURLTask } from '../helpers'
910
// Mock telemetry and other things

packages/cli/src/commands/setup/deploy/helpers/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import fs from 'fs'
21
import path from 'path'
32

43
import execa from 'execa'
4+
import fs from 'fs-extra'
55
import { Listr } from 'listr2'
66

77
import { getPaths, writeFilesTask } from '../../../../lib'

0 commit comments

Comments
 (0)