Initial commit

Author: CrispStrobe

.env.example

@@ -0,0 +1,30 @@
+# Usage: 
+# Copy this file as `.env` and fill in the variables below as instructed.
+
+# If you are developing more than one plugin, you can store the bin path and 
+# profile path in the system environment variables, which can be omitted here.
+
+# The path of the Zotero binary file.
+# The path delimiter should be escaped as `\\` for win32. 
+# The path is `*/Zotero.app/Contents/MacOS/zotero` for MacOS.
+ZOTERO_PLUGIN_ZOTERO_BIN_PATH = /path/to/zotero.exe
+
+# The path of the profile used for development.
+# Start the profile manager by `/path/to/zotero.exe -p` to create a profile for development.
+# @see https://www.zotero.org/support/kb/profile_directory
+ZOTERO_PLUGIN_PROFILE_PATH = /path/to/profile
+
+# The directory where the database is located.
+# If this field is kept empty, Zotero will start with the default data.
+# @see https://www.zotero.org/support/zotero_data
+ZOTERO_PLUGIN_DATA_DIR =
+
+# Custom commands to kill Zotero processes.
+# Commands for different platforms are already built into zotero-plugin, 
+# if the built-in commands are not suitable for your needs, please modify this variable.
+# ZOTERO_PLUGIN_KILL_COMMAND = 
+
+# GitHub Token
+# For scaffold auto create release and upload assets.
+# Fill in this variable if you are publishing locally instead of CI.
+# GITHUB_TOKEN =

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    groups:
+      all-non-major:
+        update-types:
+          - "minor"
+          - "patch"

.github/renovate.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended",
+    ":semanticPrefixChore",
+    ":prHourlyLimitNone",
+    ":prConcurrentLimitNone",
+    ":enableVulnerabilityAlerts",
+    ":dependencyDashboard",
+    "group:allNonMajor",
+    "schedule:weekly"
+  ],
+  "labels": ["dependencies"],
+  "packageRules": [
+    {
+      "matchPackageNames": [
+        "zotero-plugin-toolkit",
+        "zotero-types",
+        "zotero-plugin-scaffold"
+      ],
+      "schedule": ["at any time"],
+      "automerge": true
+    }
+  ],
+  "git-submodules": {
+    "enabled": true
+  }
+}

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GitHub_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install deps
+        run: |
+          npm install
+
+      - name: Run Lint
+        run: |
+          npm run lint:check
+
+  build:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GitHub_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install deps
+        run: |
+          npm install
+
+      - name: Run Build
+        run: |
+          npm run build
+
+      - name: Upload build result
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-result
+          path: |
+            build

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v**
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GitHub_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install deps
+        run: npm install
+
+      - name: Build
+        run: |
+          npm run build
+
+      - name: Release to GitHub
+        run: |
+          npm run release
+          sleep 1s
+
+      - name: Notify release
+        uses: apexskier/github-release-commenter@v1
+        continue-on-error: true
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          comment-template: |
+            :rocket: _This ticket has been resolved in {release_tag}. See {release_link} for release notes._

.gitignore

@@ -0,0 +1,16 @@
+# dot files
+.DS_Store
+
+# Node.js
+node_modules
+pnpm-lock.yaml
+yarn.lock
+
+# TSC
+tsconfig.tsbuildinfo
+
+# Scaffold
+.env
+.scaffold
+build
+logs

.prettierignore

@@ -0,0 +1,7 @@
+.vscode
+build
+logs
+node_modules
+package-lock.json
+yarn.lock
+pnpm-lock.yaml

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "macabeus.vscode-fluent"
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+  // 使用 IntelliSense 了解相关属性。
+  // 悬停以查看现有属性的描述。
+  // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Start",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run", "start"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Build",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run", "build"]
+    }
+  ]
+}