Proposal for NPM scripts naming: use 'namespaces'

[pano9000]

Hi,

just a quick request for comments, what do you think about renaming the scripts a tiny bit and introducing the idea of some sort of namespaces for them, to have them a bite more cleanly named.

E.g. here I just group these scripts by creating some sort of namespace for them, e.g. everything "server" related get's prepended with "server:", everything "electron" related -> "electron:" etc.

Essentially this way you can easily group scripts that belong to the same group and I feel like this makes organize them a bit better.

Before

    "start-server": "cross-env TRILIUM_DATA_DIR=./data TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
    "start-server-safe": "cross-env TRILIUM_DATA_DIR=./data TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
    "start-server-no-dir": "cross-env TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
    "start-test-server": "npm run switch-server && rimraf ./data-test && cross-env TRILIUM_DATA_DIR=./data-test TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev TRILIUM_PORT=9999 nodemon src/main.ts",
    "qstart-server": "npm run switch-server && npm run start-server",
    "start-electron": "npm run prepare-dist && cross-env TRILIUM_DATA_DIR=./data TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev electron ./dist/electron-main.js --inspect=5858 .",
    "start-electron-nix": "npm run prepare-dist && cross-env TRILIUM_DATA_DIR=./data TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev nix-shell -p electron_33 --run \"electron ./dist/electron-main.js --inspect=5858 .\"",
    "start-electron-no-dir": "npm run prepare-dist && cross-env TRILIUM_ENV=dev electron --inspect=5858 .",
    "start-electron-no-dir-nix": "npm run prepare-dist && cross-env TRILIUM_ENV=dev nix-shell -p electron_33 --run \"electron ./dist/electron-main.js --inspect=5858 .\"",
    "qstart-electron": "npm run switch-electron && npm run start-electron",
    "switch-server": "rimraf ./node_modules/better-sqlite3 && npm install",
    "switch-electron": "electron-rebuild",
    "build-backend-docs": "rimraf ./docs/backend_api && typedoc ./docs/backend_api src/becca/entities/*.ts src/services/backend_script_api.ts src/services/sql.ts",
    "build-frontend-docs": "rimraf ./docs/frontend_api && jsdoc -c jsdoc-conf.json -d ./docs/frontend_api src/public/app/entities/*.js src/public/app/services/frontend_script_api.js src/public/app/widgets/basic_widget.js src/public/app/widgets/note_context_aware_widget.js src/public/app/widgets/right_panel_widget.js",
    "build-docs": "npm run build-backend-docs && npm run build-frontend-docs",
    "webpack": "tsx node_modules/webpack/bin/webpack.js -c webpack.config.ts",
    "test-playwright": "playwright test",
    "test": "cross-env TRILIUM_DATA_DIR=./data-test vitest",
    "test-coverage": "cross-env TRILIUM_DATA_DIR=./data-test vitest --coverage",
    "start-electron-forge": "npm run prepare-dist && electron-forge start",
    "make-electron": "npm run webpack && npm run prepare-dist && electron-forge make",
    "package-electron": "electron-forge package",
    "prepare-dist": "rimraf ./dist && tsc && tsx ./bin/copy-dist.ts",
    "watch-dist": "tsx ./bin/watch-dist.ts",
    "update-build-info": "tsx bin/update-build-info.ts",
    "integration-edit-db": "cross-env TRILIUM_INTEGRATION_TEST=edit TRILIUM_PORT=8081 TRILIUM_ENV=dev TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
    "integration-mem-db": "cross-env TRILIUM_INTEGRATION_TEST=memory TRILIUM_PORT=8082 TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
    "integration-mem-db-dev": "cross-env TRILIUM_INTEGRATION_TEST=memory TRILIUM_PORT=8082 TRILIUM_ENV=dev TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
    "generate-document": "cross-env nodemon src/tools/generate_document.ts 1000",
    "ci-update-nightly-version": "tsx ./bin/update-nightly-version.ts",
    "prettier-check": "prettier . --check",
    "prettier-fix": "prettier . --write"

