mirror of
https://github.com/vrtmrz/obsidian-livesync.git
synced 2025-12-13 01:35:57 +00:00
6e1eb36f3b
... including ci/cd check-only commands. The code is quite complex and missing a lot of dev-ops types checks and standards. One of the key problems with codebases like this is on-boarding new developers to the codebase (like myself). When there is a consistent and enforced coding-style (irrespective of what the coding style is) it makes it _significantly_ easier for collaborators and maintainers to get on with the job in hand. It also, from a day-2-day developer perspective, significantly reduces cognitive overhead re reading code. Finally this is a "trial balloon" PR, if this patch is accepted I will likely do more work on testing and docs for the project. - The new prettier config is a non-standard setup, but a close-match to how the code _currently_ looks. - 120 col-width print width (instead of the better and more information-dense 88), this is so the diff after applying prettier to the code is less disruptive, whilst still showing the benefits of using a prettier. - We use `tabWidth` setting of 4 as the code uses that more common setting instead of the more compact 2 spaces - note that 2 often leads to more readable and compact code. - We enforce trailing commas, as that seems to be the norm in this code-base. We choose the `es5` standard here. - We enforce tailing semi-colons (`semi`) as the majority of code used that flavour of `js`/`ts`. - For now we only run on code and not json files. This is designed such that `npm run pretty` re-formats the code for development, and when integrated with ci/cd, `prettyCheck` will return non-zero exit codes when formatting doesn't match the coding standards.
81 lines
3.0 KiB
JSON
81 lines
3.0 KiB
JSON
{
|
|
"name": "obsidian-livesync",
|
|
"version": "0.24.1",
|
|
"description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
|
|
"main": "main.js",
|
|
"type": "module",
|
|
"scripts": {
|
|
"dev": "node esbuild.config.mjs",
|
|
"build": "node esbuild.config.mjs production",
|
|
"buildDev": "node esbuild.config.mjs dev",
|
|
"lint": "eslint src",
|
|
"svelte-check": "svelte-check --tsconfig ./tsconfig.json",
|
|
"tsc-check": "tsc --noEmit",
|
|
"pretty": "npm run prettyNoWrite -- --write --log-level error",
|
|
"prettyCheck": "npm run prettyNoWrite -- --check",
|
|
"prettyNoWrite": "prettier --config ./.prettierrc \"**/*.js\" \"**/*.ts\"",
|
|
"check": "npm run lint && npm run svelte-check && npm run tsc-check"
|
|
},
|
|
"keywords": [],
|
|
"author": "vorotamoroz",
|
|
"license": "MIT",
|
|
"devDependencies": {
|
|
"@chialab/esbuild-plugin-worker": "^0.18.1",
|
|
"@tsconfig/svelte": "^5.0.4",
|
|
"@types/diff-match-patch": "^1.0.36",
|
|
"@types/node": "^22.5.4",
|
|
"@types/pouchdb": "^6.4.2",
|
|
"@types/pouchdb-adapter-http": "^6.1.6",
|
|
"@types/pouchdb-adapter-idb": "^6.1.7",
|
|
"@types/pouchdb-browser": "^6.1.5",
|
|
"@types/pouchdb-core": "^7.0.15",
|
|
"@types/pouchdb-mapreduce": "^6.1.10",
|
|
"@types/pouchdb-replication": "^6.4.7",
|
|
"@types/transform-pouch": "^1.0.6",
|
|
"@typescript-eslint/eslint-plugin": "^8.4.0",
|
|
"@typescript-eslint/parser": "^8.4.0",
|
|
"builtin-modules": "^4.0.0",
|
|
"esbuild": "0.23.1",
|
|
"esbuild-svelte": "^0.8.1",
|
|
"eslint": "^8.57.0",
|
|
"eslint-config-airbnb-base": "^15.0.0",
|
|
"eslint-plugin-import": "^2.30.0",
|
|
"events": "^3.3.0",
|
|
"obsidian": "^1.6.6",
|
|
"postcss": "^8.4.45",
|
|
"postcss-load-config": "^6.0.1",
|
|
"pouchdb-adapter-http": "^9.0.0",
|
|
"pouchdb-adapter-idb": "^9.0.0",
|
|
"pouchdb-adapter-indexeddb": "^9.0.0",
|
|
"pouchdb-core": "^9.0.0",
|
|
"pouchdb-errors": "^9.0.0",
|
|
"pouchdb-find": "^9.0.0",
|
|
"pouchdb-mapreduce": "^9.0.0",
|
|
"pouchdb-merge": "^9.0.0",
|
|
"pouchdb-replication": "^9.0.0",
|
|
"pouchdb-utils": "^9.0.0",
|
|
"prettier": "^3.3.3",
|
|
"svelte": "^4.2.19",
|
|
"svelte-preprocess": "^6.0.2",
|
|
"terser": "^5.31.6",
|
|
"transform-pouch": "^2.0.0",
|
|
"tslib": "^2.7.0",
|
|
"typescript": "^5.5.4"
|
|
},
|
|
"dependencies": {
|
|
"@aws-sdk/client-s3": "^3.645.0",
|
|
"@smithy/fetch-http-handler": "^3.2.4",
|
|
"@smithy/protocol-http": "^4.1.0",
|
|
"@smithy/querystring-builder": "^3.0.3",
|
|
"diff-match-patch": "^1.0.5",
|
|
"esbuild-plugin-inline-worker": "^0.1.1",
|
|
"fflate": "^0.8.2",
|
|
"idb": "^8.0.0",
|
|
"minimatch": "^10.0.1",
|
|
"octagonal-wheels": "^0.1.15",
|
|
"svelte-check": "^4.0.4",
|
|
"xxhash-wasm": "0.4.2",
|
|
"xxhash-wasm-102": "npm:xxhash-wasm@^1.0.2"
|
|
}
|
|
}
|