#572: processed feedback

MaskingTechnology · Jan 3, 2025 · bf5412c · bf5412c
1 parent 699153a
commit bf5412c
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 20 deletions.
diff --git a/documentation/docs/.vitepress/config.ts b/documentation/docs/.vitepress/config.ts
@@ -51,7 +51,7 @@ export default defineConfig({
       {
         text: 'BUILD',
         items: [
-          { text: 'Settings', link: '/build/settings' },
+          { text: 'Arguments', link: '/build/arguments' },
           { text: 'Configuration', link: '/build/configuration' }
         ]
       },

diff --git a/documentation/docs/build/settings.md → documentation/docs/build/arguments.md b/documentation/docs/build/settings.md → documentation/docs/build/arguments.md
diff --git a/documentation/docs/build/configuration.md b/documentation/docs/build/configuration.md
@@ -2,8 +2,8 @@
 layout: doc
 
 prev:
-    text: Build settings
-    link: /build/settings
+    text: Build arguments
+    link: /build/arguments
 
 next:
     text: Segmentation
@@ -28,25 +28,25 @@ The `jitar.json` file is a JSON file that contains the following properties:
 }
 ```
 
+::: tip INFO
+The configuration also supports environment variables. They can be used by wrapping the variable name in `${}`. For example, `${source}`.
+```json
+{
+    "source": "${source}"
+}
+```
+:::
+
 There are four properties in the configuration file:
 * `source` - the location of the source files (default `./src`).
 * `target` - the location of the target files (default `./dist`).
 * `segments` - the location of the segment configuration files (default `./segments`).
 * `resources` - the location of the resource files (default `./resources`).
 
-::: tip NOTE
+::: tip
 For a TypeScript project, the `source` folder should be the target folder after transpilation, so it should be `./dist` instead of `./src`. The `target` folder can be the same as the `source` folder in this case, but it can also be a different folder.
 :::
 
-::: tip NOTE
+::: warning IMPORTANT
 The build process deletes the files in the `target` folder during the build process. Make sure that it doesn't point to the `src` folder.
 :::
-
-::: tip NOTE
-The configuration also supports environment variables. They can be used by wrapping the variable name in `${}`. For example, `${source}`.
-```json
-{
-    "source": "${source}"
-}
-```
-:::
diff --git a/documentation/docs/deploy/resources.md b/documentation/docs/deploy/resources.md
@@ -19,7 +19,7 @@ In Jitar's [segmentation model](/deploy/segmentation), each segment is isolated
 
 ### Resource files
 
-Jitar will search for resource definitions files in the `resources` directory. The files are named `*.json`. Each entry defines the entry point of the `module` that should be used as a resource.
+Jitar reads resource definitions files from the `resources` directory. The files are in JSON format. Each entry defines the entry point of the `module` that should be used as a resource.
 
 The file has the following structure:
 

diff --git a/documentation/docs/develop/data-sharing.md b/documentation/docs/develop/data-sharing.md
@@ -153,11 +153,11 @@ import { modify } from './modify';
 export async function test(): Promise<void>
 {
     // create new instance
-    const original = new Person( 'John Doe', 42);
+    const person = new Person( 'John Doe', 42);
 
-    const copy = await modify(original);
+    await modify(person);
 
-    console.log(copy);
+    console.log(person);
 }
 ```
 

diff --git a/documentation/docs/develop/debugging.md b/documentation/docs/develop/debugging.md
@@ -6,8 +6,8 @@ prev:
     link: /develop/assets
 
 next:
-    text: Build settings
-    link: /build/settings
+    text: Build arguments
+    link: /build/arguments
 
 ---
 

diff --git a/packages/build/src/source/module/LocationRewriter.ts b/packages/build/src/source/module/LocationRewriter.ts
@@ -4,6 +4,9 @@ import type { FileManager } from '@jitar/sourcing';
 
 import { FileHelper, LocationReplacer } from '../../utils';
 
+// The location rewriter ensures the '.js' for all application imports and re-exports
+// and appends the 'index.js' reference for all directory imports.
+
 export default class LocationRewriter
 {
     readonly #sourceFileManager: FileManager;

diff --git a/packages/sourcing/src/LocalFileSystem.ts b/packages/sourcing/src/LocalFileSystem.ts
@@ -26,6 +26,9 @@ export default class LocalFileSystem implements FileSystem
     // This method is synchronous because it's used in the
     // LocationRewriter. This class uses a replacer function
     // in a replaceAll method that only accepts synchronous functions.
+
+    // This is a limitation of the current implementation and must be
+    // addressed in the future.
     isDirectory(location: string): boolean
     {
         try