After
(ignore the errors in the actual commands: I only played aroudn with the script names so far)

  "scripts": {
    "server:start": "cross-env TRILIUM_DATA_DIR=./data TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
    "server:start-safe": "cross-env TRILIUM_DATA_DIR=./data TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
    "server:start-no-dir": "cross-env TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
    "server:start-test": "npm run switch-server && rimraf ./data-test && cross-env TRILIUM_DATA_DIR=./data-test TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev TRILIUM_PORT=9999 nodemon src/main.ts",
    "server:qstart": "npm run switch-server && npm run start-server",
    "server:switch": "rimraf ./node_modules/better-sqlite3 && npm install",

    "electron:start": "npm run prepare-dist && cross-env TRILIUM_DATA_DIR=./data TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev electron ./dist/electron-main.js --inspect=5858 .",
    "electron:start-nix": "npm run prepare-dist && cross-env TRILIUM_DATA_DIR=./data TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev nix-shell -p electron_33 --run \"electron ./dist/electron-main.js --inspect=5858 .\"",
    "electron:start-no-dir": "npm run prepare-dist && cross-env TRILIUM_ENV=dev electron --inspect=5858 .",
    "electron:start-no-dir-nix": "npm run prepare-dist && cross-env TRILIUM_ENV=dev nix-shell -p electron_33 --run \"electron ./dist/electron-main.js --inspect=5858 .\"",
    "electron:qstart": "npm run switch-electron && npm run start-electron",
    "electron:switch": "electron-rebuild",

    "electron-forge:start": "npm run prepare-dist && electron-forge start",
    "electron-forge:make": "npm run webpack && npm run prepare-dist && electron-forge make",
    "electron-forge:package": "electron-forge package",

    "docs:build-backend": "rimraf ./docs/backend_api && typedoc ./docs/backend_api src/becca/entities/*.ts src/services/backend_script_api.ts src/services/sql.ts",
    "docs:build-fontend": "rimraf ./docs/frontend_api && jsdoc -c jsdoc-conf.json -d ./docs/frontend_api src/public/app/entities/*.js src/public/app/services/frontend_script_api.js src/public/app/widgets/basic_widget.js src/public/app/widgets/note_context_aware_widget.js src/public/app/widgets/right_panel_widget.js",
    "docs:build": "npm run build-backend-docs && npm run build-frontend-docs",

    "build:prepare-dist": "rimraf ./dist && tsc && tsx ./bin/copy-dist.ts",
    "build:webpack": "tsx node_modules/webpack/bin/webpack.js -c webpack.config.ts",

    "test:playwright": "playwright test",
    "test:unit": "cross-env TRILIUM_DATA_DIR=./data-test vitest",
    "test:unit-coverage": "cross-env TRILIUM_DATA_DIR=./data-test vitest --coverage",

    "dev:watch-dist": "tsx ./bin/watch-dist.ts",
    "dev:generate-document": "cross-env nodemon src/tools/generate_document.ts 1000",
    "dev:prettier-check": "prettier . --check",
    "dev:prettier-fix": "prettier . --write",

    "chore:update-build-info": "tsx bin/update-build-info.ts",
    "integration-edit-db": "cross-env TRILIUM_INTEGRATION_TEST=edit TRILIUM_PORT=8081 TRILIUM_ENV=dev TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
    "integration-mem-db": "cross-env TRILIUM_INTEGRATION_TEST=memory TRILIUM_PORT=8082 TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
    "integration-mem-db-dev": "cross-env TRILIUM_INTEGRATION_TEST=memory TRILIUM_PORT=8082 TRILIUM_ENV=dev TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
    "ci-update-nightly-version": "tsx ./bin/update-nightly-version.ts"
  },

Of course we would need to agree on the prefixes still.

what are your thoughts?

[maphew]

Yes please. I personally prefer shorter prefixes.

I also wonder about namespaces for note scripts as opposed to file-system scripts, e.g. user. And addin-{name}, (an intermediate zone between "the {name} plugin I installed" and "adhoc, something I wrote or pasted")

[eliandoran]

We'll revisit this subject once we think of a plugin system.

[pano9000]

@maphew thanks for the reply, glad to see you supporting this – regarding the second half of your comment: I cannot comment on these, I have not looked at all into scripting with Trilium, so I am clueless about it currently.

@eliandoran do you have any opinions on this?
if there are no strong objections, I'd like to move forward with this soon-ishly :-)

[eliandoran]

@pano9000 , sure go ahead.
Feels pretty PHP-ish, but it's fine (if you ever worked with Symfony, for example).
It will take some time to get used to the change.

[pano9000]

task created, closing therefore closing the discussion
→ https://github.com/TriliumNext/Notes/issues/1175