Merge pull request #46 from johannrichard/readwise-mirror-ng

This is a comprehensive patch that implements several features as well as some “housekeeping” related to building, testing, and releasing the plugin itself.

Specifically, in terms of plugin features, it

- switches to the “export” API, which makes the `document` and `summary` available, adds additional metadata (created, updated, and (last) highlighted date across the board) - /issues/39, 
- adds documentation to the different templates within the plugin options in Obsidian,
- implements two additional `nunjucks` filters (`is_qa`, `qa`) which can be used to parse and reassemble “Q & A” blocks defined with the `.qa` action tag in a note, 
- includes improvements for `title` and `author` as well as `sanitized_title` and `authorStr` when used in the frontmatter template
- adds a feature to deduplicate items (locally and remotely), using the unique Readwise URL in frontmatter
- implements features to parse, keep, and protect frontmatter on updates (needed for deduplication, but useful to keep additional fields around when updating), 
- driven by the needs of these two features, validates the frontmatter template in the settings UI to make sure we can use it when the plugin is run, 
- implements a feature to *slugify* -  #27
- uses `filenamify` to create valid filenames and limit them to 255 characters - #37
- adds the relevant additional documentation

In terms of housekeeping, this patch 

- implements a `semantic-release` workflow, using the [`brianrodri/semantic-release-obsidian-plugin`](https://github.com/brianrodri/semantic-release-obsidian-plugin), which can be used to deploy semantic versions, including `beta` releases [^1]
- adds local deploy and release actions, as well as a GitHub workflow that automatically runs a release on the `master` resp. `main` branches (Since incorporating this, I've moved the `semantic-release` config into a separate `.realeaserc.yaml` to stop polluting `package.json` and I also removed committing `manifest.json`, `versions.json` and `package[-lock].json` as this (not suprisingly) created quite a bit of issues when merging branches). [^2]
- restructures the code to make it more modular (separating settings from the main class),

It does **not**

- implement the `retry-fetch` (due to incompatibilities with Obsidian on Mobile, which I haven't yet figure out)
- implement the cache / diff and other ideas I have kept around for a while

[^1]: By using this, and Obsidian BRAT, it would e.g. be possible to easily and semi-automatically create beta releases. It would also more easily allow to work on new features while keeping a slower pace with major releases.  
[^2]: The local deploy facilitates easy testing during development whereas the local release action allows creating releases outside of GitHub, which I think is particularly interesting for `beta` or `alpha` pre-releases.

Author: johannrichard

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Release plugin version
+on: 
+  workflow_dispatch:
+  push:
+    branches: [master, main, beta]
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: latest
+      - name: Install dependencies
+        run: npm clean-install
+        env:
+          HUSKY: 0
+      # TODO: Re-enable after https://github.com/blacksmithgu/obsidian-dataview/issues/2288
+      # - name: Audit dependencies
+      #   run: npm audit && npm audit signatures
+      # - name: Audit code coverage
+      #   run: npm run coverage
+      - name: Build plugin
+        run: npm run build
+      - name: Release update
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx -p github:brianrodri/semantic-release-obsidian-plugin semantic-release

.gitignore

@@ -4,11 +4,11 @@
 
 # npm
 node_modules
-package-lock.json
 
 # build
 main.js
 *.js.map
+.env
 
 # obsidian
 data.json

.releaserc.yaml

@@ -0,0 +1,33 @@
+# A semantic-release configuration for an Obsidian plugin
+# By using `npx`, we avoid the need to install `semantic-release` 
+#  and `semantic-release-obsidian-plugin` globally.
+# This configuration is set up to run in dry-run mode by default and 
+# uses the standard branches for Obsidian plugins (`master`, `main`, `beta` etc.)
+# run semantic-release as follows to release a new version of your plugin:
+#   dry-run (default):  npx -p github:brianrodri/semantic-release-obsidian-plugin semantic-release 
+#   for real: npx -p github:brianrodri/semantic-release-obsidian-plugin semantic-release --dry-run false
+plugins:
+  - '@semantic-release/commit-analyzer'
+  - '@semantic-release/release-notes-generator'
+  - semantic-release-obsidian-plugin
+  - - '@semantic-release/github'
+    - assets:
+        - path: main.js
+        - path: manifest.json
+        - path: src/ui/styles/styles.css
+  # Uncomment the following block if semantic release *should* commit the 
+  # updated `manifest.json`, `versions.json` and `package.json` files with the new version number.
+  #
+  # - - '@semantic-release/git'
+  #   - assets:
+  #       - manifest.json
+  #       - versions.json
+  #       - package.json
+  #       - package-lock.json
+  #     message: >-
+  #       chore(release): set `package.json`, `manifest.json`,`versions.json` and
+  #       `package-lock.json` to ${nextRelease.version} [skip ci]
+  #
+  #
+  #       ${nextRelease.notes}
+tagFormat: '${version}'