Initial commit

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{yml,yaml,json}]
+indent_size = 2
+
+[package-lock.json]
+indent_size = 2

.gitattributes

@@ -0,0 +1,7 @@
+# Normalize line endings to LF.
+* text eol=lf
+# Ensure the following are treated as binary.
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text

.github/workflows/pre-release.yml

@@ -0,0 +1,31 @@
+name: Pre-release
+
+on:
+  push:
+    branches:
+      - "release/[0-9]+.[0-9]+.[0-9]+"
+
+env:
+  PLUGIN_NAME: "chronotyper"
+  BUILD_DIR: "./dist"
+  RELEASE_VERSION: ${{ github.ref_name }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+
+      - name: NPM Install and build
+        run: |
+          npm clean-install
+          npm run build --if-present
+
+      - name: ZIP build output
+        working-directory: ${{ env.BUILD_DIR }}
+        run: |
+          zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }}

.github/workflows/release.yml

@@ -0,0 +1,82 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+env:
+  PLUGIN_NAME: "chronotyper"
+  BUILD_DIR: "./dist"
+  RELEASE_VERSION: ${{ github.ref_name }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+
+      - name: NPM Install and build
+        run: |
+          npm clean-install
+          npm run build --if-present
+
+      - name: ZIP build output
+        working-directory: ${{ env.BUILD_DIR }}
+        run: |
+          zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }}
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ env.RELEASE_VERSION }}
+          release_name: ${{ env.RELEASE_VERSION }}
+          draft: false
+          prerelease: false
+
+      - name: Upload manifest
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./${{ env.BUILD_DIR }}/${{ env.PLUGIN_NAME }}/manifest.json
+          asset_name: manifest.json
+          asset_content_type: application/json
+
+      - name: Upload script
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./${{ env.BUILD_DIR }}/${{ env.PLUGIN_NAME }}/main.js
+          asset_name: main.js
+          asset_content_type: text/javascript
+
+      - name: Upload stylesheet
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./${{ env.BUILD_DIR }}/${{ env.PLUGIN_NAME }}/styles.css
+          asset_name: styles.css
+          asset_content_type: text/css
+
+      - name: Upload archive
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./${{ env.BUILD_DIR }}/${{ env.PLUGIN_NAME }}.zip
+          asset_name: ${{ env.PLUGIN_NAME }}-${{ env.RELEASE_VERSION }}.zip
+          asset_content_type: application/zip

.github/workflows/sonar-analysis.yml

@@ -0,0 +1,36 @@
+name: Sonar Analysis
+
+on:
+  push:
+
+jobs:
+
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v3
+        with:
+          # Shallow clones should be disabled for a better relevancy of analysis
+          fetch-depth: 0
+
+      - name: Use node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+
+      - name: NPM Install
+        run: |
+          npm clean-install
+
+      - name: Test with coverage
+        run: |
+          npx jest --coverage
+
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          # Needed to get PR information, if any
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -0,0 +1,24 @@
+# IntelliJ Idea
+/.idea/
+
+# Visual Studio Code
+/.vscode/
+
+# NPM
+/node_modules/
+
+# Build output
+/dist/
+
+# Exclude sourcemaps
+*.map
+
+# Obsidian
+/data.json
+
+# Exclude macOS Finder (System Explorer) View States
+.DS_Store
+
+/.ignore/
+
+/coverage/

DEVELOPMENT.md

