Skip to content

Remove yaml from theme (use js-yaml) #7721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
amcaplan wants to merge 1 commit into
base: main
Choose a base branch
from
+258 −293
Draft

Remove yaml from theme (use js-yaml) #7721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/replace-yaml-with-js-yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/theme': patch
---

Replace `yaml` dependency with `js-yaml` and replace `YAML.stringify` with `js-yaml`'s `dump`
3 changes: 2 additions & 1 deletion packages/theme/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@
"@shopify/cli-kit": "4.1.0",
"@shopify/theme-check-node": "3.25.0",
"@shopify/theme-language-server-node": "2.21.0",
"@types/js-yaml": "^4.0.9",
"chokidar": "3.6.0",
"h3": "1.15.9",
"yaml": "2.8.3"
"js-yaml": "^4.1.0"
},
"devDependencies": {
"@shopify/theme-hot-reload": "^0.0.22",
Expand Down
10 changes: 5 additions & 5 deletions packages/theme/src/cli/services/check.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
type Theme,
path as pathUtils,
} from '@shopify/theme-check-node'
import YAML from 'yaml'
import {dump} from 'js-yaml'

type OffenseMap = Record<string, Offense[]>

Expand Down Expand Up @@ -265,9 +265,9 @@ export async function initConfig(root: string) {
// The initialized config will extend the recommended settings and
// will simply show the commented checks for the user to customize.
const {settings} = await loadConfig(undefined, root)
const checksYml = commentString(YAML.stringify(settings))
const checksYml = commentString(dump(settings))

const initConfigYml = YAML.stringify({extends: 'theme-check:recommended', ignore: ['node_modules/**']})
const initConfigYml = dump({extends: 'theme-check:recommended', ignore: ['node_modules/**']})

await writeFile(filePath, `${initConfigYml}${checksYml}`)

Expand Down Expand Up @@ -301,7 +301,7 @@ export async function outputActiveConfig(themeRoot: string, configPath?: string,
...settings,
}
const output = environment ? {[environment]: config} : config
outputResult(YAML.stringify(output))
outputResult(dump(output))
}

export async function outputActiveChecks(root: string, configPath?: string, environment?: string) {
Expand Down Expand Up @@ -341,7 +341,7 @@ export async function outputActiveChecks(root: string, configPath?: string, envi
}, {})

const output = environment ? {[environment]: checksList} : checksList
outputResult(YAML.stringify(output))
outputResult(dump(output))
}

interface ExtendedWriteStream extends NodeJS.WriteStream {
Expand Down
Loading
Loading