Enable github/array-foreach ESLint rule by converting all forEach to for loops (#58302)

Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com>

Author: heiskr

eslint.config.ts

@@ -96,7 +96,6 @@ export default [
  camelcase: 'off', // Many gh apis use underscores, 600+ uses
 
  // Disabled rules to review
- 'github/array-foreach': 'off', // 250+
  'no-console': 'off', // 800+
  '@typescript-eslint/no-explicit-any': 'off', // 1000+
  },

src/ai-tools/scripts/ai-tools.ts

@@ -48,9 +48,9 @@ const editorTypes: EditorTypes = {
 
 const refinementDescriptions = (): string => {
  let str = '\n\n'
- Object.entries(editorTypes).forEach(([ed, edObj]) => {
+ for (const [ed, edObj] of Object.entries(editorTypes)) {
  str += ` ${ed.padEnd(12)} ${edObj.description}\n`
- })
+ }
  return str
 }
 
@@ -155,10 +155,10 @@ async function callEditor(
 
  const prompt = yaml.load(fs.readFileSync(promptTemplatePath, 'utf8')) as PromptData
 
- prompt.messages.forEach((msg) => {
+ for (const msg of prompt.messages) {
  msg.content = msg.content.replace('{{markdownPrompt}}', markdownPrompt)
  msg.content = msg.content.replace('{{input}}', content)
- })
+ }
 
  return callModelsApi(prompt)
 }

src/article-api/scripts/generate-api-docs.ts

@@ -117,7 +117,7 @@ function extractExample(commentBlock: string): string {
 function generateMarkdown(apiDocs: any[]): string {
  let markdown = '## Reference: API endpoints\n\n'
 
- apiDocs.forEach((doc) => {
+ for (const doc of apiDocs) {
  markdown += `### ${doc.method.toUpperCase()} ${doc.path}\n\n`
  markdown += `${doc.description}\n\n`
 
@@ -142,7 +142,7 @@ function generateMarkdown(apiDocs: any[]): string {
  }
 
  markdown += '---\n\n'
- })
+ }
 
  return markdown
 }

src/article-api/tests/pagelist.ts

@@ -41,22 +41,16 @@ describe.each(allVersionKeys)('pagelist api for %s', async (versionKey) => {
  expression = new RegExp(`/\\w{2}(/${versionKey})?/?.*`)
  else expression = new RegExp(`/\\w{2}/${versionKey}/?.*`)
 
- res.body
- .trim()
- .split('\n')
- .forEach((permalink: string) => {
- expect(permalink).toMatch(expression)
- })
+ for (const permalink of res.body.trim().split('\n')) {
+ expect(permalink).toMatch(expression)
+ }
  })
 
  test('English requests only returns urls that contain /en', async () => {
  const expression = new RegExp(`^/en(/${nonEnterpriseDefaultVersion})?/?.*`)
- res.body
- .trim()
- .split('\n')
- .forEach((permalink: string) => {
- expect(permalink).toMatch(expression)
- })
+ for (const permalink of res.body.trim().split('\n')) {
+ expect(permalink).toMatch(expression)
+ }
  })
 })
 

src/assets/scripts/list-image-sizes.ts

@@ -25,9 +25,7 @@ const images = await Promise.all(
  return { relativePath, width, height, size }
  }),
 )
-images
- .sort((a, b) => b.size - a.size)
- .forEach((image) => {
- const { relativePath, width, height } = image
- console.log(`${width} x ${height} - ${relativePath}`)
- })
+for (const image of images.sort((a, b) => b.size - a.size)) {
+ const { relativePath, width, height } = image
+ console.log(`${width} x ${height} - ${relativePath}`)
+}

src/audit-logs/lib/index.ts

