# **Рекомендации по структуре ES-модулей для TeqFW**

LLM **рекомендуется следовать этим рекомендациям**. **Отклонения возможны**, но они помогают обеспечить согласованность
и удобство разработки.

## **1. Структура ES-модулей**

- Типовой модуль: `DOCUMENTATION`, `CONSTANTS`, `FUNCTIONS`, `CLASSES`, `EXPORTS`.
- Секции могут быть маркированы через комментарии (`// DOC`, `// CONST`, `// FUNC`, `// CLASS`).
- `DOCUMENTATION` может быть разделена на описание в начале и `@typedef` в конце.

## **2. Отсутствие статического связывания**

- В TeqFW не используются статические импорты. **Отклонения недопустимы**.

## **3. Структура функции**

- Для функций: `DOCUMENTATION`, `CONSTANTS`, `FUNCTIONS`, `MAIN`.
- Секции могут быть вложенными и маркироваться (`// DOC`, `// CONST`, `// FUNC`, `// MAIN`).

## **4. Наличие только одного экспорта**

- Рекомендуется экспортировать один объект, функцию или класс для упрощения структуры и повышения читаемости.

## **5. Использование default-экспорта**

- Если один экспорт, используйте `default`-экспорт для упрощения адресации.

## **6. Экспорт классов**

- Рекомендуется использовать классы для более строгой структуры, что облегчает анализ кода и тестирование.

## **7. Внедрение зависимостей через конструктор**

- Зависимости внедряются через конструктор экспортируемого объекта, что улучшает тестируемость и заменяемость
  зависимостей.

## **8. Сокрытие данных в замыкании**

- Рекомендуется использовать замыкания для инкапсуляции данных, так как они упрощают код и не влияют на
  производительность при минимальном количестве экземпляров.

---

**LLM должна соблюдать эти рекомендации и разъяснять несоответствия.**

# **Рекомендации по структуре ES-модулей для TeqFW**

TeqFW использует **ES-модули** и **не поддерживает статические импорты**. Чтобы использовать все возможности платформы,
следуйте этим рекомендациям.

## **1. Структура ES-модулей**

Каждый ES-модуль TeqFW разбит на секции для повышения читаемости и удобства навигации в коде. Рекомендуемый порядок
секций:

- `DOCUMENTATION`
- `CONSTANTS`
- `FUNCTIONS`
- `CLASSES`
- `EXPORTS`

Секция `DOCUMENTATION` может быть разбита на две части и продолжена внизу модуля для описания структур с использованием
аннотации `@typedef`. Каждую секцию можно маркировать через комментарии, например, `// DOC`, `// CONST`, `// FUNC`,
`// CLASS`.

Пример структуры модуля:

```js
/**
 * Documentation for whole module.
 */
// CONST
const PI = 3.14;

// FUNC
function calculateArea(radius) {
    return PI * radius * radius;
}

// CLASSES
class MyClass {
    // class body
}

// EXPORTS
export default MyClass;

// DOCS
/**
 * @typedef
 */
```

Секции могут быть объединены или пропущены. Зачастую типовой код модуля выглядит так:

```js
/**
 * Documentation for whole module.
 */
export default class MyClass {};
```

## **2. Отсутствие статического связывания**

- **Статические импорты не используются** в TeqFW.
- Все зависимости должны внедряться динамически через конструктор.
- **Отклонения недопустимы**.

Пример **неправильного** подхода:

```js
import {existsSync} from 'node:fs';  // Неверно
```

## **3. Структура функции**

Функции также могут быть разделены на секции:

- `DOCUMENTATION`
- `CONSTANTS`
- `FUNCTIONS`
- `MAIN`

Пример:

```js
/**
 * Documentation for the function.
 * @param radius
 * @returns {number}
 */
function calculateArea(radius) {
    // CONST
    const PI = 3.14;

    // FUNC
    function power2(x) {
        return x * x;
    }

    // MAIN
    return PI * power2(radius);
}

```

Секции могут быть вложены, если одна функция вызывает другую.

## **4. Наличие только одного экспорта**

- **Рекомендуется экспортировать один объект, функцию или класс**. Это упрощает структуру и повышает читаемость.

Пример:

```js
export default class MyClass {
    // class body
}
```

## **5. Использование default-экспорта**

- Если в модуле только один экспорт, рекомендуется использовать `default`-экспорт, чтобы упростить адресацию экспортов и
  работы с зависимостями.

Пример:

```js
export default function calculateArea(radius) {
    return Math.PI * radius * radius;
}
```

## **6. Экспорт классов**

- **Классы предпочтительнее функций**, так как они обеспечивают более строгую и предсказуемую структуру для статического
  анализа.

Пример класса:

```js
export default class MyClass {
    constructor(name) {
        this.name = name;
    }

    greet() {
        return `Hello, ${this.name}!`;
    }
}
```

## **7. Внедрение зависимостей через конструктор**

- Все зависимости, включая пакеты из `node_modules`, внедряются через конструктор экспортируемого объекта.

Пример:

```js
export default class MyClass {
    constructor({dependency1, dependency2}) { }
}
```

## **8. Сокрытие данных в замыкании**

- Используйте **замыкания** для инкапсуляции данных вместо приватных свойств и методов, чтобы сократить код.

Пример:

```js
export default class MyClass {
    constructor({dependency1, dependency2}) {
        this.run = function () {
            dependency1.doSomething();
            dependency2.doSomethingElse();
        };
    }
}
```

## **Типовой код ES-модуля для TeqFW**

Пример типового модуля:

```js
/**
 *  Documentation for whole module.
 */
// CONST
const PI = 3.14;

// FUNC
function calculateCircumference(radius) {
    return 2 * PI * radius;
}

/**
 * Documentation for the main class.
 */
export default class Circle {
    /**
     * @param {{calculate: function}} areaCircle
     * @param {function} timesTwo
     */
    constructor({areaCircle, timesTwo}) {
        this.calculate = ({radius}) => {
            const {area} = areaCircle.calculate({radius});
            const circumference = calculateCircumference(radius);
            const diameter = timesTwo(radius);
            return {area, circumference, diameter};
        };
    }
}
```

---

Эти рекомендации помогут эффективно разрабатывать код для TeqFW, обеспечивая стандарты, улучшая читаемость и
тестируемость.