Use named imports for js-yaml (#62014)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 3 people

src/ai-tools/lib/file-utils.ts

@@ -1,6 +1,6 @@
 import fs from 'fs'
 import path from 'path'
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 import readFrontmatter from '@/frame/lib/read-frontmatter'
 import { schema } from '@/frame/lib/frontmatter'
 
@@ -96,7 +96,7 @@ export function mergeFrontmatterProperties(filePath: string, newPropertiesYaml:
     cleanedYaml = cleanedYaml.replace(/\n```\s*$/i, '')
     cleanedYaml = cleanedYaml.trim()
 
-    const newProperties = yaml.load(cleanedYaml) as FrontmatterProperties
+    const newProperties = load(cleanedYaml) as FrontmatterProperties
 
     // Security: Validate against prototype pollution using the official frontmatter schema
     const allowedKeys = Object.keys(schema.properties)

src/ai-tools/lib/prompt-utils.ts

@@ -1,6 +1,6 @@
 import { fileURLToPath } from 'url'
 import fs from 'fs'
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 import path from 'path'
 import readFrontmatter from '@/frame/lib/read-frontmatter'
 import { callModelsApi } from '@/ai-tools/lib/call-models-api'
@@ -142,7 +142,7 @@ export async function callEditor(
   }
   const promptTemplatePath = path.join(promptDir, 'prompt-template.yml')
 
-  const prompt = yaml.load(fs.readFileSync(promptTemplatePath, 'utf8')) as PromptData
+  const prompt = load(fs.readFileSync(promptTemplatePath, 'utf8')) as PromptData
 
   // Validate the prompt template has required properties
   if (!prompt.messages || !Array.isArray(prompt.messages)) {

src/content-linter/lib/helpers/get-lintable-yml.ts

@@ -1,4 +1,4 @@
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 import fs from 'fs/promises'
 
 import dataSchemas from '@/data-directory/lib/data-schemas/index'
@@ -71,7 +71,7 @@ export async function getLintableYml(dataFilePath: string): Promise<Record<strin
   const schema = (await import(schemaFilePath)).default
   if (!schema) return null
 
-  const data = yaml.load(await fs.readFile(dataFilePath, 'utf8'))
+  const data = load(await fs.readFile(dataFilePath, 'utf8'))
 
   mdDict.clear()
   // This validate function will call all keyword validator functions and populate mdDict

src/content-linter/lib/linting-rules/early-access-references.ts

@@ -1,5 +1,5 @@
 import { addError } from 'markdownlint-rule-helpers'
-import yaml from 'js-yaml'
+import { dump } from 'js-yaml'
 
 import { getRange, getFrontmatter } from '../helpers/utils'
 import type { RuleParams, RuleErrorCallback, Rule } from '@/content-linter/types'
@@ -75,7 +75,7 @@ export const frontmatterEarlyAccessReferences: Rule = {
 
     // Convert updated frontmatter back to a string
     // to search for 'early-access'.'
-    const fmStrings = yaml.dump(fm).split('\n')
+    const fmStrings = dump(fm).split('\n')
 
     for (const line of fmStrings) {
       const matches = line.match(EARLY_ACCESS_REGEX)

src/content-linter/lib/linting-rules/third-party-action-pinning.ts

@@ -1,5 +1,5 @@
 import { addError, filterTokens } from 'markdownlint-rule-helpers'
-import yaml from 'js-yaml'
+import { load, YAMLException } from 'js-yaml'
 
 import { liquid } from '@/content-render/index'
 import { allVersions } from '@/versions/lib/all-versions'
@@ -50,7 +50,7 @@ export const thirdPartyActionPinning: Rule = {
       // If we don't parse the Liquid first, yaml loading chokes on {% raw %} tags
       const renderedYaml = await liquid.parseAndRender(token.content, context)
       try {
-        const yamlObj = yaml.load(renderedYaml) as WorkflowYaml
+        const yamlObj = load(renderedYaml) as WorkflowYaml
         const steps = getWorkflowSteps(yamlObj)
         if (!steps.some((step) => step.uses)) return
 
@@ -73,7 +73,7 @@ export const thirdPartyActionPinning: Rule = {
           }
         }
       } catch (e) {
-        if (e instanceof yaml.YAMLException) {
+        if (e instanceof YAMLException) {
           console.log('YAML Exception file:', params.name)
           console.error('YAML Exception:', e.message)
         } else {

src/content-linter/lib/linting-rules/yaml-scheduled-jobs.ts

@@ -1,4 +1,4 @@
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 import { addError, filterTokens } from 'markdownlint-rule-helpers'
 
 import { liquid } from '@/content-render/index'
@@ -39,7 +39,7 @@ export const yamlScheduledJobs: Rule = {
       }
       // If we don't parse the Liquid first, yaml loading chokes on {% raw %} tags
       const renderedYaml = await liquid.parseAndRender(token.content, context)
-      const yamlObj = yaml.load(renderedYaml) as YamlWorkflow
+      const yamlObj = load(renderedYaml) as YamlWorkflow
       if (!yamlObj.on) return
       if (!yamlObj.on.schedule) return
 

src/content-linter/scripts/find-unsed-variables.ts

@@ -17,7 +17,7 @@
  *
  */
 import fs from 'fs'
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 
 import { program } from 'commander'
 
@@ -108,7 +108,7 @@ function getVariables(): Map<string, string> {
   const variables = new Map<string, string>()
   for (const filePath of walkFiles('data/variables', '.yml')) {
     const dottedPathBase = `variables.${filePath.replace('data/variables/', '').replace('.yml', '').replace(/\//g, '.')}`
-    const data = yaml.load(fs.readFileSync(filePath, 'utf-8')) as Record<string, unknown>
+    const data = load(fs.readFileSync(filePath, 'utf-8')) as Record<string, unknown>
     for (const key of Object.keys(data)) {
       const dottedPath = `${dottedPathBase}.${key}`
       variables.set(dottedPath, filePath)

src/content-linter/style/base.ts

@@ -1,8 +1,8 @@
 import fs from 'fs'
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 
 const allowedCodeFenceLanguages = Object.keys(
-  yaml.load(fs.readFileSync('data/code-languages.yml', 'utf8')) as Record<string, unknown>,
+  load(fs.readFileSync('data/code-languages.yml', 'utf8')) as Record<string, unknown>,
 )
 
 type RuleConfig = {

src/content-linter/tests/lint-files.ts

@@ -1,6 +1,6 @@
 import { fileURLToPath } from 'url'
 import path from 'path'
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 import fs from 'fs/promises'
 
 import slash from 'slash'
@@ -253,14 +253,14 @@ if (ymlToLint.length === 0) {
         let isEarlyAccess: boolean
         let fileContents: string
         // This variable is used to determine if the file was parsed successfully.
-        // When `yaml.load()` fails to parse the file, it is overwritten with the error message.
+        // When `load()` fails to parse the file, it is overwritten with the error message.
         // `false` is intentionally chosen since `null` and `undefined` are valid return values.
         let dictionaryError: unknown = false
 
         beforeAll(async () => {
           fileContents = await fs.readFile(yamlAbsPath!, 'utf8')
           try {
-            dictionary = yaml.load(fileContents, { filename: yamlRelPath })
+            dictionary = load(fileContents, { filename: yamlRelPath })
           } catch (error) {
             dictionaryError = error
           }

src/content-pipelines/scripts/update.ts

@@ -19,7 +19,7 @@
 import { execSync, execFileSync } from 'child_process'
 import fs from 'fs'
 import path from 'path'
-import yaml from 'js-yaml'
+import { load } from 'js-yaml'
 import { program } from 'commander'
 
 // ---------------------------------------------------------------------------
@@ -39,10 +39,7 @@ const CONFIG_FILE = path.join(process.cwd(), 'src/content-pipelines/config.yml')
 
 function loadConfig(id: string): ContentPipelineConfig | null {
   if (!fs.existsSync(CONFIG_FILE)) return null
-  const raw = yaml.load(fs.readFileSync(CONFIG_FILE, 'utf-8')) as Record<
-    string,
-    ContentPipelineConfig
-  >
+  const raw = load(fs.readFileSync(CONFIG_FILE, 'utf-8')) as Record<string, ContentPipelineConfig>
   return raw[id] ?? null
 }