@@ -317,14 +317,14 @@ export async function filterAndUpdateGhesDataByAllowlistValues({
 // Categorizes the given array of audit log events by event category
 function categorizeEvents(events: AuditLogEventT[]) {
  const categorizedEvents: CategorizedEvents = {}
- events.forEach((event) => {
+ for (const event of events) {
  const [category] = event.action.split('.')
  if (!Object.hasOwn(categorizedEvents, category)) {
  categorizedEvents[category] = []
  }
 
  categorizedEvents[category].push(event)
- })
+ }
 
  return categorizedEvents
 }

src/audit-logs/scripts/sync.ts

@@ -180,17 +180,16 @@ async function main() {
  await mkdirp(auditLogVersionDirPath)
  }
 
- Object.values(AUDIT_LOG_PAGES).forEach(async (page) => {
+ for (const page of Object.values(AUDIT_LOG_PAGES)) {
  const auditLogSchemaFilePath = path.join(auditLogVersionDirPath, `${page}.json`)
 
  if (auditLogData[version][page]) {
  await writeFile(
  auditLogSchemaFilePath,
  JSON.stringify(auditLogData[version][page], null, 2),
  )
- console.log(`✅ Wrote ${auditLogSchemaFilePath}`)
  }
- })
+ }
  }
 }
 

src/audit-logs/tests/fields.ts

