@morda-dev/create-sdk 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -0
- package/bin/create-sdk.js +185 -31
- package/package.json +14 -4
- package/template/.github/workflows/ci.yml +30 -35
- package/template/api-extractor.json +6 -6
- package/template/etc/project-template.api.md +32 -32
- package/template/package.json +14 -5
- package/template/src/index.ts +8 -2
- package/template/src/modules/user.ts +23 -4
- package/template/src/types/user.ts +11 -3
- package/template/.editorconfig +0 -0
- package/template/.github/CODEOWNERS +0 -2
- package/template/.github/ISSUE_TEMPLATE/bug_report.md +0 -35
- package/template/.github/ISSUE_TEMPLATE/feature_request.md +0 -26
- package/template/.github/dependabot.yml +0 -18
- package/template/.github/pull_request_template.md +0 -25
- package/template/.github/workflows/auto-release.yml +0 -77
- package/template/.github/workflows/deploy-pages.yml +0 -73
- package/template/.github/workflows/docs-ci.yml +0 -38
- package/template/.github/workflows/docs.yml +0 -19
- package/template/.github/workflows/release.yml +0 -51
- package/template/.husky/commit-msg +0 -4
- package/template/.husky/pre-commit +0 -4
- package/template/.prettierrc +0 -0
- package/template/CHANGELOG.md +0 -49
- package/template/CODE_OF_CONDUCT.md +0 -40
- package/template/CONTRIBUTING.md +0 -38
- package/template/SECURITY.md +0 -16
- package/template/TEST_DEPLOY.md +0 -0
- package/template/ci-cd.md +0 -93
- package/template/commitlint.config.cjs +0 -3
- package/template/coverage/base.css +0 -224
- package/template/coverage/block-navigation.js +0 -87
- package/template/coverage/clover.xml +0 -6
- package/template/coverage/coverage-final.json +0 -1
- package/template/coverage/favicon.png +0 -0
- package/template/coverage/index.html +0 -101
- package/template/coverage/prettify.css +0 -1
- package/template/coverage/prettify.js +0 -2
- package/template/coverage/sort-arrow-sprite.png +0 -0
- package/template/coverage/sorter.js +0 -210
- package/template/docs/api/README.md +0 -5
- package/template/docs/api-auto/README.md +0 -5
- package/template/docs/index.html +0 -73
- package/template/docs/index.md +0 -28
- package/template/docusaurus-build/.github/workflows/deploy-docs.yml +0 -46
- package/template/docusaurus-build/.github/workflows/deploy-pages.yml +0 -43
- package/template/docusaurus-build/README.md +0 -44
- package/template/docusaurus-build/blog/authors.yml +0 -34
- package/template/docusaurus-build/blog/hello-world.md +0 -9
- package/template/docusaurus-build/docs/ci-cd.md +0 -62
- package/template/docusaurus-build/docs/conventions.md +0 -50
- package/template/docusaurus-build/docs/folder-structure.md +0 -24
- package/template/docusaurus-build/docs/getting-started.md +0 -24
- package/template/docusaurus-build/docs/intro.md +0 -14
- package/template/docusaurus-build/docs/project-architecture.md +0 -125
- package/template/docusaurus-build/docs/project-template/architecture.md +0 -82
- package/template/docusaurus-build/docs/project-template/getting-started.md +0 -24
- package/template/docusaurus-build/docs/project-template/overview.md +0 -78
- package/template/docusaurus-build/docs/project-template/structure.md +0 -145
- package/template/docusaurus-build/docs/scripts.md +0 -42
- package/template/docusaurus-build/docs/testing.md +0 -30
- package/template/docusaurus-build/docusaurus-build/sidebars.ts +0 -30
- package/template/docusaurus-build/docusaurus-build/tsconfig.json +0 -8
- package/template/docusaurus-build/docusaurus-build/typedoc.tsconfig.json +0 -28
- package/template/docusaurus-build/docusaurus.config.ts +0 -129
- package/template/docusaurus-build/package-lock.json +0 -18235
- package/template/docusaurus-build/package.json +0 -51
- package/template/docusaurus-build/project-template/README.md +0 -44
- package/template/docusaurus-build/project-template/src/index.ts +0 -4
- package/template/docusaurus-build/project-template/src/modules/user.ts +0 -20
- package/template/docusaurus-build/project-template/src/types/user.ts +0 -5
- package/template/docusaurus-build/sidebars.ts +0 -20
- package/template/docusaurus-build/src/components/HomepageFeatures/index.tsx +0 -71
- package/template/docusaurus-build/src/components/HomepageFeatures/styles.module.css +0 -11
- package/template/docusaurus-build/src/css/custom.css +0 -30
- package/template/docusaurus-build/src/pages/index.module.css +0 -23
- package/template/docusaurus-build/src/pages/index.tsx +0 -52
- package/template/docusaurus-build/src/pages/markdown-page.md +0 -7
- package/template/docusaurus-build/static/.nojekyll +0 -0
- package/template/docusaurus-build/static/api/.nojekyll +0 -1
- package/template/docusaurus-build/static/api/assets/hierarchy.js +0 -1
- package/template/docusaurus-build/static/api/assets/highlight.css +0 -22
- package/template/docusaurus-build/static/api/assets/icons.js +0 -18
- package/template/docusaurus-build/static/api/assets/icons.svg +0 -1
- package/template/docusaurus-build/static/api/assets/main.js +0 -60
- package/template/docusaurus-build/static/api/assets/navigation.js +0 -1
- package/template/docusaurus-build/static/api/assets/search.js +0 -1
- package/template/docusaurus-build/static/api/assets/style.css +0 -1633
- package/template/docusaurus-build/static/api/functions/modules_user.getUser.html +0 -1
- package/template/docusaurus-build/static/api/functions/modules_user.sumAges.html +0 -1
- package/template/docusaurus-build/static/api/hierarchy.html +0 -1
- package/template/docusaurus-build/static/api/index.html +0 -1
- package/template/docusaurus-build/static/api/modules/index.html +0 -1
- package/template/docusaurus-build/static/api/modules/modules_user.html +0 -1
- package/template/docusaurus-build/static/api/modules/types_user.html +0 -1
- package/template/docusaurus-build/static/api/types/types_user.ApiResult.html +0 -3
- package/template/docusaurus-build/static/api/types/types_user.User.html +0 -4
- package/template/docusaurus-build/static/img/docusaurus-social-card.jpg +0 -0
- package/template/docusaurus-build/static/img/docusaurus.png +0 -0
- package/template/docusaurus-build/static/img/favicon.ico +0 -0
- package/template/docusaurus-build/static/img/logo.svg +0 -1
- package/template/docusaurus-build/static/img/undraw_docusaurus_mountain.svg +0 -171
- package/template/docusaurus-build/static/img/undraw_docusaurus_react.svg +0 -170
- package/template/docusaurus-build/static/img/undraw_docusaurus_tree.svg +0 -40
- package/template/docusaurus-build/tsconfig.json +0 -8
- package/template/docusaurus-build/typedoc.json +0 -14
- package/template/docusaurus-build/typedoc.tsconfig.json +0 -7
- package/template/eslint.config.mjs +0 -72
- package/template/morda-dev-project-template-0.1.1.tgz +0 -0
- package/template/package-lock.json +0 -45
- package/template/scripts/commitlint-runner.mjs +0 -10
- package/template/test.ts +0 -4
- package/template/tests/example.test.js +0 -3
- package/template/tests/public-api.snapshot.test.ts +0 -13
- package/template/tests/public-api.test.ts +0 -58
- package/template/tests/user.test.ts +0 -16
- package/template/tsconfig.eslint.json +0 -14
- package/template/typedoc.json +0 -6
- package/template/vitest.config.ts +0 -12
|
@@ -1,210 +0,0 @@
|
|
|
1
|
-
/* eslint-disable */
|
|
2
|
-
var addSorting = (function() {
|
|
3
|
-
'use strict';
|
|
4
|
-
var cols,
|
|
5
|
-
currentSort = {
|
|
6
|
-
index: 0,
|
|
7
|
-
desc: false
|
|
8
|
-
};
|
|
9
|
-
|
|
10
|
-
// returns the summary table element
|
|
11
|
-
function getTable() {
|
|
12
|
-
return document.querySelector('.coverage-summary');
|
|
13
|
-
}
|
|
14
|
-
// returns the thead element of the summary table
|
|
15
|
-
function getTableHeader() {
|
|
16
|
-
return getTable().querySelector('thead tr');
|
|
17
|
-
}
|
|
18
|
-
// returns the tbody element of the summary table
|
|
19
|
-
function getTableBody() {
|
|
20
|
-
return getTable().querySelector('tbody');
|
|
21
|
-
}
|
|
22
|
-
// returns the th element for nth column
|
|
23
|
-
function getNthColumn(n) {
|
|
24
|
-
return getTableHeader().querySelectorAll('th')[n];
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
function onFilterInput() {
|
|
28
|
-
const searchValue = document.getElementById('fileSearch').value;
|
|
29
|
-
const rows = document.getElementsByTagName('tbody')[0].children;
|
|
30
|
-
|
|
31
|
-
// Try to create a RegExp from the searchValue. If it fails (invalid regex),
|
|
32
|
-
// it will be treated as a plain text search
|
|
33
|
-
let searchRegex;
|
|
34
|
-
try {
|
|
35
|
-
searchRegex = new RegExp(searchValue, 'i'); // 'i' for case-insensitive
|
|
36
|
-
} catch (error) {
|
|
37
|
-
searchRegex = null;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
for (let i = 0; i < rows.length; i++) {
|
|
41
|
-
const row = rows[i];
|
|
42
|
-
let isMatch = false;
|
|
43
|
-
|
|
44
|
-
if (searchRegex) {
|
|
45
|
-
// If a valid regex was created, use it for matching
|
|
46
|
-
isMatch = searchRegex.test(row.textContent);
|
|
47
|
-
} else {
|
|
48
|
-
// Otherwise, fall back to the original plain text search
|
|
49
|
-
isMatch = row.textContent
|
|
50
|
-
.toLowerCase()
|
|
51
|
-
.includes(searchValue.toLowerCase());
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
row.style.display = isMatch ? '' : 'none';
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
// loads the search box
|
|
59
|
-
function addSearchBox() {
|
|
60
|
-
var template = document.getElementById('filterTemplate');
|
|
61
|
-
var templateClone = template.content.cloneNode(true);
|
|
62
|
-
templateClone.getElementById('fileSearch').oninput = onFilterInput;
|
|
63
|
-
template.parentElement.appendChild(templateClone);
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
// loads all columns
|
|
67
|
-
function loadColumns() {
|
|
68
|
-
var colNodes = getTableHeader().querySelectorAll('th'),
|
|
69
|
-
colNode,
|
|
70
|
-
cols = [],
|
|
71
|
-
col,
|
|
72
|
-
i;
|
|
73
|
-
|
|
74
|
-
for (i = 0; i < colNodes.length; i += 1) {
|
|
75
|
-
colNode = colNodes[i];
|
|
76
|
-
col = {
|
|
77
|
-
key: colNode.getAttribute('data-col'),
|
|
78
|
-
sortable: !colNode.getAttribute('data-nosort'),
|
|
79
|
-
type: colNode.getAttribute('data-type') || 'string'
|
|
80
|
-
};
|
|
81
|
-
cols.push(col);
|
|
82
|
-
if (col.sortable) {
|
|
83
|
-
col.defaultDescSort = col.type === 'number';
|
|
84
|
-
colNode.innerHTML =
|
|
85
|
-
colNode.innerHTML + '<span class="sorter"></span>';
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
return cols;
|
|
89
|
-
}
|
|
90
|
-
// attaches a data attribute to every tr element with an object
|
|
91
|
-
// of data values keyed by column name
|
|
92
|
-
function loadRowData(tableRow) {
|
|
93
|
-
var tableCols = tableRow.querySelectorAll('td'),
|
|
94
|
-
colNode,
|
|
95
|
-
col,
|
|
96
|
-
data = {},
|
|
97
|
-
i,
|
|
98
|
-
val;
|
|
99
|
-
for (i = 0; i < tableCols.length; i += 1) {
|
|
100
|
-
colNode = tableCols[i];
|
|
101
|
-
col = cols[i];
|
|
102
|
-
val = colNode.getAttribute('data-value');
|
|
103
|
-
if (col.type === 'number') {
|
|
104
|
-
val = Number(val);
|
|
105
|
-
}
|
|
106
|
-
data[col.key] = val;
|
|
107
|
-
}
|
|
108
|
-
return data;
|
|
109
|
-
}
|
|
110
|
-
// loads all row data
|
|
111
|
-
function loadData() {
|
|
112
|
-
var rows = getTableBody().querySelectorAll('tr'),
|
|
113
|
-
i;
|
|
114
|
-
|
|
115
|
-
for (i = 0; i < rows.length; i += 1) {
|
|
116
|
-
rows[i].data = loadRowData(rows[i]);
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
// sorts the table using the data for the ith column
|
|
120
|
-
function sortByIndex(index, desc) {
|
|
121
|
-
var key = cols[index].key,
|
|
122
|
-
sorter = function(a, b) {
|
|
123
|
-
a = a.data[key];
|
|
124
|
-
b = b.data[key];
|
|
125
|
-
return a < b ? -1 : a > b ? 1 : 0;
|
|
126
|
-
},
|
|
127
|
-
finalSorter = sorter,
|
|
128
|
-
tableBody = document.querySelector('.coverage-summary tbody'),
|
|
129
|
-
rowNodes = tableBody.querySelectorAll('tr'),
|
|
130
|
-
rows = [],
|
|
131
|
-
i;
|
|
132
|
-
|
|
133
|
-
if (desc) {
|
|
134
|
-
finalSorter = function(a, b) {
|
|
135
|
-
return -1 * sorter(a, b);
|
|
136
|
-
};
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
for (i = 0; i < rowNodes.length; i += 1) {
|
|
140
|
-
rows.push(rowNodes[i]);
|
|
141
|
-
tableBody.removeChild(rowNodes[i]);
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
rows.sort(finalSorter);
|
|
145
|
-
|
|
146
|
-
for (i = 0; i < rows.length; i += 1) {
|
|
147
|
-
tableBody.appendChild(rows[i]);
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
// removes sort indicators for current column being sorted
|
|
151
|
-
function removeSortIndicators() {
|
|
152
|
-
var col = getNthColumn(currentSort.index),
|
|
153
|
-
cls = col.className;
|
|
154
|
-
|
|
155
|
-
cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
|
|
156
|
-
col.className = cls;
|
|
157
|
-
}
|
|
158
|
-
// adds sort indicators for current column being sorted
|
|
159
|
-
function addSortIndicators() {
|
|
160
|
-
getNthColumn(currentSort.index).className += currentSort.desc
|
|
161
|
-
? ' sorted-desc'
|
|
162
|
-
: ' sorted';
|
|
163
|
-
}
|
|
164
|
-
// adds event listeners for all sorter widgets
|
|
165
|
-
function enableUI() {
|
|
166
|
-
var i,
|
|
167
|
-
el,
|
|
168
|
-
ithSorter = function ithSorter(i) {
|
|
169
|
-
var col = cols[i];
|
|
170
|
-
|
|
171
|
-
return function() {
|
|
172
|
-
var desc = col.defaultDescSort;
|
|
173
|
-
|
|
174
|
-
if (currentSort.index === i) {
|
|
175
|
-
desc = !currentSort.desc;
|
|
176
|
-
}
|
|
177
|
-
sortByIndex(i, desc);
|
|
178
|
-
removeSortIndicators();
|
|
179
|
-
currentSort.index = i;
|
|
180
|
-
currentSort.desc = desc;
|
|
181
|
-
addSortIndicators();
|
|
182
|
-
};
|
|
183
|
-
};
|
|
184
|
-
for (i = 0; i < cols.length; i += 1) {
|
|
185
|
-
if (cols[i].sortable) {
|
|
186
|
-
// add the click event handler on the th so users
|
|
187
|
-
// dont have to click on those tiny arrows
|
|
188
|
-
el = getNthColumn(i).querySelector('.sorter').parentElement;
|
|
189
|
-
if (el.addEventListener) {
|
|
190
|
-
el.addEventListener('click', ithSorter(i));
|
|
191
|
-
} else {
|
|
192
|
-
el.attachEvent('onclick', ithSorter(i));
|
|
193
|
-
}
|
|
194
|
-
}
|
|
195
|
-
}
|
|
196
|
-
}
|
|
197
|
-
// adds sorting functionality to the UI
|
|
198
|
-
return function() {
|
|
199
|
-
if (!getTable()) {
|
|
200
|
-
return;
|
|
201
|
-
}
|
|
202
|
-
cols = loadColumns();
|
|
203
|
-
loadData();
|
|
204
|
-
addSearchBox();
|
|
205
|
-
addSortIndicators();
|
|
206
|
-
enableUI();
|
|
207
|
-
};
|
|
208
|
-
})();
|
|
209
|
-
|
|
210
|
-
window.addEventListener('load', addSorting);
|
package/template/docs/index.html
DELETED
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<html lang="ru">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8" />
|
|
5
|
-
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|
6
|
-
<title>Project Template — Morda Dev</title>
|
|
7
|
-
<style>
|
|
8
|
-
body {
|
|
9
|
-
font-family: Inter, system-ui, Arial, sans-serif;
|
|
10
|
-
line-height: 1.6;
|
|
11
|
-
padding: 40px;
|
|
12
|
-
max-width: 900px;
|
|
13
|
-
margin: 0 auto;
|
|
14
|
-
}
|
|
15
|
-
header {
|
|
16
|
-
display: flex;
|
|
17
|
-
gap: 12px;
|
|
18
|
-
align-items: center;
|
|
19
|
-
}
|
|
20
|
-
.hero {
|
|
21
|
-
margin-top: 28px;
|
|
22
|
-
}
|
|
23
|
-
.btn {
|
|
24
|
-
display: inline-block;
|
|
25
|
-
padding: 10px 16px;
|
|
26
|
-
border-radius: 8px;
|
|
27
|
-
text-decoration: none;
|
|
28
|
-
}
|
|
29
|
-
.primary {
|
|
30
|
-
background: #111;
|
|
31
|
-
color: #fff;
|
|
32
|
-
}
|
|
33
|
-
.muted {
|
|
34
|
-
background: #efefef;
|
|
35
|
-
color: #111;
|
|
36
|
-
margin-left: 8px;
|
|
37
|
-
}
|
|
38
|
-
</style>
|
|
39
|
-
</head>
|
|
40
|
-
<body>
|
|
41
|
-
<header>
|
|
42
|
-
<h1>Project Template</h1>
|
|
43
|
-
</header>
|
|
44
|
-
<section class="hero">
|
|
45
|
-
<p>
|
|
46
|
-
Оптимизированный TypeScript/NPM проект-стартер с CI, Husky, lint-staged,
|
|
47
|
-
release automation и шаблонами issues.
|
|
48
|
-
</p>
|
|
49
|
-
|
|
50
|
-
<p>
|
|
51
|
-
<a
|
|
52
|
-
class="btn primary"
|
|
53
|
-
href="https://github.com/mordaHQ/project-template"
|
|
54
|
-
target="_blank"
|
|
55
|
-
>GitHub</a
|
|
56
|
-
>
|
|
57
|
-
<a
|
|
58
|
-
class="btn muted"
|
|
59
|
-
href="https://github.com/sponsors/mordaHQ"
|
|
60
|
-
target="_blank"
|
|
61
|
-
>Поддержать</a
|
|
62
|
-
>
|
|
63
|
-
</p>
|
|
64
|
-
|
|
65
|
-
<h3>Скачать или купить улучшенную версию</h3>
|
|
66
|
-
<p>Позже добавим Stripe/Gumroad. Это базовая страница.</p>
|
|
67
|
-
</section>
|
|
68
|
-
|
|
69
|
-
<footer style="margin-top: 60px; color: #666; font-size: 14px">
|
|
70
|
-
v1 — готово к использованию.
|
|
71
|
-
</footer>
|
|
72
|
-
</body>
|
|
73
|
-
</html>
|
package/template/docs/index.md
DELETED
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# Project Template — Документация
|
|
2
|
-
|
|
3
|
-
Кратко: это профессиональный TypeScript project template с настройкой CI, тестами, Prettier/ESLint, GitHub Actions и автоматическими релизами.
|
|
4
|
-
|
|
5
|
-
## 🚀 Быстрый старт
|
|
6
|
-
|
|
7
|
-
`ash
|
|
8
|
-
|
|
9
|
-
# клонируем
|
|
10
|
-
|
|
11
|
-
git clone https://github.com/mordaHQ/project-template.git
|
|
12
|
-
cd project-template
|
|
13
|
-
|
|
14
|
-
# установить зависимости
|
|
15
|
-
|
|
16
|
-
npm ci
|
|
17
|
-
|
|
18
|
-
# запустить тесты
|
|
19
|
-
|
|
20
|
-
npm test
|
|
21
|
-
|
|
22
|
-
# линтинг
|
|
23
|
-
|
|
24
|
-
npm run lint
|
|
25
|
-
|
|
26
|
-
# проверка форматирования
|
|
27
|
-
|
|
28
|
-
npx prettier --check .
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
name: Deploy Docusaurus
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
push:
|
|
5
|
-
branches:
|
|
6
|
-
- main
|
|
7
|
-
|
|
8
|
-
jobs:
|
|
9
|
-
build-and-deploy:
|
|
10
|
-
runs-on: ubuntu-latest
|
|
11
|
-
|
|
12
|
-
steps:
|
|
13
|
-
- name: Checkout repository
|
|
14
|
-
uses: actions/checkout@v3
|
|
15
|
-
with:
|
|
16
|
-
fetch-depth: 0
|
|
17
|
-
submodules: true
|
|
18
|
-
|
|
19
|
-
- name: Setup Node.js
|
|
20
|
-
uses: actions/setup-node@v3
|
|
21
|
-
with:
|
|
22
|
-
node-version: 20
|
|
23
|
-
cache: npm
|
|
24
|
-
|
|
25
|
-
- name: Install dependencies
|
|
26
|
-
run: |
|
|
27
|
-
cd docusaurus-build
|
|
28
|
-
npm ci
|
|
29
|
-
|
|
30
|
-
- name: Generate API docs
|
|
31
|
-
run: |
|
|
32
|
-
cd docusaurus-build
|
|
33
|
-
cd ..
|
|
34
|
-
npm run api
|
|
35
|
-
|
|
36
|
-
- name: Build Docusaurus
|
|
37
|
-
run: |
|
|
38
|
-
cd docusaurus-build
|
|
39
|
-
npm run build
|
|
40
|
-
|
|
41
|
-
- name: Deploy to GitHub Pages
|
|
42
|
-
uses: peaceiris/actions-gh-pages@v3
|
|
43
|
-
with:
|
|
44
|
-
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
45
|
-
publish_dir: docusaurus-build/build
|
|
46
|
-
publish_branch: gh-pages
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
name: Build and Deploy Docs (Cloudflare Pages)
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
push:
|
|
5
|
-
branches:
|
|
6
|
-
- main
|
|
7
|
-
pull_request:
|
|
8
|
-
|
|
9
|
-
jobs:
|
|
10
|
-
build-and-deploy:
|
|
11
|
-
runs-on: ubuntu-latest
|
|
12
|
-
|
|
13
|
-
defaults:
|
|
14
|
-
run:
|
|
15
|
-
working-directory: docusaurus-build
|
|
16
|
-
|
|
17
|
-
steps:
|
|
18
|
-
- name: Checkout repository
|
|
19
|
-
uses: actions/checkout@v4
|
|
20
|
-
|
|
21
|
-
- name: Use Node.js 20
|
|
22
|
-
uses: actions/setup-node@v4
|
|
23
|
-
with:
|
|
24
|
-
node-version: 20
|
|
25
|
-
cache: npm
|
|
26
|
-
cache-dependency-path: docusaurus-build/package-lock.json
|
|
27
|
-
|
|
28
|
-
- name: Install dependencies
|
|
29
|
-
run: npm ci
|
|
30
|
-
|
|
31
|
-
- name: Generate API docs (TypeDoc)
|
|
32
|
-
run: npm run docs:api
|
|
33
|
-
|
|
34
|
-
- name: Build Docusaurus site
|
|
35
|
-
run: npm run build
|
|
36
|
-
|
|
37
|
-
- name: Deploy to Cloudflare Pages
|
|
38
|
-
uses: cloudflare/pages-action@v1
|
|
39
|
-
with:
|
|
40
|
-
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
41
|
-
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
42
|
-
projectName: ${{ secrets.CLOUDFLARE_PROJECT_NAME }}
|
|
43
|
-
directory: docusaurus-build/build
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# @morda-dev/project-template
|
|
2
|
-
|
|
3
|
-
Production-ready TypeScript SDK template with a strict public API, ESM-first setup,
|
|
4
|
-
and best practices baked in.
|
|
5
|
-
|
|
6
|
-
This package can be used as:
|
|
7
|
-
- a base for building your own SDK
|
|
8
|
-
- a reference for ESM + TypeScript library architecture
|
|
9
|
-
- a starting point for production-ready npm packages
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
## Installation
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
npm install @morda-dev/project-template
|
|
16
|
-
```
|
|
17
|
-
Usage
|
|
18
|
-
|
|
19
|
-
import { getUser, sumAges } from '@morda-dev/project-template';
|
|
20
|
-
|
|
21
|
-
const user = getUser(1);
|
|
22
|
-
console.log(user);
|
|
23
|
-
|
|
24
|
-
const totalAge = sumAges([
|
|
25
|
-
{ id: 1, name: 'Alice', age: 20 },
|
|
26
|
-
{ id: 2, name: 'Bob', age: 30 },
|
|
27
|
-
]);
|
|
28
|
-
|
|
29
|
-
console.log(totalAge);
|
|
30
|
-
API
|
|
31
|
-
getUser(id: number)
|
|
32
|
-
|
|
33
|
-
Returns a user wrapped in ApiResult.
|
|
34
|
-
|
|
35
|
-
sumAges(users: User[])
|
|
36
|
-
|
|
37
|
-
Returns the sum of all user ages.
|
|
38
|
-
|
|
39
|
-
License
|
|
40
|
-
|
|
41
|
-
ISC
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
---
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
yangshun:
|
|
2
|
-
name: Yangshun Tay
|
|
3
|
-
title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
|
|
4
|
-
url: https://linkedin.com/in/yangshun
|
|
5
|
-
image_url: https://github.com/yangshun.png
|
|
6
|
-
page: true
|
|
7
|
-
socials:
|
|
8
|
-
x: yangshunz
|
|
9
|
-
linkedin: yangshun
|
|
10
|
-
github: yangshun
|
|
11
|
-
newsletter: https://www.greatfrontend.com
|
|
12
|
-
|
|
13
|
-
slorber:
|
|
14
|
-
name: Sébastien Lorber
|
|
15
|
-
title: Docusaurus maintainer
|
|
16
|
-
url: https://sebastienlorber.com
|
|
17
|
-
image_url: https://github.com/slorber.png
|
|
18
|
-
page:
|
|
19
|
-
permalink: "/all-sebastien-lorber-articles"
|
|
20
|
-
socials:
|
|
21
|
-
x: sebastienlorber
|
|
22
|
-
linkedin: sebastienlorber
|
|
23
|
-
github: slorber
|
|
24
|
-
newsletter: https://thisweekinreact.com
|
|
25
|
-
|
|
26
|
-
morda:
|
|
27
|
-
name: Morda Dev
|
|
28
|
-
title: Author of Project Template
|
|
29
|
-
url: https://github.com/mordaHQ
|
|
30
|
-
image_url: https://avatars.githubusercontent.com/u/183162001?v=4
|
|
31
|
-
page: true
|
|
32
|
-
socials:
|
|
33
|
-
github: mordaHQ
|
|
34
|
-
x: morda_dev
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
sidebar_position: 8
|
|
3
|
-
title: CI/CD и автоматизация
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# 🚀 CI/CD и автоматизация проекта
|
|
7
|
-
|
|
8
|
-
Проект использует полностью автоматизированный процесс разработки и релизов, основанный на GitHub Actions и best-practice подходах к versioning & quality control.
|
|
9
|
-
|
|
10
|
-
## 🔍 Автоматическая проверка кода
|
|
11
|
-
|
|
12
|
-
Каждый коммит в репозиторий запускает пайплайн:
|
|
13
|
-
|
|
14
|
-
- Линтинг (eslint)
|
|
15
|
-
- Форматирование (prettier --check)
|
|
16
|
-
- Юнит-тесты (vitest)
|
|
17
|
-
- Проверка типов (tsc --noEmit)
|
|
18
|
-
|
|
19
|
-
Это исключает ситуации, когда в основную ветку попадает нерабочий код.
|
|
20
|
-
|
|
21
|
-
## 🔢 Автоматическая версияция
|
|
22
|
-
|
|
23
|
-
Используется standard-version:
|
|
24
|
-
|
|
25
|
-
- генерирует CHANGELOG
|
|
26
|
-
- увеличивает версию (patch / minor / major)
|
|
27
|
-
- создаёт git-тег
|
|
28
|
-
|
|
29
|
-
Команда:
|
|
30
|
-
|
|
31
|
-
\\\bash
|
|
32
|
-
npm run release
|
|
33
|
-
\\\
|
|
34
|
-
|
|
35
|
-
## 📦 Автосборка проекта
|
|
36
|
-
|
|
37
|
-
При пуше в main запускается:
|
|
38
|
-
|
|
39
|
-
- сборка TypeScript
|
|
40
|
-
- упаковка build-директории
|
|
41
|
-
- проверка артефактов
|
|
42
|
-
|
|
43
|
-
## 🌍 Деплой документации
|
|
44
|
-
|
|
45
|
-
Документация собирается в каталоге docusaurus-build и деплоится в GitHub Pages автоматически.
|
|
46
|
-
|
|
47
|
-
Процесс:
|
|
48
|
-
|
|
49
|
-
- сборка Docusaurus
|
|
50
|
-
- очистка ветки gh-pages
|
|
51
|
-
- загрузка обновлённого билда
|
|
52
|
-
- публикация на GitHub Pages
|
|
53
|
-
|
|
54
|
-
## 🧩 Почему это важно
|
|
55
|
-
|
|
56
|
-
Автоматизация даёт:
|
|
57
|
-
|
|
58
|
-
- прозрачные релизы
|
|
59
|
-
- отсутствие человеческих ошибок
|
|
60
|
-
- стабильные nightly-сборки
|
|
61
|
-
- быстрые фичи без ручной рутины
|
|
62
|
-
- высокое качество и единый стиль кода
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
sidebar_position: 9
|
|
3
|
-
title: Coding Conventions
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# 📐 Coding Conventions
|
|
7
|
-
|
|
8
|
-
Этот проект строго придерживается единых правил, чтобы весь код был предсказуемым, читаемым и простым в поддержке.
|
|
9
|
-
|
|
10
|
-
## 📝 Style Guide
|
|
11
|
-
|
|
12
|
-
Проект использует:
|
|
13
|
-
|
|
14
|
-
- ESLint — статический анализ
|
|
15
|
-
- Prettier — единый стиль форматирования
|
|
16
|
-
- TypeScript strict mode — максимально строгая типизация
|
|
17
|
-
|
|
18
|
-
Все настройки находятся в корне репозитория и применяются автоматически.
|
|
19
|
-
|
|
20
|
-
## 🔤 Правила именования
|
|
21
|
-
|
|
22
|
-
- Классы — PascalCase
|
|
23
|
-
- Функции и переменные — camelCase
|
|
24
|
-
- Константы — UPPER_SNAKE_CASE
|
|
25
|
-
- Файлы — kebab-case.ts
|
|
26
|
-
- Тесты — \*.test.ts
|
|
27
|
-
|
|
28
|
-
## 🧩 Структура типов
|
|
29
|
-
|
|
30
|
-
- Используем типобезопасные функции
|
|
31
|
-
- Избегаем any
|
|
32
|
-
- Предпочитаем type вместо interface
|
|
33
|
-
- Все входные данные должны иметь явный тип
|
|
34
|
-
|
|
35
|
-
## 🧪 Тесты
|
|
36
|
-
|
|
37
|
-
- Каждый модуль имеет хотя бы один тест
|
|
38
|
-
- Тесты располагаются рядом с кодом (\*.test.ts)
|
|
39
|
-
- Используем Vitest
|
|
40
|
-
|
|
41
|
-
## 📚 Комментарии
|
|
42
|
-
|
|
43
|
-
- Комментарии только там, где логика сложная
|
|
44
|
-
- Код должен быть самодокументируемым
|
|
45
|
-
- Допускаются JSDoc над публичными функциями
|
|
46
|
-
|
|
47
|
-
## 🔄 Форматирование
|
|
48
|
-
|
|
49
|
-
ash
|
|
50
|
-
npm run format
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Структура проекта
|
|
3
|
-
sidebar_position: 6
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# 📁 Структура проекта
|
|
7
|
-
|
|
8
|
-
Проект организован по принципам чистого кода, модульности и предсказуемости.
|
|
9
|
-
Каждая папка имеет чёткое назначение, что ускоряет разработку и помогает избегать путаницы.
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## 🗂 Общий обзор
|
|
14
|
-
|
|
15
|
-
```text
|
|
16
|
-
project-template/
|
|
17
|
-
├── src/ → исходный код проекта
|
|
18
|
-
├── tests/ → модульные и интеграционные тесты
|
|
19
|
-
├── dist/ → скомпилированный build (автогенерация)
|
|
20
|
-
├── scripts/ → служебные скрипты для CI/CD
|
|
21
|
-
├── assets/ → статические ресурсы
|
|
22
|
-
├── markdown-page/ → markdown-примеры для Docusaurus
|
|
23
|
-
├── docusaurus-build/ → документация (отдельный сайт)
|
|
24
|
-
└── ...
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
sidebar_position: 2
|
|
3
|
-
title: Getting Started
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# 🚀 Getting Started
|
|
7
|
-
|
|
8
|
-
Этот проект — готовый продакшен-шаблон для TypeScript-приложений.
|
|
9
|
-
Он включает стандарты разработки, тестирование, CI/CD, документацию и автоматизацию релизов.
|
|
10
|
-
|
|
11
|
-
## 📦 Требования
|
|
12
|
-
|
|
13
|
-
Перед началом убедись, что установлено:
|
|
14
|
-
|
|
15
|
-
- Node.js ≥ 18
|
|
16
|
-
- npm ≥ 9
|
|
17
|
-
- Git
|
|
18
|
-
|
|
19
|
-
Проверить можно командами:
|
|
20
|
-
|
|
21
|
-
`bash
|
|
22
|
-
node -v
|
|
23
|
-
npm -v
|
|
24
|
-
git --version
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Структура проекта
|
|
3
|
-
sidebar_label: Структура папок
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Структура папок
|
|
7
|
-
|
|
8
|
-
```text
|
|
9
|
-
project-template/
|
|
10
|
-
├─ src/ # исходники библиотеки / приложения
|
|
11
|
-
├─ tests/ # автотесты
|
|
12
|
-
├─ dist/ # собранный код (git-игнорится)
|
|
13
|
-
├─ scripts/ # служебные скрипты (release, CI и т.п.)
|
|
14
|
-
├─ docusaurus-build/ # документация
|