Add Prettier

.github/workflows/ci.yml

@@ -11,8 +11,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/checkout@v4
         with:
-          repository: "shopify/dawn"
-          path: "./dawn"
+          repository: 'shopify/dawn'
+          path: './dawn'
 
       - name: Theme Check
         uses: ./
@@ -28,8 +28,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/checkout@v4
         with:
-          repository: "shopify/dawn"
-          path: "./dawn"
+          repository: 'shopify/dawn'
+          path: './dawn'
 
       - name: Theme Check
         uses: ./
@@ -45,8 +45,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/checkout@v4
         with:
-          repository: "shopify/dawn"
-          path: "./dawn"
+          repository: 'shopify/dawn'
+          path: './dawn'
           ref: 'v6.0.0'
 
       - name: Theme Check
@@ -64,8 +64,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/checkout@v4
         with:
-          repository: "shopify/dawn"
-          path: "./dawn"
+          repository: 'shopify/dawn'
+          path: './dawn'
           ref: 'v6.0.0'
 
       - name: Theme Check

.prettierignore

@@ -0,0 +1,4 @@
+dist
+yarn.lock
+CODE_OF_CONDUCT.md
+LICENSE.md

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

CHANGELOG.md

@@ -1,66 +1,54 @@
+# v2.1.2 / 2024-05-10
 
-v2.1.2 / 2024-05-10
-==================
+- Don't install `@shopify/theme` from v3.59 onward
+- Allow for experimental CLI versions
 
-  * Don't install `@shopify/theme` from v3.59 onward
-  * Allow for experimental CLI versions
+# v2.1.1 / 2024-04-04
 
-v2.1.1 / 2024-04-04
-==================
+- Revert "Add direct support for bun, pnpm and yarn" -- issues with pnpm
 
-  * Revert "Add direct support for bun, pnpm and yarn" -- issues with pnpm
+# v2.1.0 / 2024-04-04
 
-v2.1.0 / 2024-04-04
-==================
+- Add support for different package managers (thank you @andershagbard)
 
-  * Add support for different package managers (thank you @andershagbard)
+# v2.0.1 / 2024-02-14
 
-v2.0.1 / 2024-02-14
-==================
+- Don't pass the `--dev-preview` flag for Shopify CLI versions >= 3.55.0
 
-  * Don't pass the `--dev-preview` flag for Shopify CLI versions >= 3.55.0
+# v2.0.0 / 2024-01-05
 
-v2.0.0 / 2024-01-05
-===================
+- Theme Check 2.0 and Shopify CLI 3.50+ support
+- Remove support for Ruby Theme Check (v1)
 
-  * Theme Check 2.0 and Shopify CLI 3.50+ support
-  * Remove support for Ruby Theme Check (v1)
+# v1.3.1 / 2024-01-05
 
-v1.3.1 / 2024-01-05
-===================
+- Merge pull request #29 from snacsnoc/update-checkout-v3-node16-compatibility
+- Update ci.yml to use checkout@v3
+- Update README.md to reflect upgrade to checkout@v3
 
-  * Merge pull request #29 from snacsnoc/update-checkout-v3-node16-compatibility
-  * Update ci.yml to use checkout@v3
-  * Update README.md to reflect upgrade to checkout@v3
+# v1.3.0 / 2023-11-28
 
