feat: setup the template

Author: Nauxscript

.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "@antfu",
+  "rules": {
+    "@typescript-eslint/no-var-requires": "off"
+  }
+}

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+      - 'test*'
+
+jobs:
+  release:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Build
+        run: |
+          npm install
+          npm run build
+      - name: Setup release files
+        run: ./build.sh
+
+      - name: Release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: ./dist/your-workflow-name.alfredworkflow
+          token: ${{ secrets.G_TOKEN }}
+
+      - run: npx changelogithub # or changelogithub@0.12 if ensure the stable result
+        env:
+          GITHUB_TOKEN: ${{secrets.G_TOKEN}}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  }
+}

README.md

@@ -1,2 +1,24 @@
 # alfred-workflow-ts-template
-template for building a alfred workflow in TypeScript.
+a Template for building a alfred workflow in TypeScript.
+
+## Features
+
+- 🦾 TypeScript, of course
+- ⚙️ Unit Testing with [Vitest](https://github.com/vitest-dev/vitest)
+- [Unbuild](https://github.com/unjs/unbuild), a unified javascript build system 
+- JXA Types, supported by [@jxa/global-type](https://github.com/JXA-userland/JXA/tree/master/packages/@jxa/global-type)
+- Eslint
+- pnpm
+
+## Usage
+
+- modify the `package.json`
+- modify the `artifacts` value in `.github/workflows/release.yml`
+- filled in the workflow info in `src/update.sh`
+- generate your `info.plist` & `icon.png`
+
+## Preview
+
+# License
+
+[MIT](./LICENSE) License © 2022 [Nauxscript](https://github.com/Nauxscript)

build.config.ts

@@ -0,0 +1,24 @@
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  entries: [
+    './src/index',
+  ],
+  hooks: {
+    'rollup:options': (ctx, option) => {
+      (Array.isArray(option.output)) && option.output.push(
+        {
+          name: 'run',
+          dir: ctx.options.outDir,
+          format: 'iife',
+          exports: 'auto',
+          generatedCode: {
+            constBindings: true,
+          },
+          externalLiveBindings: false,
+          freeze: false,
+        },
+      )
+    },
+  },
+})

build.sh

@@ -0,0 +1,42 @@
+
+
+# /bin/bash
+
+# if any return not equal to true, process will quit.
+# refer to https://www.zhizhesoft.com/unix-linux-jiao-ben-zhong-set-e-de-zuo-yong/
+set -e
+
+# refer to https://blog.csdn.net/qq_20417499/article/details/103308076
+# this script's parent directory
+cd $(dirname $0)
+parentDir=$(pwd)
+
+cd dist
+echo "setup files ..."
+cp ${parentDir}/src/info.plist ./ 
+cp ${parentDir}/src/icon.png ./ 
+cp ${parentDir}/README.md ./ 
+cp ${parentDir}/LICENSE ./ 
+
+rm ./index.mjs
+
+# insert the vesion to .plist file, if you need
+echo "Updating version ..."
+curVersion=$(node -e "console.log(require('${parentDir}/package.json').version)")
+sed -i '' 's/{{version}}/'${curVersion}'/' ./info.plist
+
+# insert the readme content in src dir to .plist file, if you need
+echo "Injecting readme ..."
+readme="${parentDir}/src/README.md"
+sed -i '' -e "/{{readme}}/{r ${readme}" -e 'd' -e '}' ./info.plist
+
+# insert the auto-update to .plist file, if you need, and you need to fill in the workflow info in that file
+echo "Injecting auto-update script ..."
+update="$(mktemp)"
+# s/&/\&amp;/g; s/</\&lt;/g; s/>/\&gt;/g this pattern is use for repalcing '&' '<' '>'
+cat ${parentDir}/src/update.sh | sed 's/&/\&amp;/g; s/</\&lt;/g; s/>/\&gt;/g' > ${update}
+sed -i '' -e "/{{update_script}}/{r ${update}" -e 'd' -e '}' ./info.plist
+ 
+echo "Bundling workflow ..."
+name=$(node -e "console.log(require('${parentDir}/package.json').name)")
+zip -Z deflate -rq9 ${parentDir}/dist/${name}.alfredworkflow * -x etc

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "your-workflow-name",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "lint:fix": "eslint . --fix",
+    "test": "vitest",
+    "build": "unbuild",
+    "release": "bumpp package.json --commit --push --tag ",
+    "release:test": "pnpm build && ./build.sh"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@antfu/eslint-config": "^0.33.1",
+    "@jxa/global-type": "^1.3.6",
+    "@types/node": "^18.11.10",
+    "bumpp": "^8.2.1",
+    "eslint": "^8.29.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3",
+    "unbuild": "^1.0.1",
+    "vitest": "^0.25.3"
+  },
+  "peerDependencies": {
+    "@jxa/global-type": "^1.3.6"
+  }
+}