1678-project-directory

.changeset/config.json

@@ -4,5 +4,5 @@
 	"commit": false,
 	"access": "restricted",
 	"baseBranch": "main",
-	"ignore": ["template-*"]
+	"ignore": ["@inlang/template-*"]
 }

.changeset/pink-snails-fold.md

@@ -0,0 +1,5 @@
+---
+"@inlang/cli": major
+---
+
+BREAKING: `inlang project validate` is now only `inlang validate` see https://github.com/inlang/monorepo/issues/1777

.changeset/popular-meals-own.md

@@ -0,0 +1,5 @@
+---
+"@inlang/sdk": minor
+---
+
+BREAKING refactor: rename `openProject({ settingsFilePath })` to `openProject({ projectPath })` to align with new project directory structure

.changeset/silent-hotels-ring.md

@@ -0,0 +1,10 @@
+---
+"@inlang/cli": major
+---
+
+REFACTOR: --project paths now need to end with .inlang
+
+```diff
+-inlang machine translate --project ../project.inlang.json
++inlang machine translate --project ../project.inlang
+```

.vscode/launch.json

@@ -1,6 +1,17 @@
 {
 	"version": "0.2.0",
 	"configurations": [
+		{
+			"name": "Debug Current Test File",
+			"type": "node",
+			"request": "launch",
+			"autoAttachChildProcesses": true,
+			"skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+			"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
+			"args": ["run", "${relativeFile}"],
+			"smartStep": true,
+			"console": "integratedTerminal"
+		},
 		{
 			"name": "debug ide-extension",
 			"type": "extensionHost",

README.md

@@ -37,10 +37,10 @@
 
 ## Table of Contents
 
-- [About inlang](#-about-inlang)
-- [Getting Started](#zap-getting-started)
-- [Stay up-to-date](#bell-stay-up-to-date)
-- [Contributing](#balloon-contributing)
+- [Table of Contents](#table-of-contents)
+- [🌐 About inlang](#-about-inlang)
+- [:bell: Stay up-to-date](#bell-stay-up-to-date)
+- [:balloon: Contributing](#balloon-contributing)
 
 ## 🌐 About inlang
 
@@ -55,30 +55,6 @@
 
 **Go to [inlang.com](https://inlang.com) to see all extensions to the inlang ecosystem.**
 
-## :zap: Getting Started
-
-It's fairly easy. You need two things to use inlang with any project:
-
-1. A `project.inlang.json` file in the root of your project
-2. A plugin that reads and writes the i18n messages of your project, we currently support [i18next](https://inlang.com/m/3i8bor92/plugin-inlang-i18next), [plain json](https://inlang.com/m/ig84ng0o/plugin-inlang-json) or [inlang message format](https://inlang.com/m/reootnfj/plugin-inlang-messageFormat).
-3. 🏁 Done!
-4. *Optional: Setup [lint rules](https://inlang.com/c/lint-rules), machine translation, ...*
-
-Example `project.inlang.json`
-```json
-{
-	"$schema": "https://inlang.com/schema/project-settings",
-	"sourceLanguageTag": "en",
-	"languageTags": ["en", "de", "it"],
-	"modules": [
-		"https://cdn.jsdelivr.net/npm/@inlang/plugin-json@4/dist/index.js"
-	],
-	"plugin.inlang.json": {
-		"pathPattern": "./resources/{languageTag}.json"
-	}
-}
-```
-
 **More specific guides:**
 
 - Guide: [How to setup inlang for your project](https://inlang.com/g/49fn9ggo/guide-niklasbuchfink-howToSetupInlang#)

inlang/documentation/concept/project.md

@@ -1,24 +1,9 @@
 # Project
 
-An inlang project is defined by a file that is named `project.inlang.json`. The file contains the settings for a project and is the entrypoint for all applications, plugins, and tools in the inlang ecosystem.
+An inlang project is defined by a directory that emulates a file `{name}.inlang`. The directory contains the settings for a project and is the entrypoint for all applications, plugins, and tools in the inlang ecosystem.
 
 Visit the [setup inlang guide](/g/49fn9ggo/guide-niklasbuchfink-howToSetupInlang) to learn how to create a new project.
 
 ![inlang project](https://cdn.jsdelivr.net/gh/inlang/monorepo/inlang/documentation/assets/project.jpg)
 
-## Project configuration file schema
 
-The `project.inlang.json` file must contain the following JSON:
-
-```ts
-{
-  // the schema version of the project file
-  "$schema": "https://inlang.com/schema/project-settings",
-  // the "source" language tag that is used in your project
-  "sourceLanguageTag": string,
-  // all the language tags you want to support in your project
-  "languageTags": Array<string>,
-  // the modules that are used in the project
-  "modules": Array<string>,
-}
-```

inlang/documentation/how-to/build-app.md

@@ -10,7 +10,7 @@ Open a repository locally or with [lix](https://github.com/inlang/monorepo/blob/
 
 ### 2. Open project
 
-After opening the repository, you're able to find the files inside. Usually, the `project.inlang.json` file is located in the root of the repository. Reading the file enables you to load the project configuration into your app.
+After opening the repository, you're able to find the files inside. Usually, the `*.inlang` directory is located in the root of the repository. Reading the file enables you to load the project configuration into your app.
 
 ### 3. Use the APIs from the SDK
 

inlang/guides/build-a-global-svelte-app/build-a-global-svelte-app.md

@@ -63,7 +63,7 @@ export default defineConfig({
 	// ...
     sveltekit(),
     paraglide({
-      project: "./project.inlang.json",
+      project: "./project.inlang",
       outdir: "./src/paraglide",
     }),
   ],
@@ -260,7 +260,7 @@ We need to import a few things in pages before we can use translations. You need
 ```
 Now you can proceed with adding messages.
 
-The default path for translation files are in the `./messages` directory. You can change this option in `project.inlang.json`. Here are the two ways you can add translations:
+The default path for translation files are in the `./messages` directory. You can change this option in `project.inlang/settings.json`. Here are the two ways you can add translations:
 
 
 ### Add messages through ide extension (recommended)
@@ -277,12 +277,12 @@ message. Give the message an ID and hit enter.
 
 - This command extracts the hard-coded string and places it into the source language translation file `en.json` in the `messages` directory.
 
-- Compile translation `npx paraglide-js compile --project ./project.inlang.json`
+- Compile translation `npx paraglide-js compile --project ./project.inlang`
 
 
 ### Add messages manually
 
-- Go to the `messages` directory and create a `en.json` file in it. (Make sure the naming is according to the [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language tags in the `project.inlang.json`)
+- Go to the `messages` directory and create a `en.json` file in it. (Make sure the naming is according to the [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language tags in the `project.inlang`)
 
 - Add a message in the file.
 ```json
@@ -294,7 +294,7 @@ message. Give the message an ID and hit enter.
 ```
 
 
-- Compile translation `npx paraglide-js compile --project ./project.inlang.json`
+- Compile translation `npx paraglide-js compile --project ./project.inlang`
 
 
 ## 5. See Paraglide JS in action

inlang/guides/how-to-inlang-app/how-to-inlang-app.md

@@ -12,7 +12,7 @@ The first step is to initialize your project using the Inlang SDK. The `loadProj
 import { loadProject } from '@inlang/sdk';
 
 const inlang = loadProject({
-    settingsFilePath: "user/project/project.inlang.json"
+    projectPath: "user/project.inlang"
     nodeishFs // NodeishFs is a wrapper around the Node.js fs module
 });
 ```

inlang/guides/what-are-plugins/what-are-plugins.md

@@ -12,10 +12,9 @@ If you're setting up inlang for your project, you've probably read that you need
 ### Why are plugins great?
 Inlang project architecture is more flexible with the use of plugins. This means that you can use it without having to switch to another storage solution. You can customize and expand app or project behaviors easily. This gives you more freedom and keeps adoption costs low.
 
-### How can I add plugins?
-Here are two ways to do this:
-- You can use the web interface by going to a plugin page, such as the [message-format plugin](https://inlang.com/m/reootnfj/plugin-inlang-messageFormat), and clicking on `Install Plugin`. Then, you'll need to add the repo URL. This will automatically install the plugin into your `project.inlang.json` file. Please note that a `project.inlang.json` file is required for this method. Under the hood this creates a pull request.
--  Alternatively, you can add the plugin manually by referring to the [Getting started guide](https://inlang.com/g/49fn9ggo/guide-niklasbuchfink-howToSetupInlang).
+### How can I install plugins?
+
+Go to https://inlang.com/c/plugins and click install. 
 
 ### Links
 -> Look for plugins at [inlang.com](https://inlang.com/c/application)

inlang/source-code/badge/src/badge.ts

@@ -30,17 +30,8 @@ export const badge = async (url: string) => {
 		nodeishFs: createNodeishMemoryFs(),
 	})
 
-	// Settings file path has to be absolute
-	const settingsFilePath = "/project.inlang.json"
-
-	// Get the content of the project.inlang.json file
-	await repo.nodeishFs.readFile(settingsFilePath, { encoding: "utf-8" }).catch((e) => {
-		if (e.code !== "ENOENT") throw e
-		throw new Error("No project.inlang.json file found in the repository.")
-	})
-
 	const project = await loadProject({
-		settingsFilePath,
+		projectPath: "/project.inlang",
 		nodeishFs: repo.nodeishFs,
 		_capture(id, props) {
 			telemetryNode.capture({