@vc-shell/create-vc-app 1.0.326 → 1.0.328-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/CHANGELOG.md +1216 -1143
- package/README.md +30 -30
- package/dist/index.js +154 -186
- package/dist/templates/base/LICENSE +12 -12
- package/dist/templates/base/README.md +54 -54
- package/dist/templates/base/_browserslistrc +3 -3
- package/dist/templates/base/_commitlintrc.json +3 -3
- package/dist/templates/base/_editorconfig +22 -22
- package/dist/templates/base/_env +3 -3
- package/dist/templates/base/_env.local +1 -1
- package/dist/templates/base/_eslintignore +3 -3
- package/dist/templates/base/_eslintrc.js +41 -41
- package/dist/templates/base/_github/COMMIT_CONVENTION.md +91 -91
- package/dist/templates/base/_github/PULL_REQUEST_TEMPLATE.md +8 -8
- package/dist/templates/base/_gitignore +71 -71
- package/dist/templates/base/_husky/commit-msg +4 -4
- package/dist/templates/base/_husky/pre-commit +4 -4
- package/dist/templates/base/_package.json +5 -6
- package/dist/templates/base/_prettierignore +4 -4
- package/dist/templates/base/_prettierrc +4 -4
- package/dist/templates/base/_vscode/extensions.json +14 -14
- package/dist/templates/base/_vscode/settings.json +14 -14
- package/dist/templates/base/_yarn/releases/yarn-4.0.2.cjs +893 -893
- package/dist/templates/base/_yarnrc.yml +7 -7
- package/dist/templates/base/index.html +26 -26
- package/dist/templates/base/postcss.config.cjs +6 -6
- package/dist/templates/base/public/assets/app-select.svg +11 -11
- package/dist/templates/base/public/assets/logo-white.svg +21 -21
- package/dist/templates/base/public/assets/logo.svg +8 -8
- package/dist/templates/base/public/img/icons/safari-pinned-tab.svg +32 -32
- package/dist/templates/base/scripts/release.ts +18 -18
- package/dist/templates/base/src/api_client/README.md +78 -78
- package/dist/templates/base/src/composables/index.ts +1 -1
- package/dist/templates/base/src/env.d.ts +9 -9
- package/dist/templates/base/src/locales/en.json +3 -3
- package/dist/templates/base/src/locales/index.ts +2 -2
- package/dist/templates/base/src/router/index.ts +10 -10
- package/dist/templates/base/src/router/routes.ts +78 -78
- package/dist/templates/base/src/shims-vue.d.ts +63 -63
- package/dist/templates/base/src/styles/base.scss +38 -38
- package/dist/templates/base/src/styles/colors.scss +10 -10
- package/dist/templates/base/src/styles/custom.scss +2 -2
- package/dist/templates/base/tailwind.config.ts +7 -7
- package/dist/templates/base/tsconfig.json +16 -16
- package/dist/templates/base/vite.config.mts +5 -5
- package/dist/templates/mocks/sample-data/constants.ts +86 -86
- package/dist/templates/mocks/sample-data/index.ts +2 -2
- package/dist/templates/mocks/sample-data/methods.ts +65 -65
- package/dist/templates/modules/classic-module/composables/index.ts +2 -2
- package/dist/templates/modules/classic-module/composables/use{{ModuleNamePascalCase}}Details/index.ts +19 -19
- package/dist/templates/modules/classic-module/composables/use{{ModuleNamePascalCase}}List/index.ts +23 -23
- package/dist/templates/modules/classic-module/index.ts +8 -8
- package/dist/templates/modules/classic-module/locales/en.json +28 -28
- package/dist/templates/modules/classic-module/locales/index.ts +2 -2
- package/dist/templates/modules/classic-module/pages/details.vue +61 -61
- package/dist/templates/modules/classic-module/pages/index.ts +2 -2
- package/dist/templates/modules/classic-module/pages/list.vue +162 -162
- package/dist/templates/modules/dynamic-module/composables/index.ts +2 -2
- package/dist/templates/modules/dynamic-module/composables/use{{ModuleNamePascalCase}}Details/index.ts +37 -37
- package/dist/templates/modules/dynamic-module/composables/use{{ModuleNamePascalCase}}List/index.ts +49 -49
- package/dist/templates/modules/dynamic-module/index.ts +8 -8
- package/dist/templates/modules/dynamic-module/locales/en.json +35 -35
- package/dist/templates/modules/dynamic-module/locales/index.ts +2 -2
- package/dist/templates/modules/dynamic-module/pages/details.ts +20 -20
- package/dist/templates/modules/dynamic-module/pages/index.ts +4 -4
- package/dist/templates/modules/dynamic-module/pages/list.ts +35 -35
- package/dist/templates/sample/classic-module/composables/index.ts +2 -2
- package/dist/templates/sample/classic-module/composables/useDetails/index.ts +41 -41
- package/dist/templates/sample/classic-module/composables/useList/index.ts +41 -41
- package/dist/templates/sample/classic-module/index.ts +8 -8
- package/dist/templates/sample/classic-module/locales/en.json +59 -59
- package/dist/templates/sample/classic-module/locales/index.ts +2 -2
- package/dist/templates/sample/classic-module/pages/details.vue +257 -257
- package/dist/templates/sample/classic-module/pages/index.ts +2 -2
- package/dist/templates/sample/dynamic-module/composables/index.ts +2 -2
- package/dist/templates/sample/dynamic-module/composables/useDetails/index.ts +46 -46
- package/dist/templates/sample/dynamic-module/composables/useList/index.ts +50 -50
- package/dist/templates/sample/dynamic-module/index.ts +8 -8
- package/dist/templates/sample/dynamic-module/locales/en.json +69 -69
- package/dist/templates/sample/dynamic-module/locales/index.ts +2 -2
- package/dist/templates/sample/dynamic-module/pages/details.ts +100 -100
- package/dist/templates/sample/dynamic-module/pages/index.ts +4 -4
- package/dist/templates/sample/dynamic-module/pages/list.ts +81 -81
- package/package.json +4 -3
|
@@ -1,54 +1,54 @@
|
|
|
1
|
-
# VirtoCommerce Vue3 Frontend for specialized back-office applications
|
|
2
|
-
|
|
3
|
-
## Technologies used
|
|
4
|
-
|
|
5
|
-
- **Vue3.** Progressive frontend framework with its key features allows to build fast applications.
|
|
6
|
-
- **Typescript.** All components and composables have type definitions, so IDE can help you to build clean and working code.
|
|
7
|
-
- **TailwindCSS.** The most popular and growing CSS framework providing wonderful flexible structure to speed up styling.
|
|
8
|
-
- **Husky + ESLint + Prettier.** Autoformat, check and fix your code and prevent ugly codestyle within repository.
|
|
9
|
-
- **Vite.** It is faster than Webpack. Really FASTER. Use it to develop with HMR benefits and to build for production.
|
|
10
|
-
|
|
11
|
-
## Architecture
|
|
12
|
-
|
|
13
|
-
```text
|
|
14
|
-
├─ public // Static assets
|
|
15
|
-
│ ├─ assets // Static images used inside the application.
|
|
16
|
-
│ └─ img
|
|
17
|
-
│ └─ icons // Icons used for favicons, PWA, etc.
|
|
18
|
-
├─ src
|
|
19
|
-
│ ├─ api_client // Generated API clients folder
|
|
20
|
-
│ │ └─...
|
|
21
|
-
│ ├─ components // Universal Vue components
|
|
22
|
-
│ │ └─...
|
|
23
|
-
│ ├─ config // Application extras config files
|
|
24
|
-
│ │ └─ push-hub.ts // SignalR config file
|
|
25
|
-
│ ├─ locales // Locale files used to provide translated content
|
|
26
|
-
│ │ └─ en.json
|
|
27
|
-
│ ├─ modules // The collection of custom modules
|
|
28
|
-
│ │ └─ ... // Module folder
|
|
29
|
-
│ │ ├─ components // The collection of components specific for this module
|
|
30
|
-
│ │ ├─ composables // The collection of shared logic written using Composable API pattern.
|
|
31
|
-
│ │ ├─ locales // Locale files used to provide translated content specific for this module
|
|
32
|
-
│ │ ├─ pages // Set of module pages used within Application router
|
|
33
|
-
│ │ └─ index.ts // Module entry point
|
|
34
|
-
│ ├─ pages // Set of application pages used within Application router.
|
|
35
|
-
│ │ └─...
|
|
36
|
-
│ ├─ router // SPA routing configuration
|
|
37
|
-
│ │ └─...
|
|
38
|
-
│ ├─ styles // Extras application style files
|
|
39
|
-
│ │ └─ index.scss // Tailwind initialization file
|
|
40
|
-
│ └─ types // Typescript .d.ts files
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Getting started
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
# install and configure package dependencies and git hooks
|
|
47
|
-
$ yarn
|
|
48
|
-
|
|
49
|
-
# build application
|
|
50
|
-
$ yarn build
|
|
51
|
-
|
|
52
|
-
# start application with hot reload at localhost:8080
|
|
53
|
-
$ yarn serve
|
|
54
|
-
```
|
|
1
|
+
# VirtoCommerce Vue3 Frontend for specialized back-office applications
|
|
2
|
+
|
|
3
|
+
## Technologies used
|
|
4
|
+
|
|
5
|
+
- **Vue3.** Progressive frontend framework with its key features allows to build fast applications.
|
|
6
|
+
- **Typescript.** All components and composables have type definitions, so IDE can help you to build clean and working code.
|
|
7
|
+
- **TailwindCSS.** The most popular and growing CSS framework providing wonderful flexible structure to speed up styling.
|
|
8
|
+
- **Husky + ESLint + Prettier.** Autoformat, check and fix your code and prevent ugly codestyle within repository.
|
|
9
|
+
- **Vite.** It is faster than Webpack. Really FASTER. Use it to develop with HMR benefits and to build for production.
|
|
10
|
+
|
|
11
|
+
## Architecture
|
|
12
|
+
|
|
13
|
+
```text
|
|
14
|
+
├─ public // Static assets
|
|
15
|
+
│ ├─ assets // Static images used inside the application.
|
|
16
|
+
│ └─ img
|
|
17
|
+
│ └─ icons // Icons used for favicons, PWA, etc.
|
|
18
|
+
├─ src
|
|
19
|
+
│ ├─ api_client // Generated API clients folder
|
|
20
|
+
│ │ └─...
|
|
21
|
+
│ ├─ components // Universal Vue components
|
|
22
|
+
│ │ └─...
|
|
23
|
+
│ ├─ config // Application extras config files
|
|
24
|
+
│ │ └─ push-hub.ts // SignalR config file
|
|
25
|
+
│ ├─ locales // Locale files used to provide translated content
|
|
26
|
+
│ │ └─ en.json
|
|
27
|
+
│ ├─ modules // The collection of custom modules
|
|
28
|
+
│ │ └─ ... // Module folder
|
|
29
|
+
│ │ ├─ components // The collection of components specific for this module
|
|
30
|
+
│ │ ├─ composables // The collection of shared logic written using Composable API pattern.
|
|
31
|
+
│ │ ├─ locales // Locale files used to provide translated content specific for this module
|
|
32
|
+
│ │ ├─ pages // Set of module pages used within Application router
|
|
33
|
+
│ │ └─ index.ts // Module entry point
|
|
34
|
+
│ ├─ pages // Set of application pages used within Application router.
|
|
35
|
+
│ │ └─...
|
|
36
|
+
│ ├─ router // SPA routing configuration
|
|
37
|
+
│ │ └─...
|
|
38
|
+
│ ├─ styles // Extras application style files
|
|
39
|
+
│ │ └─ index.scss // Tailwind initialization file
|
|
40
|
+
│ └─ types // Typescript .d.ts files
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Getting started
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# install and configure package dependencies and git hooks
|
|
47
|
+
$ yarn
|
|
48
|
+
|
|
49
|
+
# build application
|
|
50
|
+
$ yarn build
|
|
51
|
+
|
|
52
|
+
# start application with hot reload at localhost:8080
|
|
53
|
+
$ yarn serve
|
|
54
|
+
```
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
> 1%
|
|
2
|
-
last 2 versions
|
|
3
|
-
not dead
|
|
1
|
+
> 1%
|
|
2
|
+
last 2 versions
|
|
3
|
+
not dead
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
{
|
|
2
|
-
"extends": ["@commitlint/config-conventional"]
|
|
3
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"extends": ["@commitlint/config-conventional"]
|
|
3
|
+
}
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
# top-most EditorConfig file
|
|
2
|
-
root = true
|
|
3
|
-
|
|
4
|
-
# Global rules, override on case-by-case basis
|
|
5
|
-
[*]
|
|
6
|
-
charset = utf-8
|
|
7
|
-
indent_style = space
|
|
8
|
-
max_line_length = 120
|
|
9
|
-
tab_width = 2
|
|
10
|
-
end_of_line = lf
|
|
11
|
-
insert_final_newline = true
|
|
12
|
-
trim_trailing_whitespace = true
|
|
13
|
-
|
|
14
|
-
[*.{vue,js,ts,scss}]
|
|
15
|
-
quote_type = double
|
|
16
|
-
|
|
17
|
-
[*.md]
|
|
18
|
-
max_line_length = off
|
|
19
|
-
trim_trailing_whitespace = false
|
|
20
|
-
|
|
21
|
-
[*.svg]
|
|
22
|
-
insert_final_newline = false
|
|
1
|
+
# top-most EditorConfig file
|
|
2
|
+
root = true
|
|
3
|
+
|
|
4
|
+
# Global rules, override on case-by-case basis
|
|
5
|
+
[*]
|
|
6
|
+
charset = utf-8
|
|
7
|
+
indent_style = space
|
|
8
|
+
max_line_length = 120
|
|
9
|
+
tab_width = 2
|
|
10
|
+
end_of_line = lf
|
|
11
|
+
insert_final_newline = true
|
|
12
|
+
trim_trailing_whitespace = true
|
|
13
|
+
|
|
14
|
+
[*.{vue,js,ts,scss}]
|
|
15
|
+
quote_type = double
|
|
16
|
+
|
|
17
|
+
[*.md]
|
|
18
|
+
max_line_length = off
|
|
19
|
+
trim_trailing_whitespace = false
|
|
20
|
+
|
|
21
|
+
[*.svg]
|
|
22
|
+
insert_final_newline = false
|
package/dist/templates/base/_env
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
APP_BASE_PATH={{BasePath}}
|
|
2
|
-
APP_I18N_LOCALE=en
|
|
3
|
-
APP_I18N_FALLBACK_LOCALE=en
|
|
1
|
+
APP_BASE_PATH={{BasePath}}
|
|
2
|
+
APP_I18N_LOCALE=en
|
|
3
|
+
APP_I18N_FALLBACK_LOCALE=en
|
|
@@ -1 +1 @@
|
|
|
1
|
-
#APP_PLATFORM_URL=add_platform_url_here
|
|
1
|
+
#APP_PLATFORM_URL=add_platform_url_here
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
node_modules
|
|
2
|
-
dist
|
|
3
|
-
api-client.ts
|
|
1
|
+
node_modules
|
|
2
|
+
dist
|
|
3
|
+
api-client.ts
|
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
module.exports = {
|
|
2
|
-
root: true,
|
|
3
|
-
env: {
|
|
4
|
-
node: true,
|
|
5
|
-
},
|
|
6
|
-
plugins: ["@typescript-eslint", "vue", "import"],
|
|
7
|
-
extends: [
|
|
8
|
-
"plugin:vue/vue3-recommended",
|
|
9
|
-
"eslint:recommended",
|
|
10
|
-
"plugin:import/recommended",
|
|
11
|
-
"plugin:import/typescript",
|
|
12
|
-
"@vue/typescript/recommended",
|
|
13
|
-
"@vue/prettier",
|
|
14
|
-
"@vue/eslint-config-typescript/recommended",
|
|
15
|
-
],
|
|
16
|
-
parser: "vue-eslint-parser",
|
|
17
|
-
parserOptions: {
|
|
18
|
-
sourceType: "module",
|
|
19
|
-
ecmaVersion: 2022,
|
|
20
|
-
},
|
|
21
|
-
settings: {
|
|
22
|
-
"import/parsers": {
|
|
23
|
-
"@typescript-eslint/parser": [".ts"],
|
|
24
|
-
},
|
|
25
|
-
"import/resolver": {
|
|
26
|
-
typescript: {
|
|
27
|
-
project: ["./tsconfig.json"],
|
|
28
|
-
},
|
|
29
|
-
},
|
|
30
|
-
},
|
|
31
|
-
rules: {
|
|
32
|
-
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
|
|
33
|
-
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
|
|
34
|
-
"@typescript-eslint/ban-ts-comment": "warn",
|
|
35
|
-
"@typescript-eslint/no-unused-vars": "warn",
|
|
36
|
-
"vue/multi-word-component-names": "off",
|
|
37
|
-
"vue/require-default-prop": "off",
|
|
38
|
-
"vue/no-v-html": "off",
|
|
39
|
-
"vue/no-template-shadow": "off",
|
|
40
|
-
},
|
|
41
|
-
};
|
|
1
|
+
module.exports = {
|
|
2
|
+
root: true,
|
|
3
|
+
env: {
|
|
4
|
+
node: true,
|
|
5
|
+
},
|
|
6
|
+
plugins: ["@typescript-eslint", "vue", "import"],
|
|
7
|
+
extends: [
|
|
8
|
+
"plugin:vue/vue3-recommended",
|
|
9
|
+
"eslint:recommended",
|
|
10
|
+
"plugin:import/recommended",
|
|
11
|
+
"plugin:import/typescript",
|
|
12
|
+
"@vue/typescript/recommended",
|
|
13
|
+
"@vue/prettier",
|
|
14
|
+
"@vue/eslint-config-typescript/recommended",
|
|
15
|
+
],
|
|
16
|
+
parser: "vue-eslint-parser",
|
|
17
|
+
parserOptions: {
|
|
18
|
+
sourceType: "module",
|
|
19
|
+
ecmaVersion: 2022,
|
|
20
|
+
},
|
|
21
|
+
settings: {
|
|
22
|
+
"import/parsers": {
|
|
23
|
+
"@typescript-eslint/parser": [".ts"],
|
|
24
|
+
},
|
|
25
|
+
"import/resolver": {
|
|
26
|
+
typescript: {
|
|
27
|
+
project: ["./tsconfig.json"],
|
|
28
|
+
},
|
|
29
|
+
},
|
|
30
|
+
},
|
|
31
|
+
rules: {
|
|
32
|
+
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
|
|
33
|
+
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
|
|
34
|
+
"@typescript-eslint/ban-ts-comment": "warn",
|
|
35
|
+
"@typescript-eslint/no-unused-vars": "warn",
|
|
36
|
+
"vue/multi-word-component-names": "off",
|
|
37
|
+
"vue/require-default-prop": "off",
|
|
38
|
+
"vue/no-v-html": "off",
|
|
39
|
+
"vue/no-template-shadow": "off",
|
|
40
|
+
},
|
|
41
|
+
};
|
|
@@ -1,91 +1,91 @@
|
|
|
1
|
-
# Git Commit Message Convention
|
|
2
|
-
|
|
3
|
-
## TL;DR
|
|
4
|
-
|
|
5
|
-
Messages must be matched by the following regex:
|
|
6
|
-
|
|
7
|
-
``` js
|
|
8
|
-
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Examples
|
|
12
|
-
|
|
13
|
-
Appears under "Features" header, `ui-kit` subheader:
|
|
14
|
-
|
|
15
|
-
``` text
|
|
16
|
-
feat(ui-kit): add 'comments' option
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
Appears under "Bug Fixes" header, `shell` subheader, with a link to issue #28:
|
|
20
|
-
|
|
21
|
-
``` text
|
|
22
|
-
fix(shell): handle events on blur
|
|
23
|
-
|
|
24
|
-
close #28
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
|
|
28
|
-
|
|
29
|
-
``` text
|
|
30
|
-
perf(api-client): improve vdom diffing by removing 'foo' option
|
|
31
|
-
|
|
32
|
-
BREAKING CHANGE: The 'foo' option has been removed.
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
|
|
36
|
-
|
|
37
|
-
``` text
|
|
38
|
-
revert: feat(ui-kit): add 'comments' option
|
|
39
|
-
|
|
40
|
-
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Full Message Format
|
|
44
|
-
|
|
45
|
-
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
|
|
46
|
-
|
|
47
|
-
``` text
|
|
48
|
-
<type>(<scope>): <subject>
|
|
49
|
-
<BLANK LINE>
|
|
50
|
-
<body>
|
|
51
|
-
<BLANK LINE>
|
|
52
|
-
<footer>
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
The **header** is mandatory and the **scope** of the header is optional.
|
|
56
|
-
|
|
57
|
-
A `!` MAY be appended prior to the `:` in the type/scope prefix, to further draw attention to breaking changes. `BREAKING CHANGE:` description MUST also be included in the body or footer, along with the `!` in the prefix.
|
|
58
|
-
|
|
59
|
-
### Revert
|
|
60
|
-
|
|
61
|
-
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
|
|
62
|
-
|
|
63
|
-
### Type
|
|
64
|
-
|
|
65
|
-
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
|
|
66
|
-
|
|
67
|
-
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
|
|
68
|
-
|
|
69
|
-
### Scope
|
|
70
|
-
|
|
71
|
-
The scope could be any valid lerna package name (located inside `packages` folder). For example `shell`, `ui-kit`, `api-client`, etc...
|
|
72
|
-
|
|
73
|
-
### Subject
|
|
74
|
-
|
|
75
|
-
The subject contains succinct description of the change:
|
|
76
|
-
|
|
77
|
-
* use the imperative, present tense: "change" not "changed" nor "changes"
|
|
78
|
-
* don't capitalize first letter
|
|
79
|
-
* no dot (.) at the end
|
|
80
|
-
|
|
81
|
-
### Body
|
|
82
|
-
|
|
83
|
-
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
|
|
84
|
-
The body should include the motivation for the change and contrast this with previous behavior.
|
|
85
|
-
|
|
86
|
-
### Footer
|
|
87
|
-
|
|
88
|
-
The footer should contain any information about **Breaking Changes** and is also the place to
|
|
89
|
-
reference GitHub issues that this commit **Closes**.
|
|
90
|
-
|
|
91
|
-
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
|
1
|
+
# Git Commit Message Convention
|
|
2
|
+
|
|
3
|
+
## TL;DR
|
|
4
|
+
|
|
5
|
+
Messages must be matched by the following regex:
|
|
6
|
+
|
|
7
|
+
``` js
|
|
8
|
+
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Examples
|
|
12
|
+
|
|
13
|
+
Appears under "Features" header, `ui-kit` subheader:
|
|
14
|
+
|
|
15
|
+
``` text
|
|
16
|
+
feat(ui-kit): add 'comments' option
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Appears under "Bug Fixes" header, `shell` subheader, with a link to issue #28:
|
|
20
|
+
|
|
21
|
+
``` text
|
|
22
|
+
fix(shell): handle events on blur
|
|
23
|
+
|
|
24
|
+
close #28
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
|
|
28
|
+
|
|
29
|
+
``` text
|
|
30
|
+
perf(api-client): improve vdom diffing by removing 'foo' option
|
|
31
|
+
|
|
32
|
+
BREAKING CHANGE: The 'foo' option has been removed.
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
|
|
36
|
+
|
|
37
|
+
``` text
|
|
38
|
+
revert: feat(ui-kit): add 'comments' option
|
|
39
|
+
|
|
40
|
+
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Full Message Format
|
|
44
|
+
|
|
45
|
+
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
|
|
46
|
+
|
|
47
|
+
``` text
|
|
48
|
+
<type>(<scope>): <subject>
|
|
49
|
+
<BLANK LINE>
|
|
50
|
+
<body>
|
|
51
|
+
<BLANK LINE>
|
|
52
|
+
<footer>
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The **header** is mandatory and the **scope** of the header is optional.
|
|
56
|
+
|
|
57
|
+
A `!` MAY be appended prior to the `:` in the type/scope prefix, to further draw attention to breaking changes. `BREAKING CHANGE:` description MUST also be included in the body or footer, along with the `!` in the prefix.
|
|
58
|
+
|
|
59
|
+
### Revert
|
|
60
|
+
|
|
61
|
+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
|
|
62
|
+
|
|
63
|
+
### Type
|
|
64
|
+
|
|
65
|
+
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
|
|
66
|
+
|
|
67
|
+
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
|
|
68
|
+
|
|
69
|
+
### Scope
|
|
70
|
+
|
|
71
|
+
The scope could be any valid lerna package name (located inside `packages` folder). For example `shell`, `ui-kit`, `api-client`, etc...
|
|
72
|
+
|
|
73
|
+
### Subject
|
|
74
|
+
|
|
75
|
+
The subject contains succinct description of the change:
|
|
76
|
+
|
|
77
|
+
* use the imperative, present tense: "change" not "changed" nor "changes"
|
|
78
|
+
* don't capitalize first letter
|
|
79
|
+
* no dot (.) at the end
|
|
80
|
+
|
|
81
|
+
### Body
|
|
82
|
+
|
|
83
|
+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
|
|
84
|
+
The body should include the motivation for the change and contrast this with previous behavior.
|
|
85
|
+
|
|
86
|
+
### Footer
|
|
87
|
+
|
|
88
|
+
The footer should contain any information about **Breaking Changes** and is also the place to
|
|
89
|
+
reference GitHub issues that this commit **Closes**.
|
|
90
|
+
|
|
91
|
+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Project Task
|
|
2
|
-
<!-- paste a link to related issue -->
|
|
3
|
-
Closes #
|
|
4
|
-
|
|
5
|
-
## Scope of work
|
|
6
|
-
<!-- describe what you did -->
|
|
7
|
-
|
|
8
|
-
## Checklist
|
|
1
|
+
# Project Task
|
|
2
|
+
<!-- paste a link to related issue -->
|
|
3
|
+
Closes #
|
|
4
|
+
|
|
5
|
+
## Scope of work
|
|
6
|
+
<!-- describe what you did -->
|
|
7
|
+
|
|
8
|
+
## Checklist
|
|
@@ -1,71 +1,71 @@
|
|
|
1
|
-
# OS Specific
|
|
2
|
-
.DS_Store
|
|
3
|
-
.DS_Store?
|
|
4
|
-
._*
|
|
5
|
-
.Spotlight-V100
|
|
6
|
-
.Trashes
|
|
7
|
-
ehthumbs.db
|
|
8
|
-
Thumbs.db
|
|
9
|
-
|
|
10
|
-
# IDE Specific
|
|
11
|
-
nbproject
|
|
12
|
-
.~lock.*
|
|
13
|
-
.buildpath
|
|
14
|
-
.idea
|
|
15
|
-
.project
|
|
16
|
-
.settings
|
|
17
|
-
composer.lock
|
|
18
|
-
*.sublime-workspace
|
|
19
|
-
*.suo
|
|
20
|
-
*.ntvs*
|
|
21
|
-
*.njsproj
|
|
22
|
-
*.sln
|
|
23
|
-
*.sw?
|
|
24
|
-
|
|
25
|
-
# Project Specific
|
|
26
|
-
node_modules
|
|
27
|
-
*.log
|
|
28
|
-
/lib
|
|
29
|
-
tmp
|
|
30
|
-
.changelog
|
|
31
|
-
coverage/
|
|
32
|
-
.nyc_output/
|
|
33
|
-
.eslintcache
|
|
34
|
-
|
|
35
|
-
# local env files
|
|
36
|
-
.env.local
|
|
37
|
-
.env.*.local
|
|
38
|
-
|
|
39
|
-
# compiled output
|
|
40
|
-
dist/
|
|
41
|
-
storybook-static
|
|
42
|
-
*.tsbuildinfo
|
|
43
|
-
|
|
44
|
-
# IDEs and editors
|
|
45
|
-
/.idea
|
|
46
|
-
.project
|
|
47
|
-
.classpath
|
|
48
|
-
.c9/
|
|
49
|
-
*.launch
|
|
50
|
-
|
|
51
|
-
# IDE - VSCode
|
|
52
|
-
.vscode/*
|
|
53
|
-
!.vscode/settings.json
|
|
54
|
-
!.vscode/tasks.json
|
|
55
|
-
!.vscode/launch.json
|
|
56
|
-
!.vscode/extensions.json
|
|
57
|
-
.history/*
|
|
58
|
-
|
|
59
|
-
# Visual Studio 2015/2017 cache/options directory
|
|
60
|
-
.vs/*
|
|
61
|
-
|
|
62
|
-
# Temporary
|
|
63
|
-
package-lock.json
|
|
64
|
-
|
|
65
|
-
.pnp.*
|
|
66
|
-
.yarn/*
|
|
67
|
-
!.yarn/patches
|
|
68
|
-
!.yarn/plugins
|
|
69
|
-
!.yarn/releases
|
|
70
|
-
!.yarn/sdks
|
|
71
|
-
!.yarn/versions
|
|
1
|
+
# OS Specific
|
|
2
|
+
.DS_Store
|
|
3
|
+
.DS_Store?
|
|
4
|
+
._*
|
|
5
|
+
.Spotlight-V100
|
|
6
|
+
.Trashes
|
|
7
|
+
ehthumbs.db
|
|
8
|
+
Thumbs.db
|
|
9
|
+
|
|
10
|
+
# IDE Specific
|
|
11
|
+
nbproject
|
|
12
|
+
.~lock.*
|
|
13
|
+
.buildpath
|
|
14
|
+
.idea
|
|
15
|
+
.project
|
|
16
|
+
.settings
|
|
17
|
+
composer.lock
|
|
18
|
+
*.sublime-workspace
|
|
19
|
+
*.suo
|
|
20
|
+
*.ntvs*
|
|
21
|
+
*.njsproj
|
|
22
|
+
*.sln
|
|
23
|
+
*.sw?
|
|
24
|
+
|
|
25
|
+
# Project Specific
|
|
26
|
+
node_modules
|
|
27
|
+
*.log
|
|
28
|
+
/lib
|
|
29
|
+
tmp
|
|
30
|
+
.changelog
|
|
31
|
+
coverage/
|
|
32
|
+
.nyc_output/
|
|
33
|
+
.eslintcache
|
|
34
|
+
|
|
35
|
+
# local env files
|
|
36
|
+
.env.local
|
|
37
|
+
.env.*.local
|
|
38
|
+
|
|
39
|
+
# compiled output
|
|
40
|
+
dist/
|
|
41
|
+
storybook-static
|
|
42
|
+
*.tsbuildinfo
|
|
43
|
+
|
|
44
|
+
# IDEs and editors
|
|
45
|
+
/.idea
|
|
46
|
+
.project
|
|
47
|
+
.classpath
|
|
48
|
+
.c9/
|
|
49
|
+
*.launch
|
|
50
|
+
|
|
51
|
+
# IDE - VSCode
|
|
52
|
+
.vscode/*
|
|
53
|
+
!.vscode/settings.json
|
|
54
|
+
!.vscode/tasks.json
|
|
55
|
+
!.vscode/launch.json
|
|
56
|
+
!.vscode/extensions.json
|
|
57
|
+
.history/*
|
|
58
|
+
|
|
59
|
+
# Visual Studio 2015/2017 cache/options directory
|
|
60
|
+
.vs/*
|
|
61
|
+
|
|
62
|
+
# Temporary
|
|
63
|
+
package-lock.json
|
|
64
|
+
|
|
65
|
+
.pnp.*
|
|
66
|
+
.yarn/*
|
|
67
|
+
!.yarn/patches
|
|
68
|
+
!.yarn/plugins
|
|
69
|
+
!.yarn/releases
|
|
70
|
+
!.yarn/sdks
|
|
71
|
+
!.yarn/versions
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#!/bin/sh
|
|
2
|
-
. "$(dirname "$0")/_/husky.sh"
|
|
3
|
-
|
|
4
|
-
#npx --no-install commitlint --edit "$1"
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
. "$(dirname "$0")/_/husky.sh"
|
|
3
|
+
|
|
4
|
+
#npx --no-install commitlint --edit "$1"
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#!/bin/sh
|
|
2
|
-
. "$(dirname "$0")/_/husky.sh"
|
|
3
|
-
|
|
4
|
-
#npm run lint-staged
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
. "$(dirname "$0")/_/husky.sh"
|
|
3
|
+
|
|
4
|
+
#npm run lint-staged
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
"@types/node": "^20.10.5",
|
|
24
24
|
"@typescript-eslint/eslint-plugin": "^6.16.0",
|
|
25
25
|
"@typescript-eslint/parser": "^6.16.0",
|
|
26
|
-
"@vc-shell/api-client-generator": "^1.0.
|
|
27
|
-
"@vc-shell/release-config": "^1.0.
|
|
28
|
-
"@vc-shell/ts-config": "^1.0.
|
|
26
|
+
"@vc-shell/api-client-generator": "^1.0.341-0",
|
|
27
|
+
"@vc-shell/release-config": "^1.0.341-0",
|
|
28
|
+
"@vc-shell/ts-config": "^1.0.341-0",
|
|
29
29
|
"@vitejs/plugin-vue": "5.0.3",
|
|
30
30
|
"@vue/eslint-config-prettier": "^9.0.0",
|
|
31
31
|
"@vue/eslint-config-typescript": "^12.0.0",
|
|
@@ -54,13 +54,12 @@
|
|
|
54
54
|
},
|
|
55
55
|
"dependencies": {
|
|
56
56
|
"@fortawesome/fontawesome-free": "^5.15.3",
|
|
57
|
-
"@vc-shell/config-generator": "^1.0.
|
|
58
|
-
"@vc-shell/framework": "^1.0.
|
|
57
|
+
"@vc-shell/config-generator": "^1.0.341-0",
|
|
58
|
+
"@vc-shell/framework": "^1.0.341-0",
|
|
59
59
|
"@vueuse/core": "^10.7.1",
|
|
60
60
|
"@vueuse/integrations": "^10.7.1",
|
|
61
61
|
"cross-spawn": "^7.0.3",
|
|
62
62
|
"moment": "^2.30.1",
|
|
63
|
-
"roboto-fontface": "^0.10.0",
|
|
64
63
|
"vee-validate": "^4.12.4",
|
|
65
64
|
"vue": "^3.4.19",
|
|
66
65
|
"vue-router": "^4.2.5"
|