Convert to TS project (#81)

.devcontainer/devcontainer.json

@@ -1,17 +1,17 @@
 {
-  "image": "mcr.microsoft.com/devcontainers/base",
+  "name": "Node.js",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:16",
+  "features": {
+    "ghcr.io/devcontainers-contrib/features/pnpm:2": {}
+  },
   "customizations": {
     "codespaces": {
       "openFiles": ["README.md", "CONTRIBUTING.md"]
     },
     "vscode": {
-      "extensions": [
-        "lizebang.bash-extension-pack",
-        "EditorConfig.EditorConfig",
-        "GitHub.vscode-github-actions"
-      ]
+      "extensions": ["EditorConfig.EditorConfig"]
     }
   },
-  // https://webinstall.dev/
-  "postCreateCommand": "curl -sS https://webi.sh/shfmt | sh && curl -sS https://webi.sh/shellcheck | sh"
+  "postCreateCommand": ".devcontainer/postCreate.sh",
+  "remoteUser": "node"
 }

.devcontainer/postCreate.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+pnpm i

.gitattributes

@@ -1,5 +1,2 @@
-action.yml linguist-detectable
-
-# This makes the newlines behave correctly in weird situations like running a
-# Windows-mounted CRLF file from within a WSL shell that expects LF.
-*.sh eol=lf
+dist/* binary
+tsconfig.json linguist-language=JSON-With-Comments

.github/workflows/check-dist.yml

@@ -0,0 +1,52 @@
+name: Check dist/
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "**.md"
+
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - "**.md"
+
+jobs:
+  check-dist:
+    name: Check dist/
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Rebuild dist/
+        run: |
+          pnpm build
+          pnpm package
+
+      - name: Compare diff
+        run: |
+          if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build. See status below:"
+            git diff
+            exit 1
+          fi
+        id: diff
+
+      - uses: actions/upload-artifact@v3
+        if: ${{ failure() && steps.diff.conclusion == 'failure' }}
+        with:
+          name: dist
+          path: dist/

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - run: pnpm build
+      - run: pnpm package
+      - name: Test
+        run: pnpm test
+
+      - name: Upload Coverage Report
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  format:
+    name: Check Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - run: pnpm format-check

.github/workflows/test.yml → .github/workflows/dogfood.yml

@@ -1,19 +1,19 @@
-name: Test
+name: Dogfood Test
 on:
   push:
     branches: [main]
     paths:
-      - 'src/**'
-      -  action.yml
-      -  '.github/wiki/**'
-      - '.github/workflows/test.yml'
+      - "src/**"
+      - action.yml
+      - ".github/wiki/**"
+      - ".github/workflows/test.yml"
   pull_request:
     branches: [main]
     paths:
-      - 'src/**'
-      -  action.yml
-      -  '.github/wiki/**'
-      - '.github/workflows/test.yml'
+      - "src/**"
+      - action.yml
+      - ".github/wiki/**"
+      - ".github/workflows/test.yml"
 # We don't want cancel-in-progress because we want each test (if there are
 # multiple at a given time) to still attempt to push to the wiki. This should
 # not cause any hiccups on the wiki since any and all tests are publishing in
@@ -30,7 +30,5 @@ jobs:
         run: 'git log -1 --format="%H" > .github/wiki/Rev.md'
       - uses: ./
         with:
-          # For now, you'll need to manually specify a GitHub token until we
-          # solve #2. The x: prefix is a dummy username.
-          token: x:${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
           dry-run: ${{ github.ref != 'main' }}

.github/workflows/update-tags.yml

@@ -1,16 +1,16 @@
-name: Update tags
-on:
-  release:
-    types: [released]
-concurrency:
-  group: update-tags
-  cancel-in-progress: true
-permissions:
-  contents: write
-jobs:
-  update-tags:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/[email protected]
-        with:
-          source-tag: ${{ github.event.release.tag_name }}
+name: Update tags
+on:
+  release:
+    types: [released]
+concurrency:
+  group: update-tags
+  cancel-in-progress: true
+permissions:
+  contents: write
+jobs:
+  update-tags:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          source-tag: ${{ github.event.release.tag_name }}

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+/lib/
+/coverage/

.prettierignore

@@ -0,0 +1,5 @@
+/node_modules/
+/coverage/
+/dist/
+/lib/
+pnpm-lock.yaml

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 88,
+  "trailingComma": "all"
+}

CONTRIBUTING.md

@@ -1,37 +1,35 @@
-**Thanks for taking the time to contribute! ❤️**
-
-All types of contributions are encouraged and valued, no matter if it's a bug
-report 🐛, a feature request 💡, or a Pull Request 🚀.
-
-- **❓ I have a question:** [Open a Q&A Discussion]
-- **🐛 I found a bug:** [Open an Issue]
-- **💡 I have an idea:** [Open an Idea Discussion]
-- **💻 I want to code:** See below
-
-## Contributing code
-
-1. 🔀 Fork the repo
-2. 💻 Open the repo in your editor
-3. 👨‍💻 Add your changes to your workspace
-4. 🔖 Commit & push your changes
-5. 🔁 Open a PR to get your changes merged
-6. 🧪 Let the tests run to make sure everything works
-7. 🚀 Profit!
-
-🚀 For a seamless coding experience, we recommend using VS Code or GitHub
-Codespaces as your editor! With VS Code's extensions and customizable settings,
-you can tailor your environment to suit your preferences. 🌟 Plus, for GitHub
-Codespaces users, we provide a `devcontainer.json` config for a ready-to-use
-development environment. 🛠️ Enhance your coding productivity and enjoyment with
-these powerful editors! 😊
-
-We use [EditorConfig] to specify the spacing and file conventions for this
-project. Make sure you _try_ to conform with it. Editors like VS Code have
-extensions that will do this automatically for you! 😉
-
-<!-- prettier-ignore-start -->
-[open an issue]: https://github.com/spenserblack/actions-wiki/issues/new
-[open a Q&A discussion]: https://github.com/spenserblack/actions-wiki/discussions/new?category=q-a
-[open an idea discussion]: https://github.com/spenserblack/actions-wiki/discussions/new?category=ideas
-[editorconfig]: https://editorconfig.org/
-<!-- prettier-ignore-end -->
+**Thanks for taking the time to contribute! ❤️**
+
+All types of contributions are encouraged and valued, no matter if it's a bug
+report 🐛, a feature request 💡, or a Pull Request 🚀.
+
+- **❓ I have a question:** [Open a Q&A Discussion][new-qa]
+- **🐛 I found a bug:** [Open an Issue][new-issue]
+- **💡 I have an idea:** [Open an Idea Discussion][new-idea]
+- **💻 I want to code:** See below
+
+## Contributing code
+
+1. 🔀 Fork the repo
+2. 💻 Open the repo in your editor
+3. 👨‍💻 Add your changes to your workspace
+4. 🔖 Commit & push your changes
+5. 🔁 Open a PR to get your changes merged
+6. 🧪 Let the tests run to make sure everything works
+7. 🚀 Profit!
+
+🚀 For a seamless coding experience, we recommend using VS Code or GitHub
+Codespaces as your editor! With VS Code's extensions and customizable settings,
+you can tailor your environment to suit your preferences. 🌟 Plus, for GitHub
+Codespaces users, we provide a `devcontainer.json` config for a ready-to-use
+development environment. 🛠️ Enhance your coding productivity and enjoyment with
+these powerful editors! 😊
+
+We use [EditorConfig][editorconfig] to specify the spacing and file conventions for this
+project. Make sure you _try_ to conform with it. Editors like VS Code have
+extensions that will do this automatically for you! 😉
+
+[new-issue]: https://github.com/spenserblack/actions-wiki/issues/new
+[new-qa]: https://github.com/spenserblack/actions-wiki/discussions/new?category=q-a
+[new-idea]: https://github.com/spenserblack/actions-wiki/discussions/new?category=ideas
+[editorconfig]: https://editorconfig.org/

README.md

@@ -10,7 +10,7 @@
 
 </div>
 
-🌐 Works across repositories (with a [PAT]) \
+🌐 Works across repositories (with a [PAT][pat]) \
 📚 Pretty interface for Markdown docs \
 ⤴️ Lets you open PRs for wiki docs \
 💻 Supports `runs-on: windows-*`
@@ -55,13 +55,13 @@ that powers the GitHub wiki. If you don't, when we push to `your-repo.wiki.git`,
 your workflow will fail because the wiki doesn't exist.
 
 ⚠️ You'll need to remember to enable the `contents: write` permission! GitHub
-recently [changed the default permissions granted to jobs] for new repositories.
+recently [changed the default permissions granted to jobs][default-permissions-update] for new repositories.
 
 ### Publishing to a different repository
 
 If you're pushing to a wiki that's **not the current repository** you'll need to
-get a [GitHub PAT] to push to it. The default `${{ secrets.GITHUB_TOKEN }}`
-won't cut it! You can [generate a PAT] in your GitHub Settings.
+get a [GitHub PAT][pat] to push to it. The default `${{ secrets.GITHUB_TOKEN }}`
+won't cut it! You can [generate a PAT][generate-a-pat] in your GitHub Settings.
 
 For example, if you created octocat/gigantic-mega-project-wiki to hold the wiki
 and you want to publish it to the GitHub wiki that belongs to _another
@@ -103,41 +103,34 @@ one of your GitHub Actions workflows.
 
 ## Alternatives
 
-There are quite a few GitHub wiki publishing actions on the [GitHub Actions
-marketplace]. There are, however, two that stick out. The
-[newrelic/wiki-sync-action] is a good choice for if you need bidirectional
+There are quite a few GitHub wiki publishing actions on the [GitHub Actions marketplace][actions-marketplace]. There are, however, two that stick out. The
+[newrelic/wiki-sync-action][newrelic-action] is a good choice for if you need bidirectional
 synchronization when someone edits the live wiki. This can be beneficial for
-less-technical contributors. There's also [Andrew-Chen-Wang/github-wiki-action]
+less-technical contributors. There's also [Andrew-Chen-Wang/github-wiki-action][andrew-chen-wang-action]
 which is a direct competitor to this project. It offers more automatic features,
-but has more complex configuration. It also [doesn't support `runs-on:
-windows-*`].
+but has more complex configuration. It also [doesn't support `runs-on: windows-*`](https://github.com/Andrew-Chen-Wang/github-wiki-action/discussions/28).
 
-📚 If you're interested in more discussion of alternatives, check out [#4].
+📚 If you're interested in more discussion of alternatives, check out [#4][issue-4].
 
 ## Development
 
 ![YAML](https://img.shields.io/static/v1?style=for-the-badge&message=YAML&color=CB171E&logo=YAML&logoColor=FFFFFF&label=)
 ![Bash](https://img.shields.io/static/v1?style=for-the-badge&message=Bash&color=4EAA25&logo=GNU+Bash&logoColor=FFFFFF&label=)
 
-This is a GitHub Action, so we inevitably use YAML[^1]. Make sure you quote the
+This is a GitHub Action, so we inevitably use [YAML][yaml-notes]. Make sure you quote the
 right things! To test 🧪 the action, the current workflow is to open a PR and
-then have the [`test.yml`] workflow run a `dry-run: true` iteration to
+then have the [`test.yml`](https://github.com/spenserblack/actions-wiki/blob/main/.github/workflows/test.yml) workflow run a `dry-run: true` iteration to
 (hopefully) spot any flaws.
 
 To get a better handle on the contribution process, check out our handy
-[contributing guide]. Happy coding! 👋
-
-<!-- prettier-ignore-start -->
-[newrelic/wiki-sync-action]: https://github.com/newrelic/wiki-sync-action#readme
-[Andrew-Chen-Wang/github-wiki-action]: https://github.com/Andrew-Chen-Wang/github-wiki-action#readme
-[#4]: https://github.com/spenserblack/actions-wiki/issues/4
-[PAT]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
-[GitHub PAT]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
-[changed the default permissions granted to jobs]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/
-[github actions marketplace]: https://github.com/marketplace?type=actions
-[generate a pat]: https://github.com/settings/tokens?type=beta
-[doesn't support `runs-on: windows-*`]: https://github.com/Andrew-Chen-Wang/github-wiki-action/discussions/28
-[contributing guide]: https://github.com/spenserblack/actions-wiki/blob/main/CONTRIBUTING.md
-[`test.yml`]: https://github.com/spenserblack/actions-wiki/blob/main/.github/workflows/test.yml
-[^1]: https://earthly.dev/blog/intercal-yaml-and-other-horrible-programming-languages/
-<!-- prettier-ignore-end -->
+[contributing guide][contributing]. Happy coding! 👋
+
+[newrelic-action]: https://github.com/newrelic/wiki-sync-action#readme
+[andrew-chen-wang-action]: https://github.com/Andrew-Chen-Wang/github-wiki-action#readme
+[issue-4]: https://github.com/spenserblack/actions-wiki/issues/4
+[pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
+[default-permissions-update]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/
+[actions-marketplace]: https://github.com/marketplace?type=actions
+[generate-a-pat]: https://github.com/settings/tokens?type=beta
+[contributing]: https://github.com/spenserblack/actions-wiki/blob/main/CONTRIBUTING.md
+[yaml-notes]: https://earthly.dev/blog/intercal-yaml-and-other-horrible-programming-languages/