Skip to content

Commit a6ae624

Browse files
AlexRogalskiyAlexRogalskiy
committed
Updates on docs
1 parent 98fb8bb commit a6ae624

File tree

3 files changed

+102
-42
lines changed

3 files changed

+102
-42
lines changed

‎Makefile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,9 @@ CHART_RELEASE_DIR := release
9999
# GITHUB_PAGES_DIR stores github pages folder
100100
GITHUB_PAGES_DIR := site
101101

102+
# REQUIRED_TOOLS stores required binary tools
103+
REQUIRED_TOOLS := $(UTILS)
104+
102105
# VARS stores printing variables
103106
VARS += DOCKER_IMAGE_NAME
104107
VARS += IMAGE_NAME MUTABLE_IMAGE_NAME
@@ -125,6 +128,9 @@ VARS += VERBOSE
125128
# Run all by default when "make" is invoked.
126129
.DEFAULT_GOAL := help
127130

131+
$(REQUIRED_TOOLS):
132+
@hash $@ 2>/dev/null || (echo "please install $@" && exit 1)
133+
128134
# Default target (by virtue of being the first non '.'-prefixed in the file).
129135
.PHONY: _no-target-specified
130136
_no-target-specified:

‎makefiles/utils/commons.mk‎

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ GIT_WORKING_SUFFIX := $(shell if git status --porcelain | grep -qE '^(?:[
2525
GIT_TAG := $(shell git tag -l | grep -E '[0-9]+(.[0-9]+){2}' | sort -t. -k 1,1nr -k 2,2nr -k 3,3nr | head -1)
2626
# GIT_COMMIT_SHA stores git last commit hash
2727
GIT_COMMIT_SHA := $(shell git rev-parse --short=8 --verify HEAD)
28+
# GIT_REMOTE_NAME stores git remote branch name
29+
GIT_REMOTE_NAME := $(shell git describe --all --exact-match HEAD)
2830
# GIT_TREE_SHA stores git tree hash
2931
GIT_TREE_SHA := $(shell git hash-object -t tree /dev/null)
3032
# GIT_LOG_COMMIT_TIMESTAMP stores last commit to allow for reproducible builds
@@ -80,22 +82,24 @@ WGET_OPTS := --no-check-certificate
8082
# CURL_OPTS stores curl options
8183
CURL_OPTS := --silent --show-error --location --fail --retry 3
8284

83-
# General vars
84-
TIME_LONG := $(shell date +%Y-%m-%d' '%H:%M:%S)
85-
TIME_SHORT := $(shell date +%H:%M:%S)
86-
TIME := $(TIME_SHORT)
87-
88-
COLOR_BLUE := $(shell printf "\033[34m")
89-
COLOR_YELLOW := $(shell printf "\033[33m")
90-
COLOR_RED := $(shell printf "\033[31m")
91-
COLOR_GREEN := $(shell printf "\033[32m")
92-
COLOR_NORMAL := $(shell printf "\033[0m")
93-
94-
PRINT_INFO := echo ${TIME} ${COLOR_BLUE}[ INFO ]${COLOR_NORMAL}
95-
PRINT_WARN := echo ${TIME} ${COLOR_YELLOW}[ WARN ]${COLOR_NORMAL}
96-
PRINT_ERR := echo ${TIME} ${COLOR_RED}[ ERR ]${COLOR_NORMAL}
97-
PRINT_OK := echo ${TIME} ${COLOR_GREEN}[ OK ]${COLOR_NORMAL}
98-
PRINT_FAIL := (echo ${TIME} ${COLOR_RED}[ FAIL ]${COLOR_NORMAL} && false)
85+
# Date/time vars
86+
DATE_TIME_LONG := $(shell date +%Y-%m-%d' '%H:%M:%S)
87+
DATE_TIME_SHORT := $(shell date +%H:%M:%S)
88+
DATE_TIME := $(DATE_TIME_SHORT)
89+
90+
# Color vars
91+
COLOR_BLUE := $(shell printf "\033[34m")
92+
COLOR_YELLOW := $(shell printf "\033[33m")
93+
COLOR_RED := $(shell printf "\033[31m")
94+
COLOR_GREEN := $(shell printf "\033[32m")
95+
COLOR_NORMAL := $(shell printf "\033[0m")
96+
97+
# Status vars
98+
PRINT_INFO := echo ${DATE_TIME} ${COLOR_BLUE}[ INFO ]${COLOR_NORMAL}
99+
PRINT_WARN := echo ${DATE_TIME} ${COLOR_YELLOW}[ WARN ]${COLOR_NORMAL}
100+
PRINT_ERR := echo ${DATE_TIME} ${COLOR_RED}[ ERR ]${COLOR_NORMAL}
101+
PRINT_OK := echo ${DATE_TIME} ${COLOR_GREEN}[ OK ]${COLOR_NORMAL}
102+
PRINT_FAIL := (echo ${DATE_TIME} ${COLOR_RED}[ FAIL ]${COLOR_NORMAL} && false)
99103

100104
################################################################################
101105
# Common variables #

‎tsconfig.json‎

Lines changed: 76 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,78 @@
11
{
2-
"$schema": "https://json.schemastore.org/tsconfig",
3-
"compilerOptions": {
4-
"module": "commonjs",
5-
"target": "es6",
6-
"outDir": "out",
7-
"lib": ["es2015", "dom", "es7"],
8-
"types": ["node"],
9-
"strict": true,
10-
"skipLibCheck": true,
11-
"strictNullChecks": true,
12-
"forceConsistentCasingInFileNames": true,
13-
"strictPropertyInitialization": true,
14-
"noImplicitAny": true,
15-
"sourceMap": true,
16-
"rootDir": "packages",
17-
"noUnusedLocals": true,
18-
"noUnusedParameters": true,
19-
"allowSyntheticDefaultImports": true,
20-
"esModuleInterop": true,
21-
"importHelpers": true,
22-
"noEmitOnError": true
23-
},
24-
"exclude": ["node_modules", "scripts"],
25-
"linterOptions": {
26-
"exclude": ["node_modules/**", "scripts/**"]
27-
}
2+
"$schema": "https://json.schemastore.org/tsconfig",
3+
"compilerOptions": {
4+
"module": "commonjs",
5+
"target": "es6",
6+
"outDir": "out",
7+
"lib": [
8+
"es2015",
9+
"dom",
10+
"es7"
11+
],
12+
"types": [
13+
"node"
14+
],
15+
"typeRoots": [
16+
"node_modules/@types"
17+
],
18+
"strict": true,
19+
/* Enable all strict type-checking options. */
20+
"skipLibCheck": true,
21+
"strictNullChecks": true,
22+
/* Enable strict null checks. */
23+
"forceConsistentCasingInFileNames": true,
24+
"alwaysStrict": true,
25+
"useUnknownInCatchVariables": false,
26+
"noErrorTruncation": true,
27+
"extendedDiagnostics": true,
28+
"emitDeclarationOnly": true,
29+
"declarationMap": true,
30+
/* Parse in strict mode and emit "use strict" for each source file. */
31+
"noImplicitThis": true,
32+
/* Raise error on 'this' expressions with an implied 'any' type. */
33+
"strictPropertyInitialization": true,
34+
/* Enable strict checking of property initialization in classes. */
35+
"strictFunctionTypes": true,
36+
/* Enable strict checking of function types. */
37+
"noImplicitAny": true,
38+
/* Raise error on expressions and declarations with an implied 'any' type. */
39+
"sourceMap": true,
40+
"rootDir": "packages",
41+
"noUnusedLocals": true,
42+
/* Report errors on unused locals. */
43+
"noUnusedParameters": true,
44+
/* Report errors on unused parameters. */
45+
"noImplicitReturns": true,
46+
/* Report error when not all code paths in function return a value. */
47+
"noFallthroughCasesInSwitch": true,
48+
/* Report errors for fallthrough cases in switch statement. */
49+
"allowSyntheticDefaultImports": true,
50+
"esModuleInterop": true,
51+
/* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
52+
"importHelpers": true,
53+
"noEmitOnError": true,
54+
"declaration": true,
55+
"inlineSourceMap": true,
56+
"traceResolution": false
57+
/* Report module resolution log messages. */,
58+
"listEmittedFiles": false
59+
/* Print names of generated files part of the compilation. */,
60+
"listFiles": false
61+
/* Print names of files part of the compilation. */,
62+
"pretty": true
63+
/* Stylize errors and messages using color and context. */
64+
/* Experimental Options */
65+
// "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
66+
// "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */,
67+
},
68+
"exclude": [
69+
"node_modules",
70+
"scripts"
71+
],
72+
"linterOptions": {
73+
"exclude": [
74+
"node_modules/**",
75+
"scripts/**"
76+
]
77+
}
2878
}

0 commit comments

Comments
 (0)