-v1.3.0 / 2023-11-28
-===================
+- Run Theme Check with the most updated version of objects, filters, and tags ([#19](https://github.com/Shopify/theme-check-action/pull/19))
 
-  * Run Theme Check with the most updated version of objects, filters, and tags ([#19](https://github.com/Shopify/theme-check-action/pull/19))
-
-v1.2.0 / 2022-02-28
-===================
+# v1.2.0 / 2022-02-28
 
 ## Features
 
-  * Add support to only annotate files with diffs in them ([#3](https://github.com/shopify/theme-check-action/issues/3), [#9](https://github.com/shopify/theme-check-action/issues/9))
-  * Add the `base` input argument
+- Add support to only annotate files with diffs in them ([#3](https://github.com/shopify/theme-check-action/issues/3), [#9](https://github.com/shopify/theme-check-action/issues/9))
+- Add the `base` input argument
 
-v1.1.1 / 2022-02-28
-===================
+# v1.1.1 / 2022-02-28
 
-  * Throttle the requests to respect the rate limits ([#8](https://github.com/shopify/theme-check-action/issues/8))
-  * GH Actions Checks: Submit the checks in batches ([#7](https://github.com/shopify/theme-check-action/issues/7))
+- Throttle the requests to respect the rate limits ([#8](https://github.com/shopify/theme-check-action/issues/8))
+- GH Actions Checks: Submit the checks in batches ([#7](https://github.com/shopify/theme-check-action/issues/7))
 
-v1.1.0 / 2022-02-25
-===================
+# v1.1.0 / 2022-02-25
 
 ## Features
 
-  * Add GitHub Annotation support
-  * Add the `token` input argument
+- Add GitHub Annotation support
+- Add the `token` input argument
 
-v1.0.0 / 2021-07-08
-===================
+# v1.0.0 / 2021-07-08
 
-  * Initial release
+- Initial release

CONTRIBUTING.md

@@ -4,9 +4,9 @@ We love receiving pull requests!
 
 ## Standards
 
-* PR should explain what the feature does, and why the change exists.
-* PR should include any carrier specific documentation explaining how it works.
-* Code should be generic and reusable.
+- PR should explain what the feature does, and why the change exists.
+- PR should include any carrier specific documentation explaining how it works.
+- Code should be generic and reusable.
 
 ## How to contribute
 

README.md

@@ -38,8 +38,8 @@ jobs:
 
 `shopify/theme-check-action@v2` accepts the following arguments:
 
-* `theme_root` - (optional, default: `'.'`) Path from repo root to the root of the theme (e.g. `'./dist'`).
-* `flags` - (optional) theme-check command line flags. (e.g. `'--fail-level suggestion'`)
-* `version` - (optional, default: latest) specific [Shopify CLI](https://shopify.dev/docs/storefronts/themes/tools/cli) `@shopify/theme` (`v3.50`+) to use.
-* `token` - (optional) result of `${{ github.token }}` to enable GitHub check annotations.
-* `base` - (optional) When `token` is set, only the files that contain a diff with this ref (branch, tag or commit) will have GitHub check annotations.
+- `theme_root` - (optional, default: `'.'`) Path from repo root to the root of the theme (e.g. `'./dist'`).
+- `flags` - (optional) theme-check command line flags. (e.g. `'--fail-level suggestion'`)
+- `version` - (optional, default: latest) specific [Shopify CLI](https://shopify.dev/docs/storefronts/themes/tools/cli) `@shopify/theme` (`v3.50`+) to use.
+- `token` - (optional) result of `${{ github.token }}` to enable GitHub check annotations.
+- `base` - (optional) When `token` is set, only the files that contain a diff with this ref (branch, tag or commit) will have GitHub check annotations.

RELEASING.md

@@ -4,38 +4,38 @@
 
 2. Make sure you are on main
 
-  ```sh
-  git fetch origin main
-  git checkout main
-  git reset --hard origin/main
-  ```
+```sh
+git fetch origin main
+git checkout main
+git reset --hard origin/main
+```
 
 3. Update the changelog using the git-extra's [`git changelog`](https://github.com/tj/git-extras).
 
-  ```sh
-  git changelog
-  ```
+```sh
+git changelog
+```
 
 4. Commit and push the changelog update (to main, it's OK)
 
-  ```sh
-  git add CHANGELOG.md
-  git commit -m "Update CHANGELOG.md"
-  git push origin main
-  ```
+```sh
+git add CHANGELOG.md
+git commit -m "Update CHANGELOG.md"
+git push origin main
+```
 
 5. Set the version number, and release the tag (and rerelease the minor tag, and update the major branch)
 
-  ```sh
-  export VERSION=v2.X.X
-  scripts/release $VERSION
-  ```
+```sh
+export VERSION=v2.X.X
+scripts/release $VERSION
+```
 
 6. Create a GitHub release for the changes
 
-  ```sh
-  git fetch origin
-  git fetch origin --tags
-  git reset origin $VERSION
-  gh release create -t $VERSION
-  ```
+```sh
+git fetch origin
+git fetch origin --tags
+git reset origin $VERSION
+gh release create -t $VERSION
+```

package.json

@@ -5,13 +5,16 @@
     "step:install": "scripts/run-step installCli",
     "step:check:json": "scripts/run-step runChecksJson",
     "step:check:text": "scripts/run-step runChecksText",
-    "step:config": "scripts/run-step getConfigContents"
+    "step:config": "scripts/run-step getConfigContents",
+    "format": "prettier . --write"
   },
   "devDependencies": {
+    "@octokit/webhooks-types": "^7.6.1",
     "@types/common-tags": "^1.8.1",
     "@types/node": "10.17.60",
     "@types/semver": "^7.5.6",
     "@vercel/ncc": "^0.38.1",
+    "prettier": "^3.5.3",
     "ts-node": "^10.9.2",
     "typescript": "^4.5.5"
   },

scripts/run-step

@@ -9,18 +9,12 @@ async function run() {
     process.exit(1);
   }
 
-  const step = require(path.join(
-    __dirname,
-    '..',
-    'src',
-    'steps',
-    stepName,
-  ))[stepName];
+  const step = require(path.join(__dirname, '..', 'src', 'steps', stepName))[
+    stepName
+  ];
   const result = await step(...args);
   console.log(
-    typeof result === 'string'
-      ? result
-      : JSON.stringify(result, null, 2),
+    typeof result === 'string' ? result : JSON.stringify(result, null, 2),
   );
 }