@ohos-ports/nx 19.8.4-beta.0 → 19.8.4-beta.1
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/package.json +20 -8
- package/src/native/index.js +1 -0
- package/src/native/native-bindings.js +10 -16
- package/src/native/{nx.openharmony-arm64.node → nx.ohos-arm64.node} +0 -0
- package/.eslintrc.json +0 -140
- package/node_modules/@nrwl/tao/LICENSE +0 -22
- package/node_modules/@nrwl/tao/README.md +0 -18
- package/node_modules/@nrwl/tao/index.d.ts +0 -1
- package/node_modules/@nrwl/tao/index.js +0 -7
- package/node_modules/@nrwl/tao/package.json +0 -41
- package/node_modules/@nrwl/tao/src/commands/ngcli-adapter.d.ts +0 -1
- package/node_modules/@nrwl/tao/src/commands/ngcli-adapter.js +0 -5
- package/node_modules/@nrwl/tao/src/shared/logger.d.ts +0 -1
- package/node_modules/@nrwl/tao/src/shared/logger.js +0 -5
- package/node_modules/@nrwl/tao/src/shared/nx.d.ts +0 -1
- package/node_modules/@nrwl/tao/src/shared/nx.js +0 -5
- package/node_modules/@nrwl/tao/src/shared/package-manager.d.ts +0 -1
- package/node_modules/@nrwl/tao/src/shared/package-manager.js +0 -5
- package/node_modules/@nrwl/tao/src/shared/project-graph.d.ts +0 -1
- package/node_modules/@nrwl/tao/src/shared/project-graph.js +0 -5
- package/node_modules/@nrwl/tao/src/shared/tree.d.ts +0 -1
- package/node_modules/@nrwl/tao/src/shared/tree.js +0 -5
- package/node_modules/@nrwl/tao/src/utils/app-root.d.ts +0 -1
- package/node_modules/@nrwl/tao/src/utils/app-root.js +0 -5
- package/release/changelog-renderer/index.d.ts +0 -80
- package/release/changelog-renderer/index.js +0 -315
- package/release/index.d.ts +0 -4
- package/release/index.js +0 -12
- package/schemas/nx-schema.json +0 -819
- package/schemas/project-schema.json +0 -331
- package/schemas/workspace-schema.json +0 -185
- package/tasks-runners/default.d.ts +0 -1
- package/tasks-runners/default.js +0 -5
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ohos-ports/nx",
|
|
3
|
-
"version": "19.8.4-beta.
|
|
3
|
+
"version": "19.8.4-beta.1",
|
|
4
4
|
"private": false,
|
|
5
|
-
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.
|
|
5
|
+
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
8
|
"url": "https://github.com/ohos-ports/ohos-ports.git",
|
|
9
|
-
"directory": "ports
|
|
9
|
+
"directory": "ports/nx/19.8.4"
|
|
10
10
|
},
|
|
11
11
|
"keywords": [
|
|
12
12
|
"Monorepo",
|
|
@@ -29,6 +29,9 @@
|
|
|
29
29
|
},
|
|
30
30
|
"author": "Victor Savkin",
|
|
31
31
|
"license": "MIT",
|
|
32
|
+
"bugs": {
|
|
33
|
+
"url": "https://github.com/ohos-ports/ohos-ports/issues"
|
|
34
|
+
},
|
|
32
35
|
"homepage": "https://nx.dev",
|
|
33
36
|
"dependencies": {
|
|
34
37
|
"@napi-rs/wasm-runtime": "0.2.4",
|
|
@@ -189,10 +192,19 @@
|
|
|
189
192
|
"scripts": {
|
|
190
193
|
"postinstall": "node ./bin/post-install"
|
|
191
194
|
},
|
|
192
|
-
"
|
|
193
|
-
"
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
"
|
|
195
|
+
"files": [
|
|
196
|
+
"bin/",
|
|
197
|
+
"init/",
|
|
198
|
+
"presets/",
|
|
199
|
+
"src/",
|
|
200
|
+
"plugins/",
|
|
201
|
+
"executors.json",
|
|
202
|
+
"generators.json",
|
|
203
|
+
"migrations.json",
|
|
204
|
+
"index.js",
|
|
205
|
+
"index.d.ts",
|
|
206
|
+
"package.json",
|
|
207
|
+
"README.md",
|
|
208
|
+
"LICENSE"
|
|
197
209
|
]
|
|
198
210
|
}
|
package/src/native/index.js
CHANGED
|
@@ -192,22 +192,6 @@ function requireNative() {
|
|
|
192
192
|
} else {
|
|
193
193
|
loadErrors.push(new Error(`Unsupported architecture on FreeBSD: ${process.arch}`))
|
|
194
194
|
}
|
|
195
|
-
} else if (process.platform === 'openharmony') {
|
|
196
|
-
if (process.arch === 'arm64') {
|
|
197
|
-
try {
|
|
198
|
-
return require('./nx.openharmony-arm64.node')
|
|
199
|
-
} catch (e) {
|
|
200
|
-
loadErrors.push(e)
|
|
201
|
-
}
|
|
202
|
-
try {
|
|
203
|
-
return require('@nx/nx-openharmony-arm64')
|
|
204
|
-
} catch (e) {
|
|
205
|
-
loadErrors.push(e)
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
} else {
|
|
209
|
-
loadErrors.push(new Error(`Unsupported architecture on OpenHarmony: ${process.arch}`))
|
|
210
|
-
}
|
|
211
195
|
} else if (process.platform === 'linux') {
|
|
212
196
|
if (process.arch === 'x64') {
|
|
213
197
|
if (isMusl()) {
|
|
@@ -340,6 +324,16 @@ function requireNative() {
|
|
|
340
324
|
} else {
|
|
341
325
|
loadErrors.push(new Error(`Unsupported architecture on Linux: ${process.arch}`))
|
|
342
326
|
}
|
|
327
|
+
} else if (process.platform === 'openharmony') {
|
|
328
|
+
if (process.arch === 'arm64') {
|
|
329
|
+
try {
|
|
330
|
+
return require('./nx.ohos-arm64.node')
|
|
331
|
+
} catch (e) {
|
|
332
|
+
loadErrors.push(e)
|
|
333
|
+
}
|
|
334
|
+
} else {
|
|
335
|
+
loadErrors.push(new Error(`Unsupported architecture on openharmony: ${process.arch}`))
|
|
336
|
+
}
|
|
343
337
|
} else {
|
|
344
338
|
loadErrors.push(new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`))
|
|
345
339
|
}
|
|
Binary file
|
package/.eslintrc.json
DELETED
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"extends": "../../.eslintrc",
|
|
3
|
-
"rules": {},
|
|
4
|
-
"ignorePatterns": ["!**/*", "**/__fixtures__/**/*"],
|
|
5
|
-
"overrides": [
|
|
6
|
-
{
|
|
7
|
-
"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
|
|
8
|
-
"rules": {
|
|
9
|
-
"no-restricted-imports": [
|
|
10
|
-
"error",
|
|
11
|
-
{
|
|
12
|
-
"paths": [
|
|
13
|
-
{
|
|
14
|
-
"name": "fs-extra",
|
|
15
|
-
"message": "Please use equivalent utilities from `node:fs` instead."
|
|
16
|
-
}
|
|
17
|
-
],
|
|
18
|
-
"patterns": [
|
|
19
|
-
{
|
|
20
|
-
"group": ["**/devkit-exports"],
|
|
21
|
-
"message": "Do not import from devkit-exports from the nx package"
|
|
22
|
-
}
|
|
23
|
-
]
|
|
24
|
-
}
|
|
25
|
-
]
|
|
26
|
-
}
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
"files": ["*.ts"],
|
|
30
|
-
"excludedFiles": ["*.spec.ts"],
|
|
31
|
-
"rules": {
|
|
32
|
-
"@typescript-eslint/no-restricted-imports": [
|
|
33
|
-
"error",
|
|
34
|
-
{
|
|
35
|
-
"paths": [
|
|
36
|
-
{
|
|
37
|
-
"name": "typescript",
|
|
38
|
-
"message": "TypeScript is an optional dependency for Nx. If you need to use it, make sure its installed first with ensureTypescript.",
|
|
39
|
-
"allowTypeImports": true
|
|
40
|
-
}
|
|
41
|
-
],
|
|
42
|
-
"patterns": [
|
|
43
|
-
{
|
|
44
|
-
"group": ["nx/*"],
|
|
45
|
-
"message": "Circular import in 'nx' found. Use relative path."
|
|
46
|
-
},
|
|
47
|
-
{
|
|
48
|
-
"group": ["**/native-bindings", "**/native-bindings.js"],
|
|
49
|
-
"message": "Direct imports from native-bindings.js are not allowed. Import from index.js instead."
|
|
50
|
-
}
|
|
51
|
-
]
|
|
52
|
-
}
|
|
53
|
-
]
|
|
54
|
-
}
|
|
55
|
-
},
|
|
56
|
-
{
|
|
57
|
-
"files": ["*.js", "*.jsx"],
|
|
58
|
-
"rules": {}
|
|
59
|
-
},
|
|
60
|
-
{
|
|
61
|
-
"files": ["./package.json", "./executors.json", "./migrations.json"],
|
|
62
|
-
"parser": "jsonc-eslint-parser",
|
|
63
|
-
"rules": {
|
|
64
|
-
"@nx/nx-plugin-checks": [
|
|
65
|
-
"error",
|
|
66
|
-
{
|
|
67
|
-
"allowedVersionStrings": ["latest"]
|
|
68
|
-
}
|
|
69
|
-
]
|
|
70
|
-
}
|
|
71
|
-
},
|
|
72
|
-
{
|
|
73
|
-
"files": ["nxw.ts"],
|
|
74
|
-
"rules": {
|
|
75
|
-
"@typescript-eslint/no-restricted-imports": [
|
|
76
|
-
"error",
|
|
77
|
-
{
|
|
78
|
-
"patterns": [
|
|
79
|
-
{
|
|
80
|
-
"group": ["*", "!fs"],
|
|
81
|
-
"message": "The Nx wrapper is ran before packages are installed. It should only import node builtins.",
|
|
82
|
-
"allowTypeImports": true
|
|
83
|
-
}
|
|
84
|
-
]
|
|
85
|
-
}
|
|
86
|
-
],
|
|
87
|
-
"no-restricted-modules": [
|
|
88
|
-
"error",
|
|
89
|
-
{
|
|
90
|
-
"patterns": ["*", "!fs", "!path", "!child_process", "!node:*"]
|
|
91
|
-
}
|
|
92
|
-
],
|
|
93
|
-
"no-restricted-imports": "off"
|
|
94
|
-
}
|
|
95
|
-
},
|
|
96
|
-
{
|
|
97
|
-
"files": ["./package.json"],
|
|
98
|
-
"parser": "jsonc-eslint-parser",
|
|
99
|
-
"rules": {
|
|
100
|
-
"@nx/dependency-checks": [
|
|
101
|
-
"error",
|
|
102
|
-
{
|
|
103
|
-
"buildTargets": ["build-base"],
|
|
104
|
-
"ignoredDependencies": [
|
|
105
|
-
"typescript",
|
|
106
|
-
"@nrwl/angular",
|
|
107
|
-
"@angular-devkit/build-angular",
|
|
108
|
-
"@angular-devkit/core",
|
|
109
|
-
"@angular-devkit/architect",
|
|
110
|
-
"@swc/core", //Optional, used in JS analysis if available
|
|
111
|
-
"@swc/node-register", //Optional, used in JS analysis if available
|
|
112
|
-
"rxjs",
|
|
113
|
-
"@angular-devkit/schematics",
|
|
114
|
-
"@pnpm/lockfile-types",
|
|
115
|
-
"@nestjs/cli", // nx init nest makes use of nestjs cli (which should be available in NestJS CLI app) to parse the nest-cli.json file
|
|
116
|
-
"ts-node", // We *may* fall back on ts-node, but we want to encourage the use of @swc-node instead so we don't explicitly list ts-node as an optional dep
|
|
117
|
-
"memfs", // used in mock for handling .node files in tests
|
|
118
|
-
"events", // This is coming from @storybook/builder-manager since it uses the browser polyfill
|
|
119
|
-
"process", // This is coming from @storybook/builder-manager since it uses the browser polyfill
|
|
120
|
-
"prettier", // This is coming from @storybook/builder-manager since it uses the browser polyfill
|
|
121
|
-
"util", // This is coming from @storybook/builder-manager since it uses the browser polyfill
|
|
122
|
-
// The native modules are optional and only one of them will ever be installed on a given machine
|
|
123
|
-
"@nx/nx-darwin-x64",
|
|
124
|
-
"@nx/nx-darwin-arm64",
|
|
125
|
-
"@nx/nx-linux-x64-gnu",
|
|
126
|
-
"@nx/nx-linux-x64-musl",
|
|
127
|
-
"@nx/nx-win32-x64-msvc",
|
|
128
|
-
"@nx/nx-linux-arm64-gnu",
|
|
129
|
-
"@nx/nx-linux-arm64-musl",
|
|
130
|
-
"@nx/nx-linux-arm-gnueabihf",
|
|
131
|
-
"@nx/nx-win32-arm64-msvc",
|
|
132
|
-
"@nx/nx-freebsd-x64",
|
|
133
|
-
"@nx/powerpack-license"
|
|
134
|
-
]
|
|
135
|
-
}
|
|
136
|
-
]
|
|
137
|
-
}
|
|
138
|
-
}
|
|
139
|
-
]
|
|
140
|
-
}
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
(The MIT License)
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2017-2024 Narwhal Technologies Inc.
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
|
6
|
-
a copy of this software and associated documentation files (the
|
|
7
|
-
'Software'), to deal in the Software without restriction, including
|
|
8
|
-
without limitation the rights to use, copy, modify, merge, publish,
|
|
9
|
-
distribute, sublicense, and/or sell copies of the Software, and to
|
|
10
|
-
permit persons to whom the Software is furnished to do so, subject to
|
|
11
|
-
the following conditions:
|
|
12
|
-
|
|
13
|
-
The above copyright notice and this permission notice shall be
|
|
14
|
-
included in all copies or substantial portions of the Software.
|
|
15
|
-
|
|
16
|
-
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
17
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
18
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
19
|
-
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
20
|
-
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
21
|
-
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
22
|
-
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
## @nrwl/tao has been merged with nx!
|
|
2
|
-
|
|
3
|
-
@nrwl/tao has been deprecated in favor of [nx](https://www.npmjs.com/package/nx). Please use that instead.
|
|
4
|
-
|
|
5
|
-
[Read more here](https://nx.dev/recipes/other/rescope)
|
|
6
|
-
|
|
7
|
-
@nrwl/tao will no longer be published in Nx v19.
|
|
8
|
-
|
|
9
|
-
<p style="text-align: center;">
|
|
10
|
-
<picture>
|
|
11
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
|
|
12
|
-
<img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
|
|
13
|
-
</picture>
|
|
14
|
-
</p>
|
|
15
|
-
|
|
16
|
-
# Nx: Smart Monorepos · Fast CI
|
|
17
|
-
|
|
18
|
-
Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
// this is to support older workspaces
|
|
3
|
-
if (process.argv[2] === 'migrate') {
|
|
4
|
-
process.argv[2] = '_migrate';
|
|
5
|
-
}
|
|
6
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Please update your global install of nx: https://nx.dev/more-concepts/global-nx`);
|
|
7
|
-
require('nx/bin/nx');
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@nrwl/tao",
|
|
3
|
-
"version": "19.8.4",
|
|
4
|
-
"private": false,
|
|
5
|
-
"description": "CLI for generating code and running commands",
|
|
6
|
-
"repository": {
|
|
7
|
-
"type": "git",
|
|
8
|
-
"url": "https://github.com/nrwl/nx.git",
|
|
9
|
-
"directory": "packages/tao"
|
|
10
|
-
},
|
|
11
|
-
"keywords": [
|
|
12
|
-
"Monorepo",
|
|
13
|
-
"Angular",
|
|
14
|
-
"React",
|
|
15
|
-
"Web",
|
|
16
|
-
"Node",
|
|
17
|
-
"Nest",
|
|
18
|
-
"Jest",
|
|
19
|
-
"Cypress",
|
|
20
|
-
"CLI"
|
|
21
|
-
],
|
|
22
|
-
"main": "./index",
|
|
23
|
-
"typings": "./index.d.ts",
|
|
24
|
-
"author": "Victor Savkin",
|
|
25
|
-
"license": "MIT",
|
|
26
|
-
"bugs": {
|
|
27
|
-
"url": "https://github.com/nrwl/nx/issues"
|
|
28
|
-
},
|
|
29
|
-
"bin": {
|
|
30
|
-
"tao": "./index.js"
|
|
31
|
-
},
|
|
32
|
-
"homepage": "https://nx.dev",
|
|
33
|
-
"dependencies": {
|
|
34
|
-
"tslib": "^2.3.0"
|
|
35
|
-
},
|
|
36
|
-
"publishConfig": {
|
|
37
|
-
"access": "public"
|
|
38
|
-
},
|
|
39
|
-
"type": "commonjs",
|
|
40
|
-
"types": "./index.d.ts"
|
|
41
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from 'nx/src/adapter/ngcli-adapter';
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const tslib_1 = require("tslib");
|
|
4
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Change to importing from '@nx/devkit/ngcli-adapter'`);
|
|
5
|
-
tslib_1.__exportStar(require("nx/src/adapter/ngcli-adapter"), exports);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from 'nx/src/utils/logger';
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const tslib_1 = require("tslib");
|
|
4
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Change to importing from '@nx/devkit'`);
|
|
5
|
-
tslib_1.__exportStar(require("nx/src/utils/logger"), exports);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from 'nx/src/config/nx-json';
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const tslib_1 = require("tslib");
|
|
4
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Change to importing from '@nx/devkit'`);
|
|
5
|
-
tslib_1.__exportStar(require("nx/src/config/nx-json"), exports);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from 'nx/src/utils/package-manager';
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const tslib_1 = require("tslib");
|
|
4
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Change to importing from '@nx/devkit'`);
|
|
5
|
-
tslib_1.__exportStar(require("nx/src/utils/package-manager"), exports);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from 'nx/src/config/project-graph';
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const tslib_1 = require("tslib");
|
|
4
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Change to importing from '@nx/devkit'`);
|
|
5
|
-
tslib_1.__exportStar(require("nx/src/config/project-graph"), exports);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from 'nx/src/generators/tree';
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const tslib_1 = require("tslib");
|
|
4
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Change to importing from '@nx/devkit'`);
|
|
5
|
-
tslib_1.__exportStar(require("nx/src/generators/tree"), exports);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from 'nx/src/utils/workspace-root';
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const tslib_1 = require("tslib");
|
|
4
|
-
console.warn(`@nrwl/tao has been deprecated and will not be published in Nx 17. Change to importing from '@nx/devkit'`);
|
|
5
|
-
tslib_1.__exportStar(require("nx/src/utils/workspace-root"), exports);
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
import { ChangelogChange } from '../../src/command-line/release/changelog';
|
|
2
|
-
import { NxReleaseConfig } from '../../src/command-line/release/config/config';
|
|
3
|
-
import { GitCommit } from '../../src/command-line/release/utils/git';
|
|
4
|
-
import { GithubRepoData, RepoSlug } from '../../src/command-line/release/utils/github';
|
|
5
|
-
import type { ProjectGraph } from '../../src/config/project-graph';
|
|
6
|
-
/**
|
|
7
|
-
* The ChangelogRenderOptions are specific to each ChangelogRenderer implementation, and are taken
|
|
8
|
-
* from the user's nx.json configuration and passed as is into the ChangelogRenderer function.
|
|
9
|
-
*/
|
|
10
|
-
export type ChangelogRenderOptions = Record<string, unknown>;
|
|
11
|
-
/**
|
|
12
|
-
* When versioning projects independently and enabling `"updateDependents": "always"`, there could
|
|
13
|
-
* be additional dependency bump information that is not captured in the commit data, but that nevertheless
|
|
14
|
-
* should be included in the rendered changelog.
|
|
15
|
-
*/
|
|
16
|
-
export type DependencyBump = {
|
|
17
|
-
dependencyName: string;
|
|
18
|
-
newVersion: string;
|
|
19
|
-
};
|
|
20
|
-
/**
|
|
21
|
-
* A ChangelogRenderer function takes in the extracted commits and other relevant metadata
|
|
22
|
-
* and returns a string, or a Promise of a string of changelog contents (usually markdown).
|
|
23
|
-
*
|
|
24
|
-
* @param {Object} config The configuration object for the ChangelogRenderer
|
|
25
|
-
* @param {ProjectGraph} config.projectGraph The project graph for the workspace
|
|
26
|
-
* @param {GitCommit[]} config.commits DEPRECATED [Use 'config.changes' instead] - The collection of extracted commits to generate a changelog for
|
|
27
|
-
* @param {ChangelogChange[]} config.changes The collection of changes to show in the changelog
|
|
28
|
-
* @param {string} config.releaseVersion The version that is being released
|
|
29
|
-
* @param {string | null} config.project The name of specific project to generate a changelog for, or `null` if the overall workspace changelog
|
|
30
|
-
* @param {string | false} config.entryWhenNoChanges The (already interpolated) string to use as the changelog entry when there are no changes, or `false` if no entry should be generated
|
|
31
|
-
* @param {ChangelogRenderOptions} config.changelogRenderOptions The options specific to the ChangelogRenderer implementation
|
|
32
|
-
* @param {DependencyBump[]} config.dependencyBumps Optional list of additional dependency bumps that occurred as part of the release, outside of the commit data
|
|
33
|
-
* @param {GithubRepoData} config.repoData Resolved data for the current GitHub repository
|
|
34
|
-
*/
|
|
35
|
-
export type ChangelogRenderer = (config: {
|
|
36
|
-
projectGraph: ProjectGraph;
|
|
37
|
-
commits?: GitCommit[];
|
|
38
|
-
changes?: ChangelogChange[];
|
|
39
|
-
releaseVersion: string;
|
|
40
|
-
project: string | null;
|
|
41
|
-
entryWhenNoChanges: string | false;
|
|
42
|
-
changelogRenderOptions: DefaultChangelogRenderOptions;
|
|
43
|
-
dependencyBumps?: DependencyBump[];
|
|
44
|
-
repoSlug?: RepoSlug;
|
|
45
|
-
repoData?: GithubRepoData;
|
|
46
|
-
conventionalCommitsConfig: NxReleaseConfig['conventionalCommits'] | null;
|
|
47
|
-
}) => Promise<string> | string;
|
|
48
|
-
/**
|
|
49
|
-
* The specific options available to the default implementation of the ChangelogRenderer that nx exports
|
|
50
|
-
* for the common case.
|
|
51
|
-
*/
|
|
52
|
-
export interface DefaultChangelogRenderOptions extends ChangelogRenderOptions {
|
|
53
|
-
/**
|
|
54
|
-
* Whether or not the commit authors should be added to the bottom of the changelog in a "Thank You"
|
|
55
|
-
* section. Defaults to true.
|
|
56
|
-
*/
|
|
57
|
-
authors?: boolean;
|
|
58
|
-
/**
|
|
59
|
-
* If authors is enabled, controls whether or not to try to map the authors to their GitHub usernames
|
|
60
|
-
* using https://ungh.cc (from https://github.com/unjs/ungh) and the email addresses found in the commits.
|
|
61
|
-
* Defaults to true.
|
|
62
|
-
*/
|
|
63
|
-
mapAuthorsToGitHubUsernames?: boolean;
|
|
64
|
-
/**
|
|
65
|
-
* Whether or not the commit references (such as commit and/or PR links) should be included in the changelog.
|
|
66
|
-
* Defaults to true.
|
|
67
|
-
*/
|
|
68
|
-
commitReferences?: boolean;
|
|
69
|
-
/**
|
|
70
|
-
* Whether or not to include the date in the version title. It can be set to false to disable it, or true to enable
|
|
71
|
-
* with the default of (YYYY-MM-DD). Defaults to true.
|
|
72
|
-
*/
|
|
73
|
-
versionTitleDate?: boolean;
|
|
74
|
-
}
|
|
75
|
-
/**
|
|
76
|
-
* The default ChangelogRenderer implementation that nx exports for the common case of generating markdown
|
|
77
|
-
* from the given commits and other metadata.
|
|
78
|
-
*/
|
|
79
|
-
declare const defaultChangelogRenderer: ChangelogRenderer;
|
|
80
|
-
export default defaultChangelogRenderer;
|