@@ -31,25 +31,25 @@ describe('Audit log fields functionality', () => {
 
  if (eventWithFields) {
  expect(Array.isArray(eventWithFields.fields)).toBe(true)
- eventWithFields.fields!.forEach((field) => {
+ for (const field of eventWithFields.fields!) {
  expect(typeof field).toBe('string')
  expect(field.length).toBeGreaterThan(0)
- })
+ }
  }
  })
 
  test('should handle events without fields gracefully', () => {
  // Some events might not have fields, this should not break anything
  const events = getAuditLogEvents('organization', 'enterprise-cloud@latest')
 
- events.forEach((event) => {
+ for (const event of events) {
  expect(event).toHaveProperty('action')
  expect(event).toHaveProperty('description')
  // fields property is optional
  if (event.fields) {
  expect(Array.isArray(event.fields)).toBe(true)
  }
- })
+ }
  })
 
  test('should include common audit log fields', () => {
@@ -82,19 +82,19 @@ describe('Audit log fields functionality', () => {
  expect(categories.length).toBeGreaterThan(0)
 
  // Check that events in categories have proper structure including fields
- categories.forEach((category) => {
+ for (const category of categories) {
  const events = categorizedEvents[category]
  expect(Array.isArray(events)).toBe(true)
 
- events.forEach((event: AuditLogEventT) => {
+ for (const event of events as AuditLogEventT[]) {
  expect(event).toHaveProperty('action')
  expect(event).toHaveProperty('description')
  // fields is optional but if present should be array
  if (event.fields) {
  expect(Array.isArray(event.fields)).toBe(true)
  }
- })
- })
+ }
+ }
  })
 
  test('should preserve fields data through categorization', () => {
@@ -127,20 +127,20 @@ describe('Audit log fields functionality', () => {
  test('should not have duplicate fields in same event', () => {
  const events = getAuditLogEvents('organization', 'enterprise-cloud@latest')
 
- events.forEach((event) => {
+ for (const event of events) {
  if (event.fields) {
  const uniqueFields = new Set(event.fields)
  expect(uniqueFields.size).toBe(event.fields.length)
  }
- })
+ }
  })
 
  test('should have reasonable field names', () => {
  const events = getAuditLogEvents('organization', 'enterprise-cloud@latest')
  const eventWithFields = events.find((event) => event.fields && event.fields.length > 0)
 
  if (eventWithFields) {
- eventWithFields.fields!.forEach((field) => {
+ for (const field of eventWithFields.fields!) {
  // Field names should be reasonable strings
  expect(field).toBeTruthy()
  expect(typeof field).toBe('string')
@@ -149,33 +149,33 @@ describe('Audit log fields functionality', () => {
 
  // Should not contain special characters that would break display
  expect(field).not.toMatch(/[<>'"&]/)
- })
+ }
  }
  })
 
  test('should handle different page types consistently', () => {
  const pageTypes = ['organization', 'enterprise', 'user']
 
- pageTypes.forEach((pageType) => {
+ for (const pageType of pageTypes) {
  try {
  const events = getAuditLogEvents(pageType, 'enterprise-cloud@latest')
 
- events.forEach((event) => {
+ for (const event of events) {
  expect(event).toHaveProperty('action')
  expect(event).toHaveProperty('description')
 
  if (event.fields) {
  expect(Array.isArray(event.fields)).toBe(true)
- event.fields.forEach((field) => {
+ for (const field of event.fields) {
  expect(typeof field).toBe('string')
- })
+ }
  }
- })
+ }
  } catch (error) {
  // Some page types might not exist for certain versions, that's ok
  console.log(`Skipping ${pageType} page type due to: ${error}`)
  }
- })
+ }
  })
  })
 
@@ -194,9 +194,9 @@ describe('Audit log fields functionality', () => {
 
  if (fields) {
  expect(Array.isArray(fields)).toBe(true)
- fields.forEach((field) => {
+ for (const field of fields) {
  expect(typeof field).toBe('string')
- })
+ }
  }
  })
  })

src/audit-logs/tests/unit/category-notes.ts

@@ -16,10 +16,10 @@ describe('audit log category notes', () => {
 
  test('category notes are strings', () => {
  if (config.categoryNotes) {
- Object.values(config.categoryNotes).forEach((note) => {
+ for (const note of Object.values(config.categoryNotes)) {
  expect(typeof note).toBe('string')
  expect(note.length).toBeGreaterThan(0)
- })
+ }
  }
  })
 
@@ -51,13 +51,13 @@ describe('audit log category notes', () => {
  expect(Object.keys(enterpriseEvents).length).toBeGreaterThan(0)
 
  // Each category should still contain arrays of events
- Object.values(organizationEvents).forEach((events) => {
+ for (const events of Object.values(organizationEvents)) {
  expect(Array.isArray(events)).toBe(true)
  if (events.length > 0) {
  expect(events[0]).toHaveProperty('action')
  expect(events[0]).toHaveProperty('description')
  }
- })
+ }
  })
 
  test('category notes are properly typed', () => {

src/automated-pipelines/lib/update-markdown.ts

@@ -399,7 +399,9 @@ async function getIndexFileVersions(
  throw new Error(`Frontmatter in ${filepath} does not contain versions.`)
  }
  const fmVersions = getApplicableVersions(data.versions)
- fmVersions.forEach((version: string) => versions.add(version))
+ for (const version of fmVersions) {
+ versions.add(version)
+ }
  }),
  )
  const versionArray = [...versions]
@@ -431,7 +433,7 @@ export async function convertVersionsToFrontmatter(
 
  // Currently, only GHES is numbered. Number releases have to be
  // handled differently because they use semantic versioning.
- versions.forEach((version) => {
+ for (const version of versions) {
  const docsVersion = allVersions[version]
  if (!docsVersion.hasNumberedReleases) {
  frontmatterVersions[docsVersion.shortName] = '*'
@@ -455,10 +457,10 @@ export async function convertVersionsToFrontmatter(
  numberedReleases[docsVersion.shortName].availableReleases[i] = docsVersion.currentRelease
  }
  }
- })
+ }
 
  // Create semantic versions for numbered releases
- Object.keys(numberedReleases).forEach((key) => {
+ for (const key of Object.keys(numberedReleases)) {
  const availableReleases = numberedReleases[key].availableReleases
  const versionContinuity = checkVersionContinuity(availableReleases)
  if (availableReleases.every(Boolean)) {
@@ -483,7 +485,7 @@ export async function convertVersionsToFrontmatter(
  }
  frontmatterVersions[key] = semVer.join(' ')
  }
- })
+ }
  const sortedFrontmatterVersions = Object.keys(frontmatterVersions)
  .sort()
  .reduce((acc: { [key: string]: string }, key) => {