@@ -0,0 +1,25 @@
+# Chronotyper: Development
+
+These are my notes on the development of the plugin.
+
+## Release: How To
+
+1. From the `develop` branch, create a release branch `release/X.Y.Z`
+2. Go to [package.json](./package.json) and overwrite `X.Y.Z-NEXT` with new version throughout the whole project (double check if save data version needs to be updated)
+3. Update the [package-lock](./package-lock.json) file: `npm install`
+4. Export save data schema: `npm run export-schema`
+5. Run tests: `npm run test`
+6. Run build and test out the app: `npm run build`
+7. Commit as "Version `X.Y.Z`"
+8. Push, and fix if build fails, otherwise merge to the `main` branch
+9. Create a tag with the label `X.Y.Z`
+10. GitHub Actions will create a [release](https://github.com/BambusControl/obsidian-chronotyper/releases)
+11. Add release notes to the release
+12. Fast-forward the `develop` branch
+13. Go to [package.json](./package.json) and overwrite `X.Y.Z` with _next_ version `X.Y.Z-NEXT` throughout the whole project
+14. Update the [package-lock](./package-lock.json) file: `npm install`
+15. Commit as "Set version as `X.Y.Z-NEXT`" to the `develop` branch
+
+## Development Diary
+
+_Nothing here yet!_

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Mojmír Majer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,9 @@
+# Obsidian Chronotyper
+
+![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?label=downloads&query=%24%5B%22chronotyper%22%5D%5B%22downloads%22%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json&logo=obsidian&color=8b6cef&logoColor=8b6cef&labelColor=f1f2f3&logoWidth=20&style=for-the-badge)
+
+> See [what's new](https://github.com/BambusControl/obsidian-chronotyper/releases)!
+
+Track the total time of your edits directly inside your notes.
+
+> *This is a plugin for [Obsidian: chronotyper](https://obsidian.md/plugins?id=chronotyper)*.

esbuild.config.mjs

@@ -0,0 +1,58 @@
+import esbuild from "esbuild";
+import process from "process";
+import builtins from "builtin-modules";
+import {sassPlugin} from "esbuild-sass-plugin";
+import * as fs from "fs/promises";
+
+const banner =
+	"/* THIS IS A GENERATED/BUNDLED FILE BY ESBUILD see https://github.com/BambusControl/obsidian-chronotyper for the source */";
+
+const prodBuild = (process.argv[2] === "production");
+
+const sourceDir = "./src/chronotyper";
+const outputDir = "./dist/chronotyper";
+
+/* Copy the manifest for working*/
+await fs.mkdir(outputDir, {recursive: true});
+await fs.copyFile("manifest.json", `${outputDir}/manifest.json`);
+
+const buildOptions = {
+	banner: {
+		js: banner,
+	},
+	entryPoints: [
+		`${sourceDir}/main.ts`,
+		`${sourceDir}/styles.scss`,
+	],
+	entryNames: "[name]",
+	outdir: outputDir,
+	bundle: true,
+	external: [
+		"obsidian",
+		...builtins,
+	],
+	format: "cjs",
+	target: "ES6",
+	logLevel: "info",
+	sourcemap: prodBuild ? false : "inline",
+	treeShaking: true,
+	minify: prodBuild,
+	plugins: [
+		sassPlugin({
+			syntax: "scss",
+			style: prodBuild ? "compressed" : "expanded",
+		}),
+	],
+    drop: prodBuild ? ["console"] : []
+};
+
+try {
+	if (prodBuild) {
+		await esbuild.build(buildOptions);
+	} else {
+		await (await esbuild.context(buildOptions)).watch();
+	}
+
+} catch {
+	process.exit(1);
+}

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

manifest.json

@@ -0,0 +1,10 @@
+{
+	"id": "chronotyper",
+	"name": "Chronotyper",
+	"version": "0.1.0-NEXT",
+	"minAppVersion": "1.7.2",
+	"description": "Track how long you edit notes directly in the note properties",
+	"author": "BambusControl",
+	"authorUrl": "https://github.com/BambusControl",
+	"isDesktopOnly": false
+}

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "obsidian-chronotyper",
+  "version": "0.1.0-NEXT",
+  "description": "Obsidian plugin for tracking note edit time.",
+  "main": "main.js",
+  "scripts": {
+    "dev": "node esbuild.config.mjs",
+    "build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
+    "export-schema": "typescript-json-schema --required --strictNullChecks --validationKeywords --ignoreErrors --refs --id https://raw.githubusercontent.com/BambusControl/obsidian-chronotyper/0.1.0-NEXT/resources/save-data-schema.json --out ./resources/save-data-schema.json tsconfig.json SaveData",
+    "test": "jest"
+  },
+  "keywords": [
+    "obsidian"
+  ],
+  "private": true,
+  "repository": "https://github.com/BambusControl/obsidian-chronotyper",
+  "author": {
+    "name": "BambusControl",
+    "url": "https://github.com/BambusControl"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+  },
+  "devDependencies": {
+    "@types/jest": "^29",
+    "@types/node": "^18",
+    "@types/papaparse": "^5",
+    "@typescript-eslint/eslint-plugin": "^5",
+    "@typescript-eslint/parser": "^5",
+    "builtin-modules": "^3",
+    "esbuild": "^0",
+    "esbuild-sass-plugin": "^3",
+    "jest": "^29",
+    "obsidian": "1.7.2",
+    "ts-jest": "^29",
+    "tslib": "^2",
+    "typescript": "^4",
+    "typescript-json-schema": "^0"
+  }
+}

sonar-project.properties

@@ -0,0 +1,16 @@
+sonar.projectKey=BambusControl_obsidian-chronotyper
+sonar.organization=bambuscontrol
+
+# This is the name and version displayed in the SonarCloud UI.
+sonar.projectVersion=0.1.0-NEXT
+
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+sonar.sources=./src
+sonar.tests=./tests
+
+# Encoding of the source code. Default is default system encoding
+sonar.sourceEncoding=UTF-8
+
+# Path for coverage reports
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info

tsconfig.json

@@ -0,0 +1,34 @@
+{
+	"compilerOptions": {
+		"baseUrl": ".",
+		"inlineSourceMap": true,
+		"inlineSources": true,
+		"module": "ESNext",
+		"target": "ES6",
+		"allowJs": true,
+		"moduleResolution": "node",
+		"importHelpers": true,
+		"isolatedModules": true,
+		"forceConsistentCasingInFileNames": true,
+		"strict": true,
+		"noImplicitOverride": true,
+		"noPropertyAccessFromIndexSignature": true,
+		"noImplicitReturns": true,
+		"strictNullChecks": true,
+		"strictBindCallApply": true,
+		"strictPropertyInitialization": true,
+		"strictFunctionTypes": true,
+		"noImplicitAny": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"lib": [
+			"DOM",
+			"ES5",
+			"ES6",
+			"ES7"
+		]
+	},
+	"include": [
+		"**/*.ts"
+	]
+}