feat: 新增 BlogFlare Obsidian 插件用于文章同步与发布
This commit is contained in:
seahi committed
1 parent
cf7168d786
commit
4cf1b3ee4f
22 files changed
+6326
No files matched your search
@@ -0,0 +1,11 @@
|
|||||||
|
# top-most EditorConfig file
|
||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
charset = utf-8
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = true
|
||||||
|
indent_style = tab
|
||||||
|
indent_size = 4
|
||||||
|
quote_type = single
|
||||||
|
tab_width = 4
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
name: Node.js build
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: ['**']
|
||||||
|
pull_request:
|
||||||
|
branches: ['**']
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
node-version: [20.x, 22.x, 24.x]
|
||||||
|
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
cache: 'npm'
|
||||||
|
- run: npm ci
|
||||||
|
- run: npm run build --if-present
|
||||||
|
- run: npm run lint
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
name: Release Obsidian plugin
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
id-token: write
|
||||||
|
attestations: write
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Use Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
with:
|
||||||
|
node-version: 24
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Build plugin
|
||||||
|
run: |
|
||||||
|
npm ci
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
- name: Check for optional styles
|
||||||
|
id: styles
|
||||||
|
run: |
|
||||||
|
[ -f styles.css ] && echo "exists=true" >> "$GITHUB_OUTPUT" || echo "exists=false" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Attest build provenance
|
||||||
|
uses: actions/attest@v4
|
||||||
|
with:
|
||||||
|
subject-path: |
|
||||||
|
main.js
|
||||||
|
${{ steps.styles.outputs.exists == 'true' && 'styles.css' || '' }}
|
||||||
|
|
||||||
|
- name: Create release
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run: |
|
||||||
|
tag="${GITHUB_REF#refs/tags/}"
|
||||||
|
|
||||||
|
gh release create "$tag" \
|
||||||
|
--title="$tag" \
|
||||||
|
--draft \
|
||||||
|
main.js manifest.json ${{ steps.styles.outputs.exists == 'true' && 'styles.css' || '' }}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# vscode
|
||||||
|
.vscode
|
||||||
|
|
||||||
|
# Intellij
|
||||||
|
*.iml
|
||||||
|
.idea
|
||||||
|
|
||||||
|
# npm
|
||||||
|
node_modules
|
||||||
|
|
||||||
|
# Don't include the compiled main.js file in the repo.
|
||||||
|
# They should be uploaded to GitHub releases instead.
|
||||||
|
main.js
|
||||||
|
|
||||||
|
# Exclude sourcemaps
|
||||||
|
*.map
|
||||||
|
|
||||||
|
# obsidian
|
||||||
|
data.json
|
||||||
|
|
||||||
|
# Exclude macOS Finder (System Explorer) View States
|
||||||
|
.DS_Store
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
tag-version-prefix=""
|
||||||
@@ -0,0 +1,269 @@
|
|||||||
|
# Obsidian community plugin
|
||||||
|
|
||||||
|
## Project overview
|
||||||
|
|
||||||
|
- Target: Obsidian Community Plugin (TypeScript → bundled JavaScript).
|
||||||
|
- Entry point: `src/main.ts` compiled to `main.js` and loaded by Obsidian.
|
||||||
|
- Required release artifacts: `main.js`, `manifest.json`, and optional `styles.css`.
|
||||||
|
|
||||||
|
## Environment & tooling
|
||||||
|
|
||||||
|
- Node.js: use current LTS (Node 18+ recommended).
|
||||||
|
- **Package manager: npm** (required for this sample - `package.json` defines npm scripts and dependencies).
|
||||||
|
- **Bundler: esbuild** (required for this sample - `esbuild.config.mjs` and build scripts depend on it). Alternative bundlers like Rollup or webpack are acceptable for other projects if they bundle all external dependencies into `main.js`.
|
||||||
|
- Types: `obsidian` type definitions.
|
||||||
|
|
||||||
|
**Note**: This sample project has specific technical dependencies on npm and esbuild. If you're creating a plugin from scratch, you can choose different tools, but you'll need to replace the build configuration accordingly.
|
||||||
|
|
||||||
|
### Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Dev (watch)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### Production build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Linting
|
||||||
|
|
||||||
|
- ESLint is preconfigured with `eslint-plugin-obsidianmd` for Obsidian-specific rules.
|
||||||
|
- Run `npm run lint` to lint the project.
|
||||||
|
- A GitHub Action automatically lints every commit on all branches.
|
||||||
|
|
||||||
|
## File & folder conventions
|
||||||
|
|
||||||
|
- **Organize code into multiple files**: Split functionality across separate modules rather than putting everything in `main.ts`.
|
||||||
|
- Source lives in `src/`. Keep `main.ts` small and focused on plugin lifecycle (loading, unloading, registering commands).
|
||||||
|
- **Example file structure**:
|
||||||
|
```
|
||||||
|
src/
|
||||||
|
main.ts # Plugin entry point, lifecycle management
|
||||||
|
settings.ts # Settings interface and defaults
|
||||||
|
commands/ # Command implementations
|
||||||
|
command1.ts
|
||||||
|
command2.ts
|
||||||
|
ui/ # UI components, modals, views
|
||||||
|
modal.ts
|
||||||
|
view.ts
|
||||||
|
utils/ # Utility functions, helpers
|
||||||
|
helpers.ts
|
||||||
|
constants.ts
|
||||||
|
types.ts # TypeScript interfaces and types
|
||||||
|
```
|
||||||
|
- **Do not commit build artifacts**: Never commit `node_modules/`, `main.js`, or other generated files to version control.
|
||||||
|
- Keep the plugin small. Avoid large dependencies. Prefer browser-compatible packages.
|
||||||
|
- Generated output should be placed at the plugin root or `dist/` depending on your build setup. Release artifacts must end up at the top level of the plugin folder in the vault (`main.js`, `manifest.json`, `styles.css`).
|
||||||
|
|
||||||
|
## Manifest rules (`manifest.json`)
|
||||||
|
|
||||||
|
- Must include (non-exhaustive):
|
||||||
|
- `id` (plugin ID; for local dev it should match the folder name)
|
||||||
|
- `name`
|
||||||
|
- `version` (Semantic Versioning `x.y.z`)
|
||||||
|
- `minAppVersion`
|
||||||
|
- `description`
|
||||||
|
- `isDesktopOnly` (boolean)
|
||||||
|
- Optional: `author`, `authorUrl`, `fundingUrl` (string or map)
|
||||||
|
- Never change `id` after release. Treat it as stable API.
|
||||||
|
- Keep `minAppVersion` accurate when using newer APIs.
|
||||||
|
- Canonical requirements are coded here: https://github.com/obsidianmd/obsidian-releases/blob/master/.github/workflows/validate-plugin-entry.yml
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
- Manual install for testing: copy `main.js`, `manifest.json`, `styles.css` (if any) to:
|
||||||
|
```
|
||||||
|
<Vault>/.obsidian/plugins/<plugin-id>/
|
||||||
|
```
|
||||||
|
- Reload Obsidian and enable the plugin in **Settings → Community plugins**.
|
||||||
|
|
||||||
|
## Commands & settings
|
||||||
|
|
||||||
|
- Any user-facing commands should be added via `this.addCommand(...)`.
|
||||||
|
- If the plugin has configuration, provide a settings tab and sensible defaults.
|
||||||
|
- Persist settings using `this.loadData()` / `this.saveData()`.
|
||||||
|
- Use stable command IDs; avoid renaming once released.
|
||||||
|
|
||||||
|
## Versioning & releases
|
||||||
|
|
||||||
|
- Bump `version` in `manifest.json` (SemVer) and update `versions.json` to map plugin version → minimum app version.
|
||||||
|
- Create a GitHub release whose tag exactly matches `manifest.json`'s `version`. Do not use a leading `v`.
|
||||||
|
- Attach `manifest.json`, `main.js`, and `styles.css` (if present) to the release as individual assets.
|
||||||
|
- After the initial release, follow the process to add/update your plugin in the community catalog as required.
|
||||||
|
|
||||||
|
## Security, privacy, and compliance
|
||||||
|
|
||||||
|
Follow Obsidian's **Developer Policies** and **Plugin Guidelines**. In particular:
|
||||||
|
|
||||||
|
- Default to local/offline operation. Only make network requests when essential to the feature.
|
||||||
|
- No hidden telemetry. If you collect optional analytics or call third-party services, require explicit opt-in and document clearly in `README.md` and in settings.
|
||||||
|
- Never execute remote code, fetch and eval scripts, or auto-update plugin code outside of normal releases.
|
||||||
|
- Minimize scope: read/write only what's necessary inside the vault. Do not access files outside the vault.
|
||||||
|
- Clearly disclose any external services used, data sent, and risks.
|
||||||
|
- Respect user privacy. Do not collect vault contents, filenames, or personal information unless absolutely necessary and explicitly consented.
|
||||||
|
- Avoid deceptive patterns, ads, or spammy notifications.
|
||||||
|
- Register and clean up all DOM, app, and interval listeners using the provided `register*` helpers so the plugin unloads safely.
|
||||||
|
|
||||||
|
## UX & copy guidelines (for UI text, commands, settings)
|
||||||
|
|
||||||
|
- Prefer sentence case for headings, buttons, and titles.
|
||||||
|
- Use clear, action-oriented imperatives in step-by-step copy.
|
||||||
|
- Use **bold** to indicate literal UI labels. Prefer "select" for interactions.
|
||||||
|
- Use arrow notation for navigation: **Settings → Community plugins**.
|
||||||
|
- Keep in-app strings short, consistent, and free of jargon.
|
||||||
|
|
||||||
|
## Performance
|
||||||
|
|
||||||
|
- Keep startup light. Defer heavy work until needed.
|
||||||
|
- Avoid long-running tasks during `onload`; use lazy initialization.
|
||||||
|
- Batch disk access and avoid excessive vault scans.
|
||||||
|
- Debounce/throttle expensive operations in response to file system events.
|
||||||
|
|
||||||
|
## Coding conventions
|
||||||
|
|
||||||
|
- TypeScript with `"strict": true` preferred.
|
||||||
|
- **Keep `main.ts` minimal**: Focus only on plugin lifecycle (onload, onunload, addCommand calls). Delegate all feature logic to separate modules.
|
||||||
|
- **Split large files**: If any file exceeds ~200-300 lines, consider breaking it into smaller, focused modules.
|
||||||
|
- **Use clear module boundaries**: Each file should have a single, well-defined responsibility.
|
||||||
|
- Bundle everything into `main.js` (no unbundled runtime deps).
|
||||||
|
- Avoid Node/Electron APIs if you want mobile compatibility; set `isDesktopOnly` accordingly.
|
||||||
|
- Prefer `async/await` over promise chains; handle errors gracefully.
|
||||||
|
|
||||||
|
## Mobile
|
||||||
|
|
||||||
|
- Where feasible, test on iOS and Android.
|
||||||
|
- Don't assume desktop-only behavior unless `isDesktopOnly` is `true`.
|
||||||
|
- Avoid large in-memory structures; be mindful of memory and storage constraints.
|
||||||
|
|
||||||
|
## Agent do/don't
|
||||||
|
|
||||||
|
**Do**
|
||||||
|
|
||||||
|
- Add commands with stable IDs (don't rename once released).
|
||||||
|
- Provide defaults and validation in settings.
|
||||||
|
- Write idempotent code paths so reload/unload doesn't leak listeners or intervals.
|
||||||
|
- Use `this.register*` helpers for everything that needs cleanup.
|
||||||
|
|
||||||
|
**Don't**
|
||||||
|
|
||||||
|
- Introduce network calls without an obvious user-facing reason and documentation.
|
||||||
|
- Ship features that require cloud services without clear disclosure and explicit opt-in.
|
||||||
|
- Store or transmit vault contents unless essential and consented.
|
||||||
|
|
||||||
|
## Common tasks
|
||||||
|
|
||||||
|
### Organize code across multiple files
|
||||||
|
|
||||||
|
**main.ts** (minimal, lifecycle only):
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { Plugin } from 'obsidian';
|
||||||
|
import { MySettings, DEFAULT_SETTINGS } from './settings';
|
||||||
|
import { registerCommands } from './commands';
|
||||||
|
|
||||||
|
export default class MyPlugin extends Plugin {
|
||||||
|
settings!: MySettings;
|
||||||
|
|
||||||
|
async onload() {
|
||||||
|
this.settings = Object.assign(
|
||||||
|
{},
|
||||||
|
DEFAULT_SETTINGS,
|
||||||
|
(await this.loadData()) as Partial<MySettings>,
|
||||||
|
);
|
||||||
|
registerCommands(this);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**settings.ts**:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface MySettings {
|
||||||
|
enabled: boolean;
|
||||||
|
apiKey: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_SETTINGS: MySettings = {
|
||||||
|
enabled: true,
|
||||||
|
apiKey: '',
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
**commands/index.ts**:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { Plugin } from 'obsidian';
|
||||||
|
import { doSomething } from './my-command';
|
||||||
|
|
||||||
|
export function registerCommands(plugin: Plugin) {
|
||||||
|
plugin.addCommand({
|
||||||
|
id: 'do-something',
|
||||||
|
name: 'Do something',
|
||||||
|
callback: () => doSomething(plugin),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Add a command
|
||||||
|
|
||||||
|
```ts
|
||||||
|
this.addCommand({
|
||||||
|
id: 'your-command-id',
|
||||||
|
name: 'Do the thing',
|
||||||
|
callback: () => this.doTheThing(),
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Persist settings
|
||||||
|
|
||||||
|
```ts
|
||||||
|
interface MySettings { enabled: boolean }
|
||||||
|
const DEFAULT_SETTINGS: MySettings = { enabled: true };
|
||||||
|
|
||||||
|
async onload() {
|
||||||
|
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData() as Partial<MySettings>);
|
||||||
|
await this.saveData(this.settings);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Register listeners safely
|
||||||
|
|
||||||
|
```ts
|
||||||
|
this.registerEvent(
|
||||||
|
this.app.workspace.on('file-open', (f) => {
|
||||||
|
/* ... */
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
this.registerDomEvent(activeWindow, 'resize', () => {
|
||||||
|
/* ... */
|
||||||
|
});
|
||||||
|
this.registerInterval(
|
||||||
|
window.setInterval(() => {
|
||||||
|
/* ... */
|
||||||
|
}, 1000),
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
- Plugin doesn't load after build: ensure `main.js` and `manifest.json` are at the top level of the plugin folder under `<Vault>/.obsidian/plugins/<plugin-id>/`.
|
||||||
|
- Build issues: if `main.js` is missing, run `npm run build` or `npm run dev` to compile your TypeScript source code.
|
||||||
|
- Commands not appearing: verify `addCommand` runs after `onload` and IDs are unique.
|
||||||
|
- Settings not persisting: ensure `loadData`/`saveData` are awaited and you re-render the UI after changes.
|
||||||
|
- Mobile-only issues: confirm you're not using desktop-only APIs; check `isDesktopOnly` and adjust.
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
- Obsidian sample plugin: https://github.com/obsidianmd/obsidian-sample-plugin
|
||||||
|
- API documentation: https://docs.obsidian.md
|
||||||
|
- Developer policies: https://docs.obsidian.md/Developer+policies
|
||||||
|
- Plugin guidelines: https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines
|
||||||
|
- Style guide: https://help.obsidian.md/style-guide
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
Copyright (C) 2020-2026 by Dynalist Inc.
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
# Obsidian Sample Plugin
|
||||||
|
|
||||||
|
This is a sample plugin for Obsidian (https://obsidian.md).
|
||||||
|
|
||||||
|
This project uses TypeScript to provide type checking and documentation.
|
||||||
|
The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
|
||||||
|
|
||||||
|
This sample plugin demonstrates some of the basic functionality the plugin API can do.
|
||||||
|
|
||||||
|
- Adds a ribbon icon, which shows a Notice when clicked.
|
||||||
|
- Adds a command "Open modal (simple)" which opens a Modal.
|
||||||
|
- Adds a plugin setting tab to the settings page.
|
||||||
|
- Registers a global click event and outputs a Notice on click.
|
||||||
|
- Registers a global interval which logs 'setInterval' to the console.
|
||||||
|
|
||||||
|
## First time developing plugins?
|
||||||
|
|
||||||
|
Quick starting guide for new plugin devs:
|
||||||
|
|
||||||
|
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
|
||||||
|
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
|
||||||
|
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
|
||||||
|
- Install NodeJS, then run `npm i` in the command line under your repo folder.
|
||||||
|
- Run `npm run dev` to compile your plugin from `src/main.ts` to `main.js`.
|
||||||
|
- Make changes to `src/main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
|
||||||
|
- Reload Obsidian to load the new version of your plugin.
|
||||||
|
- Enable plugin in settings window.
|
||||||
|
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
|
||||||
|
|
||||||
|
## Releasing new releases
|
||||||
|
|
||||||
|
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
|
||||||
|
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
|
||||||
|
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
|
||||||
|
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
|
||||||
|
- Publish the release.
|
||||||
|
|
||||||
|
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
|
||||||
|
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
|
||||||
|
|
||||||
|
## Adding your plugin to the community plugin list
|
||||||
|
|
||||||
|
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
|
||||||
|
- Publish an initial version.
|
||||||
|
- Make sure you have a `README.md` file in the root of your repo.
|
||||||
|
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
|
||||||
|
|
||||||
|
## How to use
|
||||||
|
|
||||||
|
- Clone this repo.
|
||||||
|
- Make sure your NodeJS is at least v18 (`node --version`).
|
||||||
|
- `npm i` to install dependencies.
|
||||||
|
- `npm run dev` to start compilation in watch mode.
|
||||||
|
|
||||||
|
## Manually installing the plugin
|
||||||
|
|
||||||
|
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
|
||||||
|
|
||||||
|
## Improve code quality with eslint
|
||||||
|
|
||||||
|
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
|
||||||
|
- This project already has eslint preconfigured, you can invoke a check by running`npm run lint`
|
||||||
|
- Together with a custom eslint [plugin](https://github.com/obsidianmd/eslint-plugin) for Obsidan specific code guidelines.
|
||||||
|
- A GitHub action is preconfigured to automatically lint every commit on all branches.
|
||||||
|
|
||||||
|
## Funding URL
|
||||||
|
|
||||||
|
You can include funding URLs where people who use your plugin can financially support it.
|
||||||
|
|
||||||
|
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"fundingUrl": "https://buymeacoffee.com"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
If you have multiple URLs, you can also do:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"fundingUrl": {
|
||||||
|
"Buy Me a Coffee": "https://buymeacoffee.com",
|
||||||
|
"GitHub Sponsor": "https://github.com/sponsors",
|
||||||
|
"Patreon": "https://www.patreon.com/"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Documentation
|
||||||
|
|
||||||
|
See https://docs.obsidian.md
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
import esbuild from 'esbuild';
|
||||||
|
import process from 'process';
|
||||||
|
import { builtinModules } from 'node:module';
|
||||||
|
|
||||||
|
const banner = `/*
|
||||||
|
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
||||||
|
if you want to view the source, please visit the github repository of this plugin
|
||||||
|
*/
|
||||||
|
`;
|
||||||
|
|
||||||
|
const prod = process.argv[2] === 'production';
|
||||||
|
|
||||||
|
const context = await esbuild.context({
|
||||||
|
banner: {
|
||||||
|
js: banner,
|
||||||
|
},
|
||||||
|
entryPoints: ['src/main.ts'],
|
||||||
|
bundle: true,
|
||||||
|
external: [
|
||||||
|
'obsidian',
|
||||||
|
'electron',
|
||||||
|
'@codemirror/autocomplete',
|
||||||
|
'@codemirror/collab',
|
||||||
|
'@codemirror/commands',
|
||||||
|
'@codemirror/language',
|
||||||
|
'@codemirror/lint',
|
||||||
|
'@codemirror/search',
|
||||||
|
'@codemirror/state',
|
||||||
|
'@codemirror/view',
|
||||||
|
'@lezer/common',
|
||||||
|
'@lezer/highlight',
|
||||||
|
'@lezer/lr',
|
||||||
|
...builtinModules,
|
||||||
|
],
|
||||||
|
format: 'cjs',
|
||||||
|
target: 'es2021',
|
||||||
|
logLevel: 'info',
|
||||||
|
sourcemap: prod ? false : 'inline',
|
||||||
|
treeShaking: true,
|
||||||
|
outfile: 'main.js',
|
||||||
|
minify: prod,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (prod) {
|
||||||
|
await context.rebuild();
|
||||||
|
process.exit(0);
|
||||||
|
} else {
|
||||||
|
await context.watch();
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import obsidianmd from 'eslint-plugin-obsidianmd';
|
||||||
|
import globals from 'globals';
|
||||||
|
import { globalIgnores, defineConfig } from 'eslint/config';
|
||||||
|
|
||||||
|
export default defineConfig(
|
||||||
|
globalIgnores([
|
||||||
|
'node_modules',
|
||||||
|
'dist',
|
||||||
|
'esbuild.config.mjs',
|
||||||
|
'version-bump.mjs',
|
||||||
|
'versions.json',
|
||||||
|
'main.js',
|
||||||
|
'package.json',
|
||||||
|
'package-lock.json',
|
||||||
|
'tsconfig.json',
|
||||||
|
]),
|
||||||
|
{
|
||||||
|
languageOptions: {
|
||||||
|
globals: {
|
||||||
|
...globals.browser,
|
||||||
|
},
|
||||||
|
parserOptions: {
|
||||||
|
projectService: {
|
||||||
|
allowDefaultProject: ['eslint.config.mts', 'manifest.json'],
|
||||||
|
},
|
||||||
|
tsconfigRootDir: import.meta.dirname,
|
||||||
|
extraFileExtensions: ['.json'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
...obsidianmd.configs.recommended,
|
||||||
|
);
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"id": "blogflare-sync",
|
||||||
|
"name": "BlogFlare Sync",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"minAppVersion": "1.4.4",
|
||||||
|
"description": "Publish and sync your Obsidian notes with BlogFlare.",
|
||||||
|
"author": "BlogFlare",
|
||||||
|
"authorUrl": "https://github.com/",
|
||||||
|
"isDesktopOnly": false
|
||||||
|
}
|
||||||
+5053
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"name": "blogflare-obsidian-plugin",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "Publish and sync your Obsidian notes with BlogFlare.",
|
||||||
|
"main": "main.js",
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "node esbuild.config.mjs",
|
||||||
|
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||||
|
"version": "node version-bump.mjs && git add manifest.json versions.json",
|
||||||
|
"lint": "eslint ."
|
||||||
|
},
|
||||||
|
"keywords": [],
|
||||||
|
"license": "MIT",
|
||||||
|
"devDependencies": {
|
||||||
|
"@eslint/js": "^9.39.4",
|
||||||
|
"@types/node": "^22.15.17",
|
||||||
|
"esbuild": "0.25.5",
|
||||||
|
"eslint": "^9.39.4",
|
||||||
|
"eslint-plugin-obsidianmd": "^0.4.0",
|
||||||
|
"globals": "^17.6.0",
|
||||||
|
"jiti": "^2.6.1",
|
||||||
|
"obsidian": "latest",
|
||||||
|
"typescript": "^5.8.3",
|
||||||
|
"typescript-eslint": "^8.59.1"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
import { requestUrl } from 'obsidian';
|
||||||
|
import type { BlogFlareSettings } from './settings';
|
||||||
|
|
||||||
|
export interface MetaItem {
|
||||||
|
id: number;
|
||||||
|
name: string;
|
||||||
|
slug?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PostPayload {
|
||||||
|
title: string;
|
||||||
|
slug: string;
|
||||||
|
content: string;
|
||||||
|
category_slug?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PostMeta {
|
||||||
|
id: number;
|
||||||
|
slug: string;
|
||||||
|
title: string;
|
||||||
|
published_at: string;
|
||||||
|
category_slug?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PostDetail extends PostMeta {
|
||||||
|
content: string;
|
||||||
|
updated_at: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class BlogFlareAPI {
|
||||||
|
private settings: BlogFlareSettings;
|
||||||
|
|
||||||
|
constructor(settings: BlogFlareSettings) {
|
||||||
|
this.settings = settings;
|
||||||
|
}
|
||||||
|
|
||||||
|
private get headers() {
|
||||||
|
return {
|
||||||
|
'Authorization': `Bearer ${this.settings.apiToken}`,
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private getBaseUrl(): string {
|
||||||
|
let url = this.settings.apiEndpoint.trim();
|
||||||
|
if (url.endsWith('/')) {
|
||||||
|
url = url.slice(0, -1);
|
||||||
|
}
|
||||||
|
return url;
|
||||||
|
}
|
||||||
|
|
||||||
|
async getCategories(): Promise<MetaItem[]> {
|
||||||
|
if (!this.getBaseUrl()) return [];
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/categories`,
|
||||||
|
headers: this.headers
|
||||||
|
});
|
||||||
|
return (res.json as { data: MetaItem[] }).data || [];
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTags(): Promise<MetaItem[]> {
|
||||||
|
if (!this.getBaseUrl()) return [];
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/tags`,
|
||||||
|
headers: this.headers
|
||||||
|
});
|
||||||
|
return (res.json as { data: MetaItem[] }).data || [];
|
||||||
|
}
|
||||||
|
|
||||||
|
async getSeries(): Promise<MetaItem[]> {
|
||||||
|
if (!this.getBaseUrl()) return [];
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/series`,
|
||||||
|
headers: this.headers
|
||||||
|
});
|
||||||
|
return (res.json as { data: MetaItem[] }).data || [];
|
||||||
|
}
|
||||||
|
|
||||||
|
async createPost(data: PostPayload): Promise<{ success: boolean; slug?: string; error?: string }> {
|
||||||
|
if (!this.getBaseUrl()) throw new Error('API Endpoint is not configured');
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/posts`,
|
||||||
|
method: 'POST',
|
||||||
|
headers: this.headers,
|
||||||
|
body: JSON.stringify(data)
|
||||||
|
});
|
||||||
|
return res.json as { success: boolean; slug?: string; error?: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
async updatePost(slug: string, data: Partial<PostPayload>): Promise<{ success: boolean; slug?: string; error?: string }> {
|
||||||
|
if (!this.getBaseUrl()) throw new Error('API Endpoint is not configured');
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/posts/${slug}`,
|
||||||
|
method: 'PUT',
|
||||||
|
headers: this.headers,
|
||||||
|
body: JSON.stringify(data)
|
||||||
|
});
|
||||||
|
return res.json as { success: boolean; slug?: string; error?: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
async getPosts(): Promise<PostMeta[]> {
|
||||||
|
if (!this.getBaseUrl()) throw new Error('API Endpoint is not configured');
|
||||||
|
|
||||||
|
let allPosts: PostMeta[] = [];
|
||||||
|
let offset = 0;
|
||||||
|
const limit = 100;
|
||||||
|
let total = 0;
|
||||||
|
|
||||||
|
do {
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/posts?limit=${limit}&offset=${offset}`,
|
||||||
|
headers: this.headers
|
||||||
|
});
|
||||||
|
const json = res.json as { data: PostMeta[], meta: { total: number } };
|
||||||
|
const data = json.data || [];
|
||||||
|
if (data.length === 0) break; // 防止死循环
|
||||||
|
|
||||||
|
allPosts = allPosts.concat(data);
|
||||||
|
total = json.meta?.total || 0;
|
||||||
|
offset += limit;
|
||||||
|
} while (offset < total);
|
||||||
|
|
||||||
|
return allPosts;
|
||||||
|
}
|
||||||
|
|
||||||
|
async getPost(slug: string): Promise<PostDetail> {
|
||||||
|
if (!this.getBaseUrl()) throw new Error('API Endpoint is not configured');
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/posts/${slug}`,
|
||||||
|
headers: this.headers
|
||||||
|
});
|
||||||
|
return (res.json as { data: PostDetail }).data;
|
||||||
|
}
|
||||||
|
|
||||||
|
async createCategory(name: string, slug?: string): Promise<{ success: boolean; error?: string }> {
|
||||||
|
if (!this.getBaseUrl()) throw new Error('API Endpoint is not configured');
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/categories`,
|
||||||
|
method: 'POST',
|
||||||
|
headers: this.headers,
|
||||||
|
body: JSON.stringify({ name, slug: slug || name })
|
||||||
|
});
|
||||||
|
return res.json as { success: boolean; error?: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
async createTag(name: string): Promise<{ success: boolean; error?: string }> {
|
||||||
|
if (!this.getBaseUrl()) throw new Error('API Endpoint is not configured');
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/tags`,
|
||||||
|
method: 'POST',
|
||||||
|
headers: this.headers,
|
||||||
|
body: JSON.stringify({ name })
|
||||||
|
});
|
||||||
|
return res.json as { success: boolean; error?: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
async deletePost(slug: string): Promise<{ success: boolean; error?: string }> {
|
||||||
|
if (!this.getBaseUrl()) throw new Error('API Endpoint is not configured');
|
||||||
|
const res = await requestUrl({
|
||||||
|
url: `${this.getBaseUrl()}/api/v1/posts/${slug}`,
|
||||||
|
method: 'DELETE',
|
||||||
|
headers: this.headers
|
||||||
|
});
|
||||||
|
return res.json as { success: boolean; error?: string };
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,295 @@
|
|||||||
|
import { Notice, Plugin, MarkdownView } from 'obsidian';
|
||||||
|
import {
|
||||||
|
BlogFlareSettings,
|
||||||
|
DEFAULT_SETTINGS,
|
||||||
|
BlogFlareSettingTab,
|
||||||
|
} from './settings';
|
||||||
|
import { BlogFlareAPI } from './api';
|
||||||
|
import { MetaSuggestModal } from './suggest';
|
||||||
|
import { PullSuggestModal } from './pull_modal';
|
||||||
|
|
||||||
|
export default class BlogFlarePlugin extends Plugin {
|
||||||
|
settings!: BlogFlareSettings;
|
||||||
|
api!: BlogFlareAPI;
|
||||||
|
|
||||||
|
async onload() {
|
||||||
|
await this.loadSettings();
|
||||||
|
this.api = new BlogFlareAPI(this.settings);
|
||||||
|
|
||||||
|
// Add settings tab
|
||||||
|
this.addSettingTab(new BlogFlareSettingTab(this.app, this));
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: 'insert-category',
|
||||||
|
name: '插入分类',
|
||||||
|
checkCallback: (checking: boolean) => {
|
||||||
|
const activeView = this.app.workspace.getActiveViewOfType(MarkdownView);
|
||||||
|
const file = activeView?.file;
|
||||||
|
if (activeView && file) {
|
||||||
|
if (!checking) {
|
||||||
|
this.api.getCategories().then(items => {
|
||||||
|
if (items.length === 0) {
|
||||||
|
new Notice('未找到分类或尚未配置 API。');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
new MetaSuggestModal(this.app, items, 'category_slug', file, true).open();
|
||||||
|
}).catch(e => {
|
||||||
|
console.error(e);
|
||||||
|
new Notice('获取分类失败。');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: 'insert-tag',
|
||||||
|
name: '插入标签',
|
||||||
|
checkCallback: (checking: boolean) => {
|
||||||
|
const activeView = this.app.workspace.getActiveViewOfType(MarkdownView);
|
||||||
|
const file = activeView?.file;
|
||||||
|
if (activeView && file) {
|
||||||
|
if (!checking) {
|
||||||
|
this.api.getTags().then(items => {
|
||||||
|
if (items.length === 0) {
|
||||||
|
new Notice('未找到标签或尚未配置 API。');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Tags only use name, so useSlug = false
|
||||||
|
new MetaSuggestModal(this.app, items, 'tags', file, false).open();
|
||||||
|
}).catch(e => {
|
||||||
|
console.error(e);
|
||||||
|
new Notice('获取标签失败。');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: 'insert-series',
|
||||||
|
name: '插入系列',
|
||||||
|
checkCallback: (checking: boolean) => {
|
||||||
|
const activeView = this.app.workspace.getActiveViewOfType(MarkdownView);
|
||||||
|
const file = activeView?.file;
|
||||||
|
if (activeView && file) {
|
||||||
|
if (!checking) {
|
||||||
|
this.api.getSeries().then(items => {
|
||||||
|
if (items.length === 0) {
|
||||||
|
new Notice('未找到系列或尚未配置 API。');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
new MetaSuggestModal(this.app, items, 'series_slug', file, true).open();
|
||||||
|
}).catch(e => {
|
||||||
|
console.error(e);
|
||||||
|
new Notice('获取系列失败。');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: 'publish-post',
|
||||||
|
name: '发布文章 (push)',
|
||||||
|
checkCallback: (checking: boolean) => {
|
||||||
|
const activeView = this.app.workspace.getActiveViewOfType(MarkdownView);
|
||||||
|
const file = activeView?.file;
|
||||||
|
if (activeView && file) {
|
||||||
|
if (!checking) {
|
||||||
|
void (async () => {
|
||||||
|
try {
|
||||||
|
new Notice('开始发布文章...');
|
||||||
|
const rawContent = await this.app.vault.read(file);
|
||||||
|
const cache = this.app.metadataCache.getFileCache(file);
|
||||||
|
const frontmatter = cache?.frontmatter;
|
||||||
|
|
||||||
|
let content = rawContent;
|
||||||
|
const frontmatterPosition = cache?.frontmatterPosition;
|
||||||
|
// 移除前置 YAML
|
||||||
|
if (frontmatterPosition) {
|
||||||
|
content = rawContent.substring(frontmatterPosition.end.offset).replace(/^\n+/, '');
|
||||||
|
}
|
||||||
|
|
||||||
|
const title = frontmatter?.title as string || file.basename;
|
||||||
|
const slug = frontmatter?.slug as string || file.basename.toLowerCase().replace(/\s+/g, '-');
|
||||||
|
const category_slug = frontmatter?.category_slug as string | undefined;
|
||||||
|
const publishedSlug = frontmatter?.blogflare_published_slug as string | undefined;
|
||||||
|
|
||||||
|
const payload = {
|
||||||
|
title,
|
||||||
|
slug,
|
||||||
|
content,
|
||||||
|
category_slug
|
||||||
|
};
|
||||||
|
|
||||||
|
if (publishedSlug) {
|
||||||
|
// 已发布，进行更新
|
||||||
|
const res = await this.api.updatePost(publishedSlug, payload);
|
||||||
|
if (res.success) {
|
||||||
|
new Notice('文章更新成功！');
|
||||||
|
} else {
|
||||||
|
new Notice(`更新失败: ${res.error || '未知错误'}`);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// 未发布，进行创建
|
||||||
|
const res = await this.api.createPost(payload);
|
||||||
|
if (res.success && res.slug) {
|
||||||
|
// 写入 blogflare_published_slug
|
||||||
|
await this.app.fileManager.processFrontMatter(file, (fm: Record<string, unknown>) => {
|
||||||
|
fm['blogflare_published_slug'] = res.slug;
|
||||||
|
});
|
||||||
|
new Notice('文章发布成功！');
|
||||||
|
} else {
|
||||||
|
new Notice(`发布失败: ${res.error || '未知错误'}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
new Notice('发布请求出错，请检查网络或配置。');
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: 'pull-post',
|
||||||
|
name: '拉取文章 (pull)',
|
||||||
|
callback: () => {
|
||||||
|
this.api.getPosts().then(items => {
|
||||||
|
if (items.length === 0) {
|
||||||
|
new Notice('未找到文章或 API 尚未配置。');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
new PullSuggestModal(this.app, items, this.api).open();
|
||||||
|
}).catch(e => {
|
||||||
|
console.error(e);
|
||||||
|
new Notice('获取文章列表失败。');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: 'init-sync',
|
||||||
|
name: '全量拉取初始化 (init sync)',
|
||||||
|
callback: () => {
|
||||||
|
const mdFiles = this.app.vault.getMarkdownFiles();
|
||||||
|
if (mdFiles.length > 0) {
|
||||||
|
new Notice('全量同步失败：本地必需是空的 vault！', 5000);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
void (async () => {
|
||||||
|
try {
|
||||||
|
new Notice('开始拉取全量文章列表...');
|
||||||
|
const items = await this.api.getPosts();
|
||||||
|
if (items.length === 0) {
|
||||||
|
new Notice('未找到文章，同步结束。');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
new Notice(`发现 ${items.length} 篇文章，开始同步...`);
|
||||||
|
let successCount = 0;
|
||||||
|
|
||||||
|
for (const item of items) {
|
||||||
|
try {
|
||||||
|
const detail = await this.api.getPost(item.slug);
|
||||||
|
|
||||||
|
// 组装 Frontmatter
|
||||||
|
const frontmatterLines = [
|
||||||
|
'---',
|
||||||
|
`title: "${detail.title.replace(/"/g, '\\"')}"`,
|
||||||
|
`slug: ${detail.slug}`,
|
||||||
|
`blogflare_published_slug: ${detail.slug}`
|
||||||
|
];
|
||||||
|
if (detail.category_slug) {
|
||||||
|
frontmatterLines.push(`category_slug: ${detail.category_slug}`);
|
||||||
|
}
|
||||||
|
frontmatterLines.push('---');
|
||||||
|
|
||||||
|
const fileContent = frontmatterLines.join('\n') + '\n\n' + (detail.content || '');
|
||||||
|
|
||||||
|
const fileName = `${detail.title.replace(/[/\\:]/g, '-')}.md`;
|
||||||
|
await this.app.vault.create(fileName, fileContent);
|
||||||
|
successCount++;
|
||||||
|
} catch (err) {
|
||||||
|
console.error(`拉取文章 ${item.slug} 失败:`, err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
new Notice(`全量同步完成！成功拉取 ${successCount}/${items.length} 篇文章。`, 5000);
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
new Notice('全量同步请求出错，请检查网络或配置。');
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: 'delete-post',
|
||||||
|
name: '下线云端文章 (delete)',
|
||||||
|
checkCallback: (checking: boolean) => {
|
||||||
|
const activeView = this.app.workspace.getActiveViewOfType(MarkdownView);
|
||||||
|
const file = activeView?.file;
|
||||||
|
if (activeView && file) {
|
||||||
|
if (!checking) {
|
||||||
|
void (async () => {
|
||||||
|
try {
|
||||||
|
const cache = this.app.metadataCache.getFileCache(file);
|
||||||
|
const publishedSlug = cache?.frontmatter?.blogflare_published_slug as string | undefined;
|
||||||
|
|
||||||
|
if (!publishedSlug) {
|
||||||
|
new Notice('本文尚未发布到 blogflare。');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
new Notice('正在尝试下线云端文章...');
|
||||||
|
const res = await this.api.deletePost(publishedSlug);
|
||||||
|
if (res.success) {
|
||||||
|
await this.app.fileManager.processFrontMatter(file, (fm: Record<string, unknown>) => {
|
||||||
|
delete fm['blogflare_published_slug'];
|
||||||
|
});
|
||||||
|
new Notice('文章已成功从云端删除！');
|
||||||
|
} else {
|
||||||
|
new Notice(`下线失败: ${res.error || '未知错误'}`);
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
new Notice('删除请求出错，请检查网络或配置。');
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
onunload() {}
|
||||||
|
|
||||||
|
async loadSettings() {
|
||||||
|
this.settings = Object.assign(
|
||||||
|
{},
|
||||||
|
DEFAULT_SETTINGS,
|
||||||
|
(await this.loadData()) as Partial<BlogFlareSettings>,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async saveSettings() {
|
||||||
|
await this.saveData(this.settings);
|
||||||
|
// re-init API with new settings
|
||||||
|
this.api = new BlogFlareAPI(this.settings);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
import { App, FuzzySuggestModal, Notice, TFile } from 'obsidian';
|
||||||
|
import type { PostMeta, BlogFlareAPI } from './api';
|
||||||
|
|
||||||
|
export class PullSuggestModal extends FuzzySuggestModal<PostMeta> {
|
||||||
|
private items: PostMeta[];
|
||||||
|
private api: BlogFlareAPI;
|
||||||
|
|
||||||
|
constructor(app: App, items: PostMeta[], api: BlogFlareAPI) {
|
||||||
|
super(app);
|
||||||
|
this.items = items;
|
||||||
|
this.api = api;
|
||||||
|
}
|
||||||
|
|
||||||
|
getItems(): PostMeta[] {
|
||||||
|
return this.items;
|
||||||
|
}
|
||||||
|
|
||||||
|
getItemText(item: PostMeta): string {
|
||||||
|
return `${item.title} (${item.slug})`;
|
||||||
|
}
|
||||||
|
|
||||||
|
onChooseItem(item: PostMeta, evt: MouseEvent | KeyboardEvent) {
|
||||||
|
new Notice(`开始拉取文章: ${item.title}`);
|
||||||
|
void (async () => {
|
||||||
|
try {
|
||||||
|
const detail = await this.api.getPost(item.slug);
|
||||||
|
|
||||||
|
// 组装 Frontmatter
|
||||||
|
const frontmatterLines = [
|
||||||
|
'---',
|
||||||
|
`title: "${detail.title.replace(/"/g, '\\"')}"`,
|
||||||
|
`slug: ${detail.slug}`,
|
||||||
|
`blogflare_published_slug: ${detail.slug}`
|
||||||
|
];
|
||||||
|
if (detail.category_slug) {
|
||||||
|
frontmatterLines.push(`category_slug: ${detail.category_slug}`);
|
||||||
|
}
|
||||||
|
frontmatterLines.push('---');
|
||||||
|
|
||||||
|
const fileContent = frontmatterLines.join('\n') + '\n\n' + (detail.content || '');
|
||||||
|
|
||||||
|
// 决定文件名 (过滤掉非法字符)
|
||||||
|
const fileName = `${detail.title.replace(/[/\\:]/g, '-')}.md`;
|
||||||
|
|
||||||
|
// 检查是否已有该文件
|
||||||
|
let file = this.app.vault.getAbstractFileByPath(fileName);
|
||||||
|
if (file instanceof TFile) {
|
||||||
|
await this.app.vault.modify(file, fileContent);
|
||||||
|
new Notice(`已覆盖并更新存在的文件: ${fileName}`);
|
||||||
|
} else {
|
||||||
|
file = await this.app.vault.create(fileName, fileContent);
|
||||||
|
new Notice(`成功拉取并创建文件: ${fileName}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 打开文件
|
||||||
|
if (file instanceof TFile) {
|
||||||
|
const leaf = this.app.workspace.getLeaf('tab');
|
||||||
|
await leaf.openFile(file);
|
||||||
|
}
|
||||||
|
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
new Notice(`拉取文章失败: ${item.slug}`);
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
import { App, PluginSettingTab, Setting } from 'obsidian';
|
||||||
|
import BlogFlarePlugin from './main';
|
||||||
|
|
||||||
|
export interface BlogFlareSettings {
|
||||||
|
apiEndpoint: string;
|
||||||
|
apiToken: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_SETTINGS: BlogFlareSettings = {
|
||||||
|
apiEndpoint: '',
|
||||||
|
apiToken: ''
|
||||||
|
};
|
||||||
|
|
||||||
|
export class BlogFlareSettingTab extends PluginSettingTab {
|
||||||
|
plugin: BlogFlarePlugin;
|
||||||
|
|
||||||
|
constructor(app: App, plugin: BlogFlarePlugin) {
|
||||||
|
super(app, plugin);
|
||||||
|
this.plugin = plugin;
|
||||||
|
}
|
||||||
|
|
||||||
|
display(): void {
|
||||||
|
const { containerEl } = this;
|
||||||
|
containerEl.empty();
|
||||||
|
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName('API 地址')
|
||||||
|
.setDesc('BlogFlare 实例的访问地址（如 https://yourblog.com）')
|
||||||
|
.addText(text => text
|
||||||
|
.setPlaceholder('输入地址...')
|
||||||
|
.setValue(this.plugin.settings.apiEndpoint)
|
||||||
|
.onChange(async (value) => {
|
||||||
|
this.plugin.settings.apiEndpoint = value;
|
||||||
|
await this.plugin.saveSettings();
|
||||||
|
}));
|
||||||
|
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName('API 令牌 (Token)')
|
||||||
|
.setDesc('用于请求接口认证的 API Token')
|
||||||
|
.addText(text => text
|
||||||
|
.setPlaceholder('输入你的 Token')
|
||||||
|
.setValue(this.plugin.settings.apiToken)
|
||||||
|
.onChange(async (value) => {
|
||||||
|
this.plugin.settings.apiToken = value;
|
||||||
|
await this.plugin.saveSettings();
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
import { App, FuzzySuggestModal, Notice, TFile } from 'obsidian';
|
||||||
|
import type { MetaItem } from './api';
|
||||||
|
|
||||||
|
export class MetaSuggestModal extends FuzzySuggestModal<MetaItem> {
|
||||||
|
private items: MetaItem[];
|
||||||
|
private metaKey: string;
|
||||||
|
private file: TFile;
|
||||||
|
private useSlug: boolean;
|
||||||
|
|
||||||
|
constructor(app: App, items: MetaItem[], metaKey: string, file: TFile, useSlug: boolean = true) {
|
||||||
|
super(app);
|
||||||
|
this.items = items;
|
||||||
|
this.metaKey = metaKey;
|
||||||
|
this.file = file;
|
||||||
|
this.useSlug = useSlug;
|
||||||
|
}
|
||||||
|
|
||||||
|
getItems(): MetaItem[] {
|
||||||
|
return this.items;
|
||||||
|
}
|
||||||
|
|
||||||
|
getItemText(item: MetaItem): string {
|
||||||
|
// 显示名称，如果有 slug，追加显示
|
||||||
|
if (item.slug && this.useSlug) {
|
||||||
|
return `${item.name} (${item.slug})`;
|
||||||
|
}
|
||||||
|
return item.name;
|
||||||
|
}
|
||||||
|
|
||||||
|
onChooseItem(item: MetaItem, evt: MouseEvent | KeyboardEvent) {
|
||||||
|
const valueToInsert = (this.useSlug && item.slug) ? item.slug : item.name;
|
||||||
|
|
||||||
|
void this.app.fileManager.processFrontMatter(this.file, (frontmatter: Record<string, unknown>) => {
|
||||||
|
const currentVal = frontmatter[this.metaKey];
|
||||||
|
if (this.metaKey === 'tags' || this.metaKey === 'tag') {
|
||||||
|
if (!currentVal) {
|
||||||
|
frontmatter[this.metaKey] = [valueToInsert];
|
||||||
|
} else if (Array.isArray(currentVal)) {
|
||||||
|
if (!currentVal.includes(valueToInsert)) {
|
||||||
|
currentVal.push(valueToInsert);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
frontmatter[this.metaKey] = [currentVal, valueToInsert];
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
frontmatter[this.metaKey] = valueToInsert;
|
||||||
|
}
|
||||||
|
}).then(() => {
|
||||||
|
new Notice(`成功将 ${this.metaKey} 设为 ${valueToInsert}`);
|
||||||
|
}).catch(e => {
|
||||||
|
console.error(e);
|
||||||
|
new Notice(`设置 ${this.metaKey} 失败`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
/*
|
||||||
|
|
||||||
|
This CSS file will be included with your plugin, and
|
||||||
|
available in the app when your plugin is enabled.
|
||||||
|
|
||||||
|
If your plugin does not need CSS, delete this file.
|
||||||
|
|
||||||
|
*/
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"inlineSourceMap": true,
|
||||||
|
"inlineSources": true,
|
||||||
|
"module": "ESNext",
|
||||||
|
"target": "ES2021",
|
||||||
|
"strict": true,
|
||||||
|
"noImplicitReturns": true,
|
||||||
|
"noFallthroughCasesInSwitch": true,
|
||||||
|
"noUncheckedIndexedAccess": true,
|
||||||
|
"moduleResolution": "node",
|
||||||
|
"isolatedModules": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"forceConsistentCasingInFileNames": true,
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"lib": ["ES2021", "DOM"]
|
||||||
|
},
|
||||||
|
"include": ["src/**/*.ts"]
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
import { readFileSync, writeFileSync } from 'fs';
|
||||||
|
|
||||||
|
const targetVersion = process.env.npm_package_version;
|
||||||
|
|
||||||
|
// read minAppVersion from manifest.json and bump version to target version
|
||||||
|
const manifest = JSON.parse(readFileSync('manifest.json', 'utf8'));
|
||||||
|
const { minAppVersion } = manifest;
|
||||||
|
manifest.version = targetVersion;
|
||||||
|
writeFileSync('manifest.json', JSON.stringify(manifest, null, '\t'));
|
||||||
|
|
||||||
|
// update versions.json with target version and minAppVersion from manifest.json
|
||||||
|
// but only if the target version is not already in versions.json
|
||||||
|
const versions = JSON.parse(readFileSync('versions.json', 'utf8'));
|
||||||
|
if (!(targetVersion in versions)) {
|
||||||
|
versions[targetVersion] = minAppVersion;
|
||||||
|
writeFileSync('versions.json', JSON.stringify(versions, null, '\t'));
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"1.0.0": "1.0.0"
|
||||||
|
}
|
||||||
Reference in new issue
Block a user