[SYNC] Adding save/load of dynamic data, extending linting options (#9)

README.md

@@ -95,6 +95,11 @@ Optimizations, quality and logics updates are welcome.
 - [parse](cli/parse/README.md) - parsing utils to collect documentation or JSON summaries
 - `help` - print list of commands and information about them
 
+## 💿 Build
+
+Script engine can be packaged and built into custom game package.<br/>
+Detailed description: [link](doc/BUILDING_CUSTOM_GAME_PACKAGE.md)
+
 ---
 
 ## 🧰 Docs
@@ -104,7 +109,11 @@ Optimizations, quality and logics updates are welcome.
 
 ## 🏗️ Assets
 
+Additional assets repository can be cloned manually or with shortcut command: <br/>
+`npm run cli clone *name*` (`extended`, `locale-eng`, `locale-ukr`, `locale-rus`)
+
 - Extended assets: [https://gitlab.com/xray-forge/stalker-xrf-resources-extended](https://gitlab.com/xray-forge/stalker-xrf-resources-extended)
 - EN locale assets: [https://gitlab.com/xray-forge/stalker-xrf-resources-locale-eng](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-eng)
 - UA locale assets: [https://gitlab.com/xray-forge/stalker-xrf-resources-locale-ukr](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-ukr)
 - RU locale assets: [https://gitlab.com/xray-forge/stalker-xrf-resources-locale-rus](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-rus)
+

cli/build/steps/configs_dynamic.ts

@@ -67,6 +67,9 @@ export async function buildDynamicConfigs(parameters: IBuildCommandParameters):
  * Get list of LTX transformable descriptors.
  */
 async function getLtxConfigs(filters: Array<string> = []): Promise<Array<TFolderReplicationDescriptor>> {
+  /**
+   * todo;
+   */
   function collectLtxConfigs(
     acc: Array<TFolderReplicationDescriptor>,
     it: TFolderFiles

cli/build/steps/configs_statics.ts

@@ -53,6 +53,9 @@ export async function buildStaticConfigs(parameters: IBuildCommandParameters): P
  * Get list of static configs.
  */
 async function getStaticConfigs(filters: Array<string> = []): Promise<Array<TFolderReplicationDescriptor>> {
+  /**
+   * todo;
+   */
   function collectConfigs(
     acc: Array<TFolderReplicationDescriptor>,
     it: TFolderFiles

cli/build/steps/meta.ts

@@ -17,9 +17,6 @@ interface IBuildMetaParams {
 
 /**
  * Step to collect metadata in a single file with timing metrics.
- *
- * @param meta - build meta information to save
- * @param timeTracker - build time tracker with performance metrics
  */
 export async function buildMeta({ meta, timeTracker }: IBuildMetaParams): Promise<void> {
   log.info(blueBright("Build metadata"));

cli/build/steps/translations_dynamic.ts

@@ -35,6 +35,9 @@ export async function buildDynamicTranslations(): Promise<void> {
     return log.warn("No languages to translate found in config.json file, skip");
   }
 
+  /**
+   * todo;
+   */
   function collectTranslations(
     acc: Array<TFolderReplicationDescriptor>,
     it: TFolderFiles

cli/build/steps/ui_dynamic.ts

@@ -63,6 +63,9 @@ export async function buildDynamicUi(parameters: IBuildCommandParameters): Promi
  * Get list of UI config files in engine source files.
  */
 async function getUiConfigs(filters: Array<string> = []): Promise<Array<TFolderReplicationDescriptor>> {
+  /**
+   * todo;
+   */
   function collectXmlConfigs(
     acc: Array<TFolderReplicationDescriptor>,
     it: TFolderFiles

cli/build/steps/ui_statics.ts

@@ -51,6 +51,9 @@ export async function buildStaticUi(parameters: IBuildCommandParameters): Promis
  * Get UI configuration files list.
  */
 async function getUiConfigs(filters: Array<string> = []): Promise<Array<TFolderReplicationDescriptor>> {
+  /**
+   * todo;
+   */
   function collectXmlConfigs(
     acc: Array<TFolderReplicationDescriptor>,
     it: Array<string> | string

cli/format/format_ltx.ts

@@ -49,6 +49,9 @@ async function formatLtxFile(file: string): Promise<void> {
  * Get list of static configs.
  */
 async function getLtxConfigs(filters: Array<string> = []): Promise<Array<string>> {
+  /**
+   * todo;
+   */
   function collectConfigs(acc: Array<string>, it: TFolderFiles): Array<string> {
     if (Array.isArray(it)) {
       it.forEach((nested) => collectConfigs(acc, nested));

cli/parse/parse_externals.ts

@@ -47,6 +47,9 @@ export async function parseExternals(): Promise<void> {
  * Get list of LTX transformable descriptors.
  */
 async function getSourcesList(source: string): Promise<Array<string>> {
+  /**
+   * todo;
+   */
   function collectList(acc: Array<string>, it: TFolderFiles): Array<string> {
     if (Array.isArray(it)) {
       it.forEach((nested) => collectList(acc, nested));

cli/parse/utils/__test__/declaration.ts

@@ -10,8 +10,14 @@ interface IAbstractInterface {
   b: string;
 }
 
+/**
+ * todo;
+ */
 function extern(name: string, cb: (...args: Array<unknown>) => void): void {}
 
+/**
+ * todo;
+ */
 function another(name: string, cb: (...args: Array<unknown>) => void): void {}
 
 extern("module.callback_name_one", (a: number, b: string, c: boolean, d: SomeAlias): boolean => true);

cli/preview/preview.ts

@@ -98,7 +98,13 @@ function createFoldersForConfigs(xmlConfigs: Array<TFolderReplicationDescriptor>
   });
 }
 
+/**
+ * todo;
+ */
 async function getUiConfigs(filters: Array<string> = []): Promise<Array<TFolderReplicationDescriptor>> {
+  /**
+   * todo;
+   */
   function collectXmlConfigs(
     acc: Array<TFolderReplicationDescriptor>,
     it: TFolderFiles

cli/preview/utils/generate_preview.ts

@@ -2,6 +2,9 @@ import { default as jsdom } from "jsdom";
 
 const { style, STATIC_ASSET, GRADIENT_BG_, GENERIC } = generateDomClasses();
 
+/**
+ *
+ */
 export function generateHTMLPreviewFromXMLString(content: string): string {
   const dom = new jsdom.JSDOM(content);
 
@@ -58,10 +61,16 @@ export function generateHTMLPreviewFromXMLString(content: string): string {
   return dom.serialize();
 }
 
+/**
+ *
+ */
 function prepareOther(node: HTMLElement): void {
   node.style.border = "solid black 1px";
 }
 
+/**
+ *
+ */
 function prepareText(node: HTMLElement): void {
   node.style.overflow = "hidden";
   node.style.width = "100%";
@@ -74,6 +83,9 @@ function prepareText(node: HTMLElement): void {
   }
 }
 
+/**
+ *
+ */
 function prepareTexture(node: HTMLElement): void {
   node.setAttribute("texture_resource", node.textContent);
 
@@ -84,15 +96,24 @@ function prepareTexture(node: HTMLElement): void {
   node.style.height = "100%";
 }
 
+/**
+ *
+ */
 function prepareWindow(node: HTMLElement): void {
   node.style.position = "absolute";
   node.style.background = "rgba(50, 50, 50, 0.05)";
 }
 
+/**
+ *
+ */
 function prepareStaticAsset(node: HTMLElement): void {
   node.className = STATIC_ASSET + " " + GRADIENT_BG_ + Math.floor(Math.random() * 10);
 }
 
+/**
+ *
+ */
 function generateDomClasses() {
   const GENERIC: string = "generic";
   const STATIC_ASSET: string = "static-asset";
@@ -144,6 +165,9 @@ function generateDomClasses() {
   };
 }
 
+/**
+ * todo;
+ */
 function getRandomColor(): string {
   return "#" + (((1 << 24) * Math.random()) | 0).toString(16).padStart(6, "0");
 }

cli/utils/fs/get_diffs.ts

@@ -31,10 +31,16 @@ export interface IDiffs {
   deletions: IDiff;
 }
 
+/**
+ * todo;
+ */
 function getTime(dateOrDateStr: Date | string): number {
   return typeof dateOrDateStr === "string" ? Date.parse(dateOrDateStr) : dateOrDateStr.getTime();
 }
 
+/**
+ * todo;
+ */
 async function ensureDirAccess(directory: string): Promise<void> {
   try {
     await fsp.access(directory);
@@ -43,6 +49,11 @@ async function ensureDirAccess(directory: string): Promise<void> {
   }
 }
 
+/**
+ * todo;
+ *
+ * @yields - files from directory in a recursive way
+ */
 async function* getFiles(directory: string): AsyncGenerator<string> {
   const dirents = await fsp.readdir(directory, { withFileTypes: true });
 
@@ -54,6 +65,9 @@ async function* getFiles(directory: string): AsyncGenerator<string> {
   }
 }
 
+/**
+ * todo;
+ */
 async function getFileStats(directory: string, options): Promise<FileStats> {
   const dir = path.resolve(directory);
 
@@ -85,6 +99,9 @@ async function getFileStats(directory: string, options): Promise<FileStats> {
   return fileStats;
 }
 
+/**
+ * todo;
+ */
 export async function getDiffs(base: FilePathMap, target: FilePathMap, options?: DiffOptions): Promise<IDiffs> {
   const { exclusions = [], compareSizes = true } = options || {};
   const statsOptions = { exclusions };

cli/utils/fs/open_folder_in_explorer.ts

@@ -1,6 +1,9 @@
 import * as cp from "child_process";
 import * as os from "os";
 
+/**
+ * todo;
+ */
 export function openFolderInExplorer(path: string): Promise<void> {
   return new Promise((resolve, reject) => {
     const osType: string = os.type();

cli/utils/fs/read_dir_content.ts

@@ -8,9 +8,7 @@ import { TDirectoryFilesTree } from "#/utils/fs/types";
  */
 export async function readDirContent(dirPath: string): Promise<TDirectoryFilesTree> {
   return (await Promise.all(
-    (
-      await fs.readdir(dirPath, { withFileTypes: true })
-    ).map(async (dirent) => {
+    (await fs.readdir(dirPath, { withFileTypes: true })).map(async (dirent) => {
       const it = path.join(dirPath, dirent.name);
 
       return dirent.isDirectory() ? await readDirContent(it) : it;

cli/utils/fs/read_dir_content_flat.ts

@@ -6,9 +6,7 @@ import * as path from "path";
  */
 export async function readDirContentFlat(dirPath: string, container: Array<string> = []): Promise<Array<string>> {
   await Promise.all(
-    (
-      await fs.readdir(dirPath, { withFileTypes: true })
-    ).map(async (dirent) => {
+    (await fs.readdir(dirPath, { withFileTypes: true })).map(async (dirent) => {
       const it = path.join(dirPath, dirent.name);
 
       if (dirent.isDirectory()) {

cli/utils/fs/read_dir_content_flat_gen.ts

@@ -1,6 +1,12 @@
-import fsp from "fs/promises";
-import path from "path";
+import * as fsp from "fs/promises";
+import * as path from "path";
 
+/**
+ * Read folder content with generator.
+ *
+ * @param directory - target folder to traverse
+ * @yields next item in directory
+ */
 export async function* readFolderGen(directory: string) {
   const dirents = await fsp.readdir(directory, { withFileTypes: true });
 

cli/utils/fs/read_last_lines_of_file.ts

@@ -6,6 +6,9 @@ import { Optional } from "#/utils/types";
 
 const NEW_LINE_CHARACTERS: Array<string> = ["\n"];
 
+/**
+ * todo;
+ */
 export async function readLastLinesOfFile(
   filePath: string,
   maxLineCount: number,

doc/BUILDING_CUSTOM_GAME_PACKAGE.md

@@ -10,7 +10,7 @@ and bundled together with custom engine.
 
 Comparing to normal gamedata builds the only needed thing is full assets list. <br/>
 To build package you will need [extended](https://gitlab.com/xray-forge/stalker-xrf-resources-extended) assets
-and one of locales packs, for example [en](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-en). <br/>
+and one of locales packs, for example [eng](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-eng). <br/>
 
 After cloning suggested repositories or providing custom assets, you should list them in 'config.json' if paths are different from already suggested.
 
@@ -19,10 +19,10 @@ After cloning suggested repositories or providing custom assets, you should list
 If assets are downloaded and configured correctly, the only needed thing is:
 
 ```
-npm run cli pack game -- --clean --build --optimize
+npm run cli pack game -- --clean --optimize
 
 # or
-npm run cli pack game -- -c -b -o
+npm run cli pack game -- -c -o
 
 # or
 npm run pack:game

doc/TODO.md

@@ -13,6 +13,7 @@
 
 ## 🧰 Requests to open x-ray
 
+- Add callback notifying about game save to get filename
 - With lua bindings generation include all call overrides when output TXT
 - Export actor menu and actor menu item classes for overriding with lua
 - Fix numerous calls to disk with menu, implement caching for character menu and fix lags when opening inventory