refactor: avoid fs-extra in scripts aws#5736

# WIP: still need to test this work since not covered in test suite. 
## Problem
(title) since we want to fully remove this dependency. 

## Solution
Use node's built in `fs` module.
This allows us to avoid forcing these scripts to depend on the project
code, and keep them as standalone node scripts.

### Notes
The outputs are identical in size, but the output of running `diff` of
two vsix files shows they are not the same:
```
Files qMaster/extension.vsixmanifest and qNew/extension.vsixmanifest differ
Files qMaster/extension/dist/src/extensionNode.js and qNew/extension/dist/src/extensionNode.js differ
Files qMaster/extension/dist/src/extensionWeb.js and qNew/extension/dist/src/extensionWeb.js differ
Files qMaster/extension/dist/test/web/testRunnerWebCore.js and qNew/extension/dist/test/web/testRunnerWebCore.js differ
Files qMaster/extension/dist/tsconfig.tsbuildinfo and qNew/extension/dist/tsconfig.tsbuildinfo differ
Files qMaster/extension/package.json and qNew/extension/package.json differ
Files qMaster/extension/resources/css/icons.css and qNew/extension/resources/css/icons.css differ
```
```
Files toolkitMaster/extension.vsixmanifest and toolkitNew/extension.vsixmanifest differ
Files toolkitMaster/extension/dist/src/extensionNode.js and toolkitNew/extension/dist/src/extensionNode.js differ
Files toolkitMaster/extension/dist/src/extensionWeb.js and toolkitNew/extension/dist/src/extensionWeb.js differ
Files toolkitMaster/extension/package.json and toolkitNew/extension/package.json differ
Files toolkitMaster/extension/resources/css/icons.css and toolkitNew/extension/resources/css/icons.css differ
```
- The manifest changes are due to the hash being different in the name. (safe)
- `package.json` is also due to the naming difference (safe). 
- `icons.css` is different even on re-packaging the same project (safe)
- The .js files and tsbuildinfo differences are difficult to interpret and unsure if they are safe.

Author: Hweinstock

packages/core/scripts/build/generateServiceClient.ts

@@ -3,9 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/* eslint-disable no-restricted-imports */
 import * as proc from 'child_process'
-import * as fs from 'fs-extra'
+import * as nodefs from 'fs'
 import * as path from 'path'
 
 const repoRoot = path.join(process.cwd(), '../../') // root/packages/toolkit -> root/
@@ -34,7 +33,7 @@ async function generateServiceClients(serviceClientDefinitions: ServiceClientDef
 
 /** When cloning aws-sdk-js, we want to pull the version actually used in package-lock.json. */
 function getJsSdkVersion(): string {
-    const json = fs.readFileSync(path.resolve(repoRoot, 'package-lock.json')).toString()
+    const json = nodefs.readFileSync(path.resolve(repoRoot, 'package-lock.json')).toString()
     const packageLock = JSON.parse(json)
 
     return packageLock['packages']['node_modules/aws-sdk']['version']
@@ -116,7 +115,7 @@ async function insertServiceClientsIntoJsSdk(
             'apis',
             `${serviceClientDefinition.serviceName.toLowerCase()}-${apiVersion}.normal.json`
         )
-        fs.copyFileSync(serviceClientDefinition.serviceJsonPath, jsSdkServiceJsonPath)
+        nodefs.copyFileSync(serviceClientDefinition.serviceJsonPath, jsSdkServiceJsonPath)
     })
 
     const apiMetadataPath = path.join(jsSdkPath, 'apis', 'metadata.json')
