Samet Digital : Base Common [Component]

▗▄▄▖  ▗▄▖  ▗▄▄▖▗▄▄▄▖     ▗▄▄▖ ▗▄▖ ▗▖  ▗▖▗▖  ▗▖ ▗▄▖ ▗▖  ▗▖
▐▌ ▐▌▐▌ ▐▌▐▌   ▐▌       ▐▌   ▐▌ ▐▌▐▛▚▞▜▌▐▛▚▞▜▌▐▌ ▐▌▐▛▚▖▐▌
▐▛▀▚▖▐▛▀▜▌ ▝▀▚▖▐▛▀▀▘    ▐▌   ▐▌ ▐▌▐▌  ▐▌▐▌  ▐▌▐▌ ▐▌▐▌ ▝▜▌
▐▙▄▞▘▐▌ ▐▌▗▄▄▞▘▐▙▄▄▖    ▝▚▄▄▖▝▚▄▞▘▐▌  ▐▌▐▌  ▐▌▝▚▄▞▘▐▌  ▐▌

• EN: It's base component
• TR: Nodejs projeleri için temel bileşen

Usage

• EN: How to add into your project?
• TR: Projene nasıl eklersin?

npm i @samet-digital/base-common

Environments

@see Config

| Name | Type | Default | Options | |-------------|------|---------|-------------------------------------------------| | NODE_ENV | enum | local | [local, development, test, staging, production] | | LOG_LEVEL | enum | debug | [debug, info, warn, error] |

Contents

• baseCommonConfig : base config
• configPool : config pool for your project
• errorHandler : error handler
• generator : mock data generator

Development

You can start to develop on it

Step 1

• EN: Go to your project folder
• TR: Bilgisayarında proje klasörüne git

# Windows
cd C:\\projects\samet-digital

# Mac
cd /Users/{user}/projects/samet-digital

Step 2

• EN: Clone the project
• TR: Projeyi bilgisiyarına çek

git clone https://github.com/samet-digital/base-common.git -b development

Dependencies

• ~~Nothing~~

Commands

# Collects all dependencies
npm i

# Builds project dist (TS -> JS, src -> dist)
npm run build

# Publishes component on http://npmjs.com/
npm run publish:public

# Clears `dist` and `coverage` folders
npm run clear

# Clear `node_modules` folder
npm run clear:nm

# Validates lint for only errors @see (./eslint.config.mjs) for rules
npm run lint

# Validates lint with warnings
npm run lint:verbose

# Runs test cases
npm run test

# Exports coverage report, @see (./coverage/lcov-report/index.html)
npm run coverage

# Finds outdated/legacy dependencies
npm outdated

Standards

+ language: TS 
+ lint: eslint
+ inspections: intelli-j code inspections
+ ddd: domain driven development
+ edd: exception driven development
! tdd: test driven development
+ ldd: log driven development
+ ddd: document driven development

History

| Date | Developer | Info | Ticket | |------------|----------------|--------------|----------------| | 2025-04-27 | Mustafa Yelmer | Created | ~~none~~ | | 2025-08-12 | Mustafa Yelmer | Refactored | ~~none~~ | | 2025-08-14 | Mustafa Yelmer | Documented | ~~none~~ |