fully remove fs-extra

Author: Hweinstock

packages/amazonq/scripts/build/copyFiles.ts

@@ -3,8 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/* eslint-disable no-restricted-imports */
-import * as fs from 'fs-extra'
+import { fs } from 'aws-core-vscode/shared'
 import * as path from 'path'
 
 // Moves all dependencies into `dist`
@@ -78,11 +77,7 @@ async function copy(task: CopyTask): Promise<void> {
     const dst = path.resolve(outRoot, task.destination ?? task.target)
 
     try {
-        await fs.copy(src, dst, {
-            recursive: true,
-            overwrite: true,
-            errorOnExist: false,
-        })
+        await fs.copy(src, dst)
     } catch (error) {
         throw new Error(`Copy "${src}" to "${dst}" failed: ${error instanceof Error ? error.message : error}`)
     }

packages/core/scripts/build/copyFiles.ts

@@ -3,9 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/* eslint-disable no-restricted-imports */
-import * as fs from 'fs-extra'
 import * as path from 'path'
+import { fs } from '../../src/shared'
 
 // Moves all dependencies into `dist`
 
@@ -51,11 +50,7 @@ async function copy(task: CopyTask): Promise<void> {
     const dst = path.resolve(outRoot, task.destination ?? task.target)
 
     try {
-        await fs.copy(src, dst, {
-            recursive: true,
-            overwrite: true,
-            errorOnExist: false,
-        })
+        await fs.copy(src, dst)
     } catch (error) {
         throw new Error(`Copy "${src}" to "${dst}" failed: ${error instanceof Error ? error.message : error}`)
     }

packages/core/scripts/build/generateServiceClient.ts

@@ -3,10 +3,9 @@
  * 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 path from 'path'
+import { fs } from '../../src/shared'
 
 const repoRoot = path.join(process.cwd(), '../../') // root/packages/toolkit -> root/
 /**
@@ -33,17 +32,17 @@ 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()
+async function getJsSdkVersion(): Promise<string> {
+    const json = (await fs.readFileBytes(path.resolve(repoRoot, 'package-lock.json'))).toString()
     const packageLock = JSON.parse(json)
 
     return packageLock['packages']['node_modules/aws-sdk']['version']
 }
 
 async function cloneJsSdk(dir: string): Promise<void> {
     // Output stderr while it clones so it doesn't look frozen
-    return new Promise<void>((resolve, reject) => {
-        const sdkversion = getJsSdkVersion()
+    return new Promise<void>(async (resolve, reject) => {
+        const sdkversion = await getJsSdkVersion()
         if (!sdkversion) {
             throw new Error('failed to get sdk version from package-lock.json')
         }
@@ -107,17 +106,17 @@ async function insertServiceClientsIntoJsSdk(
     jsSdkPath: string,
     serviceClientDefinitions: ServiceClientDefinition[]
 ): Promise<void> {
-    serviceClientDefinitions.forEach((serviceClientDefinition) => {
-        const apiVersion = getApiVersion(serviceClientDefinition.serviceJsonPath)
+    for (const serviceClientDefinition of serviceClientDefinitions) {
+        const apiVersion = await getApiVersion(serviceClientDefinition.serviceJsonPath)
 
         // Copy the Service Json into the JS SDK for generation
         const jsSdkServiceJsonPath = path.join(
             jsSdkPath,
             'apis',
             `${serviceClientDefinition.serviceName.toLowerCase()}-${apiVersion}.normal.json`
         )
-        fs.copyFileSync(serviceClientDefinition.serviceJsonPath, jsSdkServiceJsonPath)
-    })
+        await fs.copy(serviceClientDefinition.serviceJsonPath, jsSdkServiceJsonPath)
+    }
 
     const apiMetadataPath = path.join(jsSdkPath, 'apis', 'metadata.json')
     await patchServicesIntoApiMetadata(
@@ -132,8 +131,8 @@ interface ServiceJsonSchema {
     }
 }
 
-function getApiVersion(serviceJsonPath: string): string {
-    const json = fs.readFileSync(serviceJsonPath).toString()
+async function getApiVersion(serviceJsonPath: string): Promise<string> {
+    const json = (await fs.readFileBytes(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 = (await fs.readFileBytes(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))
+    await fs.writeFile(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)
+    await fs.copy(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 = (await fs.readFileBytes(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)
+    await fs.writeFile(generatedClientPath, fileContents)
 }
 
 // ---------------------------------------------------------------------------------------------------------------------

packages/toolkit/scripts/build/copyFiles.ts

@@ -3,8 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/* eslint-disable no-restricted-imports */
-import * as fs from 'fs-extra'
+import { fs } from 'aws-core-vscode/shared'
 import * as path from 'path'
 
 // Copies various dependencies into "dist/".
@@ -105,11 +104,7 @@ async function copy(task: CopyTask): Promise<void> {
     const dst = path.resolve(outRoot, task.destination ?? task.target)
 
     try {
-        await fs.copy(src, dst, {
-            recursive: true,
-            overwrite: true,
-            errorOnExist: false,
-        })
+        await fs.copy(src, dst)
     } catch (error) {
         throw new Error(`Copy "${src}" to "${dst}" failed: ${error instanceof Error ? error.message : error}`)
     }

scripts/createRelease.ts

@@ -8,58 +8,61 @@
 //
 
 import * as child_process from 'child_process'
-import * as fs from 'fs-extra'
 import * as path from 'path'
+import { fs } from '../packages/core/src/shared'
+import { readdirSync } from 'fs'
 
-// 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 changesDirectory = path.join(cwd, '.changes')
-const nextReleaseDirectory = path.join(changesDirectory, 'next-release')
-const changesFile = path.join(changesDirectory, `${packageJson.version}.json`)
+async function main() {
+    // Must run from a subproject root folder, e.g packages/toolkit
+    const cwd = process.cwd()
+    const fileContents = await fs.readFileText('./package.json')
+    const packageJson = JSON.parse(fileContents)
+    const changesDirectory = path.join(cwd, '.changes')
+    const nextReleaseDirectory = path.join(changesDirectory, 'next-release')
+    const changesFile = path.join(changesDirectory, `${packageJson.version}.json`)
 
-fs.mkdirpSync(nextReleaseDirectory)
+    await fs.mkdir(nextReleaseDirectory)
 
-const changeFiles = fs.readdirSync(nextReleaseDirectory)
-if (changeFiles.length === 0) {
-    console.warn('no changes to release (missing .changes/ directory)')
-    process.exit()
-}
-try {
-    fs.accessSync(changesFile)
-    console.log(`error: changelog data file already exists: ${changesFile}`)
-    process.exit(-1)
-} catch (err) {
-    // This is what we want to happen, the file should not exist
-}
+    const changeFiles = readdirSync(nextReleaseDirectory)
+    if (changeFiles.length === 0) {
+        console.warn('no changes to release (missing .changes/ directory)')
+        process.exit()
+    }
+    if (await fs.exists(changesFile)) {
+        console.log(`error: changelog data file already exists: ${changesFile}`)
+        process.exit(-1)
+    }
 
-const timestamp = new Date().toISOString().split('T')[0]
-const changelog: any = {
-    date: timestamp,
-    version: packageJson.version,
-    entries: [],
-}
+    const timestamp = new Date().toISOString().split('T')[0]
+    const changelog: any = {
+        date: timestamp,
+        version: packageJson.version,
+        entries: [],
+    }
 
-for (const changeFile of changeFiles) {
-    const file = JSON.parse(fs.readFileSync(path.join(nextReleaseDirectory, changeFile)).toString())
-    changelog.entries.push(file)
-}
+    for (const changeFile of changeFiles) {
+        const file = JSON.parse(fs.readFileBytes(path.join(nextReleaseDirectory, changeFile)).toString())
+        changelog.entries.push(file)
+    }
 
-changelog.entries.sort((x: { type: string }, y: { type: string }) => x.type.localeCompare(y.type))
+    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'))
-let append = `## ${packageJson.version} ${timestamp}\n\n`
-for (const file of changelog.entries) {
-    append += `- **${file.type}** ${file.description}\n`
-}
+    // Write changelog file
+    await fs.writeFile(changesFile, JSON.stringify(changelog, undefined, '\t'))
+    const fileData = fs.readFileBytes(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()
+    await fs.writeFile('CHANGELOG.md', append)
 
-append += '\n' + fileData.toString()
-fs.writeFileSync('CHANGELOG.md', append)
+    child_process.execSync(`git add ${changesDirectory}`)
+    child_process.execSync(`git rm -rf ${nextReleaseDirectory}`)
+    child_process.execSync('git add CHANGELOG.md')
 
-child_process.execSync(`git add ${changesDirectory}`)
-child_process.execSync(`git rm -rf ${nextReleaseDirectory}`)
-child_process.execSync('git add CHANGELOG.md')
+    console.log(changesFile)
+}
 
-console.log(changesFile)
+void main()

scripts/generateIcons.ts

@@ -5,15 +5,16 @@
 
 import webfont from 'webfont'
 import * as path from 'path'
-import * as fs from 'fs-extra'
+import * as nodefs from 'fs'
+import fs from '../packages/core/dist/src/shared/fs/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`,
@@ -82,14 +83,14 @@ async function generateCloud9Icons(targets: { name: string; path: string }[], de
     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')
+        const contents = await fs.readFileText(file)
         const replaced = contents.replace(/currentColor/g, color)
         await fs.writeFile(dst, replaced)
     }
 
     for (const [theme, color] of Object.entries(themes)) {
         const themeDest = path.join(destination, theme)
-        await fs.mkdirp(themeDest)
+        await fs.mkdir(themeDest)
         await Promise.all(targets.map((t) => replaceColor(t.path, color, path.join(themeDest, `${t.name}.svg`))))
     }
 }
@@ -169,8 +170,10 @@ ${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.mkdir(fontsDir)
+    if (result.woff) {
+        await fs.writeFile(dest, result.woff)
+    }
     await fs.writeFile(stylesheetPath, template)
     await updatePackage(
         `./${relativeDest}`,
@@ -195,14 +198,14 @@ class GeneratedFilesManifest {
     public async emit(dir: string): Promise<void> {
         const dest = path.join(dir, 'generated.buildinfo')
         const data = JSON.stringify(this.files, undefined, 4)
-        await fs.mkdirp(dir)
+        await fs.mkdir(dir)
         await fs.writeFile(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(await fs.readFileText(path.join(codicons, 'template', 'mapping.json')))
     const mappings: Record<string, number | undefined> = {}
     for (const [k, v] of Object.entries(data)) {
         if (typeof k === 'string' && typeof v === 'number') {