@@ -133,7 +132,7 @@ interface ServiceJsonSchema {
 }
 
 function getApiVersion(serviceJsonPath: string): string {
-    const json = fs.readFileSync(serviceJsonPath).toString()
+    const json = nodefs.readFileSync(serviceJsonPath).toString()
     const serviceJson = JSON.parse(json) as ServiceJsonSchema
 
     return serviceJson.metadata.apiVersion
@@ -149,14 +148,14 @@ interface ApiMetadata {
 async function patchServicesIntoApiMetadata(apiMetadataPath: string, serviceNames: string[]): Promise<void> {
     console.log(`Patching services (${serviceNames.join(', ')}) into API Metadata...`)
 
-    const apiMetadataJson = fs.readFileSync(apiMetadataPath).toString()
+    const apiMetadataJson = nodefs.readFileSync(apiMetadataPath).toString()
     const apiMetadata = JSON.parse(apiMetadataJson) as ApiMetadata
 
     serviceNames.forEach((serviceName) => {
         apiMetadata[serviceName.toLowerCase()] = { name: serviceName }
     })
 
-    fs.writeFileSync(apiMetadataPath, JSON.stringify(apiMetadata, undefined, 4))
+    nodefs.writeFileSync(apiMetadataPath, JSON.stringify(apiMetadata, undefined, 4))
 }
 
 /**
@@ -198,7 +197,7 @@ async function integrateServiceClient(repoPath: string, serviceJsonPath: string,
 
     console.log(`Integrating ${typingsFilename} ...`)
 
-    fs.copyFileSync(sourceClientPath, destinationClientPath)
+    nodefs.copyFileSync(sourceClientPath, destinationClientPath)
 
     await sanitizeServiceClient(destinationClientPath)
 }
@@ -209,7 +208,7 @@ async function integrateServiceClient(repoPath: string, serviceJsonPath: string,
 async function sanitizeServiceClient(generatedClientPath: string): Promise<void> {
     console.log('Altering Service Client to fit the codebase...')
 
-    let fileContents = fs.readFileSync(generatedClientPath).toString()
+    let fileContents = nodefs.readFileSync(generatedClientPath).toString()
 
     // Add a header stating the file is autogenerated
     fileContents = `
@@ -223,7 +222,7 @@ ${fileContents}
 
     fileContents = fileContents.replace(/(import .* from.*)\.\.(.*)/g, '$1aws-sdk$2')
 
-    fs.writeFileSync(generatedClientPath, fileContents)
+    nodefs.writeFileSync(generatedClientPath, fileContents)
 }
 
 // ---------------------------------------------------------------------------------------------------------------------

scripts/createRelease.ts

@@ -8,25 +8,25 @@
 //
 
 import * as child_process from 'child_process'
-import * as fs from 'fs-extra'
+import * as nodefs from 'fs'
 import * as path from 'path'
 
 // Must run from a subproject root folder, e.g packages/toolkit
 const cwd = process.cwd()
-const packageJson = JSON.parse(fs.readFileSync('./package.json', { encoding: 'utf-8' }))
+const packageJson = JSON.parse(nodefs.readFileSync('./package.json', { encoding: 'utf-8' }))
 const changesDirectory = path.join(cwd, '.changes')
 const nextReleaseDirectory = path.join(changesDirectory, 'next-release')
 const changesFile = path.join(changesDirectory, `${packageJson.version}.json`)
 
-fs.mkdirpSync(nextReleaseDirectory)
+nodefs.mkdirSync(nextReleaseDirectory, { recursive: true })
 
-const changeFiles = fs.readdirSync(nextReleaseDirectory)
+const changeFiles = nodefs.readdirSync(nextReleaseDirectory)
 if (changeFiles.length === 0) {
     console.warn('no changes to release (missing .changes/ directory)')
     process.exit()
 }
 try {
-    fs.accessSync(changesFile)
+    nodefs.accessSync(changesFile)
     console.log(`error: changelog data file already exists: ${changesFile}`)
     process.exit(-1)
 } catch (err) {
@@ -41,22 +41,22 @@ const changelog: any = {
 }
 
 for (const changeFile of changeFiles) {
-    const file = JSON.parse(fs.readFileSync(path.join(nextReleaseDirectory, changeFile)).toString())
+    const file = JSON.parse(nodefs.readFileSync(path.join(nextReleaseDirectory, changeFile)).toString())
     changelog.entries.push(file)
 }
 
 changelog.entries.sort((x: { type: string }, y: { type: string }) => x.type.localeCompare(y.type))
 
 // Write changelog file
-fs.writeFileSync(changesFile, JSON.stringify(changelog, undefined, '\t'))
-const fileData = fs.readFileSync(path.join(cwd, 'CHANGELOG.md'))
+nodefs.writeFileSync(changesFile, JSON.stringify(changelog, undefined, '\t'))
+const fileData = nodefs.readFileSync(path.join(cwd, 'CHANGELOG.md'))
 let append = `## ${packageJson.version} ${timestamp}\n\n`
 for (const file of changelog.entries) {
     append += `- **${file.type}** ${file.description}\n`
 }
 
 append += '\n' + fileData.toString()
-fs.writeFileSync('CHANGELOG.md', append)
+nodefs.writeFileSync('CHANGELOG.md', append)
 
 child_process.execSync(`git add ${changesDirectory}`)
 child_process.execSync(`git rm -rf ${nextReleaseDirectory}`)

scripts/generateIcons.ts

@@ -5,15 +5,15 @@
 
 import webfont from 'webfont'
 import * as path from 'path'
-import * as fs from 'fs-extra'
+import * as nodefs from 'fs'
 
 const fontId = 'aws-toolkit-icons'
 const projectDir = process.cwd() // root/packages/toolkit
 const rootDir = path.join(projectDir, '../..') // root/
 const iconsDir = path.join(projectDir, 'resources', 'icons')
 const fontsDir = path.join(projectDir, 'resources', 'fonts')
 const stylesheetsDir = path.join(projectDir, 'resources', 'css')
-const packageJson = JSON.parse(fs.readFileSync(path.join(projectDir, 'package.json'), { encoding: 'utf-8' }))
+const packageJson = JSON.parse(nodefs.readFileSync(path.join(projectDir, 'package.json'), { encoding: 'utf-8' }))
 const iconSources = [
     // Paths relative to packages/toolkit
     `resources/icons/**/*.svg`,
@@ -69,7 +69,7 @@ async function updatePackage(fontPath: string, icons: [id: string, icon: Package
 
     // prettier adds a newline to JSON files
     const newPackage = `${JSON.stringify(packageJson, undefined, 4)}\n`
-    await fs.writeFile(path.join(projectDir, 'package.json'), newPackage)
+    nodefs.writeFileSync(path.join(projectDir, 'package.json'), newPackage)
     console.log('Updated package.json')
 }
 
@@ -81,15 +81,15 @@ const themes = {
 async function generateCloud9Icons(targets: { name: string; path: string }[], destination: string): Promise<void> {
     console.log('Generating icons for Cloud9')
 
-    async function replaceColor(file: string, color: string, dst: string): Promise<void> {
-        const contents = await fs.readFile(file, 'utf-8')
+    function replaceColor(file: string, color: string, dst: string): void {
+        const contents = nodefs.readFileSync(file, 'utf-8')
         const replaced = contents.replace(/currentColor/g, color)
-        await fs.writeFile(dst, replaced)
+        nodefs.writeFileSync(dst, replaced)
     }
 
     for (const [theme, color] of Object.entries(themes)) {
         const themeDest = path.join(destination, theme)
-        await fs.mkdirp(themeDest)
+        nodefs.mkdirSync(themeDest, { recursive: true })
         await Promise.all(targets.map((t) => replaceColor(t.path, color, path.join(themeDest, `${t.name}.svg`))))
     }
 }
@@ -169,9 +169,11 @@ ${result.template}
     const cloud9Dest = path.join(iconsDir, 'cloud9', 'generated')
     const isValidIcon = (i: (typeof icons)[number]): i is Required<typeof i> => i.data !== undefined
 
-    await fs.mkdirp(fontsDir)
-    await fs.writeFile(dest, result.woff)
-    await fs.writeFile(stylesheetPath, template)
+    nodefs.mkdirSync(fontsDir, { recursive: true })
+    if (result.woff) {
+        nodefs.writeFileSync(dest, result.woff)
+    }
+    nodefs.writeFileSync(stylesheetPath, template)
     await updatePackage(
         `./${relativeDest}`,
         icons.filter(isValidIcon).map((i) => [i.name, i.data])
@@ -182,7 +184,7 @@ ${result.template}
     generated.addEntry(stylesheetPath)
     generated.addEntry(cloud9Dest)
 
-    await generated.emit(path.join(projectDir, 'dist'))
+    generated.emit(path.join(projectDir, 'dist'))
 }
 
 class GeneratedFilesManifest {
@@ -192,17 +194,17 @@ class GeneratedFilesManifest {
         this.files.push(file)
     }
 
-    public async emit(dir: string): Promise<void> {
+    public emit(dir: string): void {
         const dest = path.join(dir, 'generated.buildinfo')
         const data = JSON.stringify(this.files, undefined, 4)
-        await fs.mkdirp(dir)
-        await fs.writeFile(dest, data)
+        nodefs.mkdirSync(dir, { recursive: true })
+        nodefs.writeFileSync(dest, data)
     }
 }
 
 async function loadCodiconMappings(): Promise<Record<string, number | undefined>> {
     const codicons = path.join(rootDir, 'node_modules', '@vscode', 'codicons', 'src')
-    const data = JSON.parse(await fs.readFile(path.join(codicons, 'template', 'mapping.json'), 'utf-8'))
+    const data = JSON.parse(nodefs.readFileSync(path.join(codicons, 'template', 'mapping.json'), 'utf-8'))
     const mappings: Record<string, number | undefined> = {}
     for (const [k, v] of Object.entries(data)) {
         if (typeof k === 'string' && typeof v === 'number') {

scripts/generateNonCodeFiles.ts

@@ -4,7 +4,7 @@
  */
 
 import * as child_process from 'child_process'
-import * as fs from 'fs-extra'
+import * as nodefs from 'fs'
 import { marked } from 'marked'
 import * as path from 'path'
 
@@ -27,14 +27,14 @@ function translateReadmeToHtml(
     cn: boolean = false
 ) {
     const inputPath = path.join(root, inputFile)
-    if (!fs.existsSync(inputPath)) {
+    if (!nodefs.existsSync(inputPath)) {
         if (throwIfNotExists) {
             throw Error(`File ${inputFile} was not found, but it is required.`)
         }
         console.log(`File ${inputFile} was not found, skipping transformation...`)
         return
     }
-    const fileText = fs.readFileSync(path.join(root, inputFile)).toString()
+    const fileText = nodefs.readFileSync(path.join(root, inputFile)).toString()
     const relativePathRegex = /]\(\.\//g
     let transformedText = fileText.replace(relativePathRegex, '](!!EXTENSIONROOT!!/')
     if (cn) {
@@ -45,7 +45,7 @@ function translateReadmeToHtml(
     if (typeof r !== 'string') {
         throw Error()
     }
-    fs.writeFileSync(path.join(root, outputFile), r)
+    nodefs.writeFileSync(path.join(root, outputFile), r)
 }
 
 /**
@@ -54,7 +54,8 @@ function translateReadmeToHtml(
 function generateFileHash(root: string) {
     try {
         const response = child_process.execSync('git rev-parse HEAD')
-        fs.outputFileSync(path.join(root, '.gitcommit'), response)
+        nodefs.mkdirSync(root, { recursive: true })
+        nodefs.writeFileSync(path.join(root, '.gitcommit'), response)
     } catch (e) {
         console.log(`Getting commit hash failed ${e}`)
     }

scripts/generateSettings.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import * as fs from 'fs-extra'
+import * as nodefs from 'fs'
 import * as path from 'path'
 
 /**
@@ -17,7 +17,7 @@ import * as path from 'path'
 function main() {
     const ext = path.basename(process.cwd())
     const packageJsonFile = './package.json'
-    const packageJson = JSON.parse(fs.readFileSync(packageJsonFile, { encoding: 'utf-8' }))
+    const packageJson = JSON.parse(nodefs.readFileSync(packageJsonFile, { encoding: 'utf-8' }))
 
     const genFile = `../core/src/shared/settings-${ext}.gen.ts`
     type Configuration = { [key: string]: { [key: string]: {} } }
@@ -50,7 +50,7 @@ export const ${ext}Settings = ${JSON.stringify(settings, undefined, '    ')}
 export default ${ext}Settings
 `
 
-    fs.writeFileSync(genFile, contents)
+    nodefs.writeFileSync(genFile, contents)
 }
 
 main()

scripts/newChange.ts

@@ -4,7 +4,7 @@
  */
 
 import * as child_process from 'child_process'
-import * as fs from 'fs-extra'
+import * as nodefs from 'fs'
 import { join } from 'path'
 import * as readlineSync from 'readline-sync'
 import * as crypto from 'crypto'
@@ -40,7 +40,7 @@ function promptForChange(): string {
     }
 }
 
-fs.mkdirpSync(directory)
+nodefs.mkdirSync(directory, { recursive: true })
 
 const type = promptForType()
 const description = promptForChange()
@@ -50,7 +50,7 @@ const contents: NewChange = {
 }
 const fileName = `${type}-${crypto.randomUUID()}.json`
 const path = join(directory, fileName)
-fs.writeFileSync(path, JSON.stringify(contents, undefined, '\t') + '\n')
+nodefs.writeFileSync(path, JSON.stringify(contents, undefined, '\t') + '\n')
 
 console.log(`Change log written to ${path}`)
 child_process.execSync(`git add ${directory}`)