Formulate the agreement on version numbers and dependent references between modules

[normal-coder]

Problem

Currently, the monorepo solution is used to manage the project, but because some modules have not been published to npm and the agreed version is declared, it cannot run smoothly locally. It takes a series of attempts to get it to work.

Proposal

Make a convention, declare it in the project README.md, and implement it in each module. Including but not limited to:

• Module version number related dependencies
• Reference conventions between modules (how to complete local environment development)
• For packages that have not been published to npm, what is the specific planned release rhythm?

Additional information

• This will help more developers quickly use Inlang in the short term, develop more features or report bugs
• Invaluable for engineering management and more efficient development of projects.

[samuelstroschein]

Hi @normal-coder,

What issues did you face when running the monorepo?

From https://inlang.com/documentation/contributing, the only steps you need to do are:

1. npm install
2. npm run dev

Nothing else is required.

---

Make a convention, declare it in the project README.md, and implement it in each module. Including but not limited to:
Module version number related dependencies

The module version number is always the latest, indicated by * in the package.json files. Not having to declare the version number is one of the main benefits of monorepos. The latest version is always used and thereby tested, surfacing regression bugs quickly.

Reference conventions between modules (how to complete local environment development)

npm run dev works across the entire monorepo.

For packages that have not been published to npm, what is the specific planned release rhythm?

None. The packages are bundled by consuming packages and therefore obey to the release schedule of the consuming apps.

[normal-coder]

@inlang/sdk-js:dev: [tsc:watch  ]
@inlang/ide-extension-plugin:dev: [dev:test ]
@inlang/ide-extension-plugin:dev: [dev:test ]  DEV  v0.29.8 /Users/normal/github/inlang/inlang/source-code/ide-extension-plugin
@inlang/ide-extension-plugin:dev: [dev:test ]
@inlang/server:dev: node:internal/process/esm_loader:97
@inlang/server:dev:     internalBinding('errors').triggerUncaughtException(
@inlang/server:dev:                               ^
@inlang/server:dev:
@inlang/server:dev: Error [ERR_MODULE_NOT_FOUND]: Cannot find package '/Users/normal/github/inlang/inlang/source-code-git/client/node_modules/isomorphic-git/' imported from /Users/normal/github/inlang/inlang/source-code-git/client/dist/raw/index.js
@inlang/server:dev: Did you mean to import isomorphic-git/index.cjs?
@inlang/server:dev:     at __node_internal_captureLargerStackTrace (node:internal/errors:478:5)
@inlang/server:dev:     at new NodeError (node:internal/errors:387:5)
@inlang/server:dev:     at legacyMainResolve (node:internal/modules/esm/resolve:242:9)
@inlang/server:dev:     at packageResolve (node:internal/modules/esm/resolve:839:14)
@inlang/server:dev:     at moduleResolve (node:internal/modules/esm/resolve:901:20)
@inlang/server:dev:     at defaultResolve (node:internal/modules/esm/resolve:1115:11)
@inlang/server:dev:     at nextResolve (node:internal/modules/esm/loader:163:28)
@inlang/server:dev:     at u (file:///Users/normal/github/inlang/inlang/node_modules/@esbuild-kit/esm-loader/dist/index.js:1:2406)
@inlang/server:dev:     at nextResolve (node:internal/modules/esm/loader:163:28)
@inlang/server:dev:     at ESMLoader.resolve (node:internal/modules/esm/loader:841:30)
@inlang/server:dev:     at ESMLoader.getModuleJob (node:internal/modules/esm/loader:424:18)
@inlang/server:dev:     at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:76:40)
@inlang/server:dev:     at link (node:internal/modules/esm/module_job:75:36) {
@inlang/server:dev:   code: 'ERR_MODULE_NOT_FOUND'
@inlang/server:dev: }
@inlang/server:dev: npm ERR! Lifecycle script `dev` failed with error:
@inlang/server:dev: npm ERR! Error: command failed
@inlang/server:dev: npm ERR!   in workspace: @inlang/server
@inlang/server:dev: npm ERR!   at location: /Users/normal/github/inlang/inlang/source-code/server
@inlang/server:dev: ERROR: command finished with error: command (/Users/normal/github/inlang/inlang/source-code/server) npm run dev exited (1)
@inlang/env-variables:dev: 💡 Some env variables are not defined. Fetching public env variables remotely...
@inlang/env-variables:dev: [
@inlang/env-variables:dev:   { key: 'SESSION_COOKIE_SECRET', errorMessage: 'Required' },
@inlang/env-variables:dev:   { key: 'JWE_SECRET', errorMessage: 'Required' },
@inlang/env-variables:dev:   { key: 'GITHUB_APP_CLIENT_SECRET', errorMessage: 'Required' },
@inlang/env-variables:dev:   { key: 'PUBLIC_GITHUB_APP_CLIENT_ID', errorMessage: 'Required' },
@inlang/env-variables:dev:   { key: 'PUBLIC_GIT_PROXY_PATH', errorMessage: 'Required' },
@inlang/env-variables:dev:   { key: 'PUBLIC_SERVER_BASE_URL', errorMessage: 'Required' }
@inlang/env-variables:dev: ]
@inlang/env-variables:dev: ❌ Failed to fetch public env variables remotely.  /Users/normal/github/inlang/inlang/source-code/env-variables/src/build/fetchPublicEnv.ts:14
@inlang/env-variables:dev: 		const response = await fetch(
@inlang/env-variables:dev: 		                 ^
@inlang/env-variables:dev:
@inlang/env-variables:dev: ReferenceError: fetch is not defined
@inlang/env-variables:dev:     at fetchPublicEnv (/Users/normal/github/inlang/inlang/source-code/env-variables/src/build/fetchPublicEnv.ts:14:20)
@inlang/env-variables:dev:     at <anonymous> (/Users/normal/github/inlang/inlang/source-code/env-variables/build.ts:18:8)
@inlang/env-variables:dev:     at ModuleJob.run (node:internal/modules/esm/module_job:193:25)
@inlang/env-variables:dev:     at async Promise.all (index 0)
@inlang/env-variables:dev:     at async ESMLoader.import (node:internal/modules/esm/loader:530:24)
@inlang/env-variables:dev:     at async loadESM (node:internal/process/esm_loader:91:5)
@inlang/env-variables:dev:     at async handleMainPromise (node:internal/modules/run_main:65:12)
@inlang/env-variables:dev: npm ERR! Lifecycle script `dev` failed with error:
@inlang/env-variables:dev: npm ERR! Error: command failed
@inlang/env-variables:dev: npm ERR!   in workspace: @inlang/env-variables
@inlang/env-variables:dev: npm ERR!   at location: /Users/normal/github/inlang/inlang/source-code/env-variables
command (/Users/normal/github/inlang/inlang/source-code/server) npm run dev exited (1)

 Tasks:    0 successful, 12 total
Cached:    0 cached, 12 total
  Time:    8.926s

 ERROR  run failed: command  exited (1)
➜  inlang git:(main)

I tried using npm, but it failed.

[samuelstroschein]

@normal-coder You are using an unsupported node version. Please follow the getting started guide at https://github.com/inlang/inlang/blob/main/CONTRIBUTING.md.

FYI besides that, we also have a problem right now with the dev script. See https://discord.com/channels/897438559458430986/1085193211577897070/1107571901146071090