@rushstack/heft-node-rig 1.7.1 → 1.8.2
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 +28 -27
- package/profiles/default/config/heft.json +134 -31
- package/profiles/default/config/typescript.json +18 -1
- package/profiles/default/tsconfig-base.json +1 -0
- package/CHANGELOG.json +0 -2369
- package/CHANGELOG.md +0 -726
package/package.json
CHANGED
|
@@ -1,28 +1,29 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
}
|
|
2
|
+
"name": "@rushstack/heft-node-rig",
|
|
3
|
+
"version": "1.8.2",
|
|
4
|
+
"description": "A rig package for Node.js projects that build using Heft",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/microsoft/rushstack.git",
|
|
9
|
+
"directory": "rigs/heft-node-rig"
|
|
10
|
+
},
|
|
11
|
+
"peerDependencies": {
|
|
12
|
+
"@rushstack/heft": "^0.44.4"
|
|
13
|
+
},
|
|
14
|
+
"dependencies": {
|
|
15
|
+
"@microsoft/api-extractor": "7.19.5",
|
|
16
|
+
"@rushstack/heft-jest-plugin": "0.2.5",
|
|
17
|
+
"eslint": "~8.7.0",
|
|
18
|
+
"jest-environment-node": "~27.4.2",
|
|
19
|
+
"typescript": "~4.5.2"
|
|
20
|
+
},
|
|
21
|
+
"devDependencies": {
|
|
22
|
+
"@rushstack/heft": "0.44.4"
|
|
23
|
+
},
|
|
24
|
+
"scripts": {
|
|
25
|
+
"build": "",
|
|
26
|
+
"_phase:build": ""
|
|
27
|
+
},
|
|
28
|
+
"readme": "## @rushstack/heft-node-rig\n\nA rig package for Node.js projects that build using [Heft](https://www.npmjs.com/package/@rushstack/heft)\nbuild system. To learn more about rig packages, consult the\n[@rushstack/rig-package](https://www.npmjs.com/package/@rushstack/rig-package) documentation.\n\nThis rig contains a single profile: `default`\n\nTo enable it, add a **rig.json** file to your project, as shown below:\n\n**config/rig.json**\n```js\n{\n \"$schema\": \"https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json\",\n\n \"rigPackageName\": \"@rushstack/heft-node-rig\"\n}\n```\n\nThe config files provided by this rig profile can be found in the [heft-node-rig/profiles/default](\nhttps://github.com/microsoft/rushstack/tree/master/rigs/heft-node-rig/profiles/default) source folder.\n\n\n## Links\n\n- [CHANGELOG.md](\n https://github.com/microsoft/rushstack/blob/master/rigs/heft-node-rig/CHANGELOG.md) - Find\n out what's new in the latest version\n\n`@rushstack/heft-node-rig` is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
|
|
29
|
+
}
|
|
@@ -4,32 +4,133 @@
|
|
|
4
4
|
{
|
|
5
5
|
"$schema": "https://developer.microsoft.com/json-schemas/heft/heft.schema.json",
|
|
6
6
|
|
|
7
|
+
/**
|
|
8
|
+
* Optionally specifies another JSON config file that this file extends from. This provides a way for standard
|
|
9
|
+
* settings to be shared across multiple projects.
|
|
10
|
+
*/
|
|
11
|
+
// "extends": "base-project/config/heft.json",
|
|
12
|
+
|
|
7
13
|
"eventActions": [
|
|
14
|
+
// {
|
|
15
|
+
// /**
|
|
16
|
+
// * (Required) The kind of built-in operation that should be performed.
|
|
17
|
+
// * The "deleteGlobs" action deletes files or folders that match the specified glob patterns.
|
|
18
|
+
// */
|
|
19
|
+
// "actionKind": "deleteGlobs",
|
|
20
|
+
//
|
|
21
|
+
// /**
|
|
22
|
+
// * (Required) The Heft stage when this action should be performed. Note that heft.json event actions
|
|
23
|
+
// * are scheduled after any plugin tasks have processed the event. For example, a "compile" event action
|
|
24
|
+
// * will be performed after the TypeScript compiler has been invoked.
|
|
25
|
+
// *
|
|
26
|
+
// * Options: "clean", "pre-compile", "compile", "bundle", "post-build"
|
|
27
|
+
// */
|
|
28
|
+
// "heftEvent": "clean",
|
|
29
|
+
//
|
|
30
|
+
// /**
|
|
31
|
+
// * (Required) A user-defined tag whose purpose is to allow configs to replace/delete handlers that
|
|
32
|
+
// * were added by other configs.
|
|
33
|
+
// */
|
|
34
|
+
// "actionId": "my-example-action",
|
|
35
|
+
//
|
|
36
|
+
// /**
|
|
37
|
+
// * (Required) Glob patterns to be deleted. The paths are resolved relative to the project folder.
|
|
38
|
+
// * Documentation for supported glob syntaxes: https://www.npmjs.com/package/fast-glob
|
|
39
|
+
// */
|
|
40
|
+
// "globsToDelete": [
|
|
41
|
+
// "dist",
|
|
42
|
+
// "lib",
|
|
43
|
+
// "lib-esnext",
|
|
44
|
+
// "temp"
|
|
45
|
+
// ]
|
|
46
|
+
// },
|
|
47
|
+
//
|
|
48
|
+
// {
|
|
49
|
+
// /**
|
|
50
|
+
// * (Required) The kind of built-in operation that should be performed.
|
|
51
|
+
// * The "copyFiles" action copies files that match the specified patterns.
|
|
52
|
+
// */
|
|
53
|
+
// "actionKind": "copyFiles",
|
|
54
|
+
//
|
|
55
|
+
// /**
|
|
56
|
+
// * (Required) The Heft stage when this action should be performed. Note that heft.json event actions
|
|
57
|
+
// * are scheduled after any plugin tasks have processed the event. For example, a "compile" event action
|
|
58
|
+
// * will be performed after the TypeScript compiler has been invoked.
|
|
59
|
+
// *
|
|
60
|
+
// * Options: "pre-compile", "compile", "bundle", "post-build"
|
|
61
|
+
// */
|
|
62
|
+
// "heftEvent": "pre-compile",
|
|
63
|
+
//
|
|
64
|
+
// /**
|
|
65
|
+
// * (Required) A user-defined tag whose purpose is to allow configs to replace/delete handlers that
|
|
66
|
+
// * were added by other configs.
|
|
67
|
+
// */
|
|
68
|
+
// "actionId": "my-example-action",
|
|
69
|
+
//
|
|
70
|
+
// /**
|
|
71
|
+
// * (Required) An array of copy operations to run perform during the specified Heft event.
|
|
72
|
+
// */
|
|
73
|
+
// "copyOperations": [
|
|
74
|
+
// {
|
|
75
|
+
// /**
|
|
76
|
+
// * (Required) The base folder that files will be copied from, relative to the project root.
|
|
77
|
+
// * Settings such as "includeGlobs" and "excludeGlobs" will be resolved relative
|
|
78
|
+
// * to this folder.
|
|
79
|
+
// * NOTE: Assigning "sourceFolder" does not by itself select any files to be copied.
|
|
80
|
+
// */
|
|
81
|
+
// "sourceFolder": "src",
|
|
82
|
+
//
|
|
83
|
+
// /**
|
|
84
|
+
// * (Required) One or more folders that files will be copied into, relative to the project root.
|
|
85
|
+
// * If you specify more than one destination folder, Heft will read the input files only once, using
|
|
86
|
+
// * streams to efficiently write multiple outputs.
|
|
87
|
+
// */
|
|
88
|
+
// "destinationFolders": ["dist/assets"],
|
|
89
|
+
//
|
|
90
|
+
// /**
|
|
91
|
+
// * If specified, this option recursively scans all folders under "sourceFolder" and includes any files
|
|
92
|
+
// * that match the specified extensions. (If "fileExtensions" and "includeGlobs" are both
|
|
93
|
+
// * specified, their selections are added together.)
|
|
94
|
+
// */
|
|
95
|
+
// "fileExtensions": [".jpg", ".png"],
|
|
96
|
+
//
|
|
97
|
+
// /**
|
|
98
|
+
// * A list of glob patterns that select files to be copied. The paths are resolved relative
|
|
99
|
+
// * to "sourceFolder".
|
|
100
|
+
// * Documentation for supported glob syntaxes: https://www.npmjs.com/package/fast-glob
|
|
101
|
+
// */
|
|
102
|
+
// "includeGlobs": ["assets/*.md"],
|
|
103
|
+
//
|
|
104
|
+
// /**
|
|
105
|
+
// * A list of glob patterns that exclude files/folders from being copied. The paths are resolved relative
|
|
106
|
+
// * to "sourceFolder". These exclusions eliminate items that were selected by the "includeGlobs"
|
|
107
|
+
// * or "fileExtensions" setting.
|
|
108
|
+
// */
|
|
109
|
+
// "excludeGlobs": [],
|
|
110
|
+
//
|
|
111
|
+
// /**
|
|
112
|
+
// * Normally, when files are selected under a child folder, a corresponding folder will be created in
|
|
113
|
+
// * the destination folder. Specify flatten=true to discard the source path and copy all matching files
|
|
114
|
+
// * to the same folder. If two files have the same name an error will be reported.
|
|
115
|
+
// * The default value is false.
|
|
116
|
+
// */
|
|
117
|
+
// "flatten": false,
|
|
118
|
+
//
|
|
119
|
+
// /**
|
|
120
|
+
// * If true, filesystem hard links will be created instead of copying the file. Depending on the
|
|
121
|
+
// * operating system, this may be faster. (But note that it may cause unexpected behavior if a tool
|
|
122
|
+
// * modifies the link.) The default value is false.
|
|
123
|
+
// */
|
|
124
|
+
// "hardlink": false
|
|
125
|
+
// }
|
|
126
|
+
// ]
|
|
127
|
+
// }
|
|
128
|
+
|
|
8
129
|
{
|
|
9
|
-
/**
|
|
10
|
-
* The kind of built-in operation that should be performed.
|
|
11
|
-
* The "deleteGlobs" action deletes files or folders that match the
|
|
12
|
-
* specified glob patterns.
|
|
13
|
-
*/
|
|
14
130
|
"actionKind": "deleteGlobs",
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* The stage of the Heft run during which this action should occur. Note that actions specified in heft.json
|
|
18
|
-
* occur at the end of the stage of the Heft run.
|
|
19
|
-
*/
|
|
20
131
|
"heftEvent": "clean",
|
|
21
|
-
|
|
22
|
-
/**
|
|
23
|
-
* A user-defined tag whose purpose is to allow configs to replace/delete handlers that were added by other
|
|
24
|
-
* configs.
|
|
25
|
-
*/
|
|
26
132
|
"actionId": "defaultClean",
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Glob patterns to be deleted. The paths are resolved relative to the project folder.
|
|
30
|
-
* Recommend exactly matching with "projectOutputFolderNames" in rush-project.json.
|
|
31
|
-
*/
|
|
32
|
-
"globsToDelete": ["dist", "lib", "temp"]
|
|
133
|
+
"globsToDelete": ["dist", "lib", "lib-commonjs", "temp"]
|
|
33
134
|
}
|
|
34
135
|
],
|
|
35
136
|
|
|
@@ -37,16 +138,18 @@
|
|
|
37
138
|
* The list of Heft plugins to be loaded.
|
|
38
139
|
*/
|
|
39
140
|
"heftPlugins": [
|
|
40
|
-
{
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
141
|
+
// {
|
|
142
|
+
// /**
|
|
143
|
+
// * The path to the plugin package.
|
|
144
|
+
// */
|
|
145
|
+
// "plugin": "path/to/my-plugin",
|
|
146
|
+
//
|
|
147
|
+
// /**
|
|
148
|
+
// * An optional object that provides additional settings that may be defined by the plugin.
|
|
149
|
+
// */
|
|
150
|
+
// // "options": { }
|
|
151
|
+
// }
|
|
45
152
|
|
|
46
|
-
|
|
47
|
-
* An optional object that provides additional settings that may be defined by the plugin.
|
|
48
|
-
*/
|
|
49
|
-
// "options": { }
|
|
50
|
-
}
|
|
153
|
+
{ "plugin": "@rushstack/heft-jest-plugin" }
|
|
51
154
|
]
|
|
52
155
|
}
|
|
@@ -4,6 +4,12 @@
|
|
|
4
4
|
{
|
|
5
5
|
"$schema": "https://developer.microsoft.com/json-schemas/heft/typescript.schema.json",
|
|
6
6
|
|
|
7
|
+
/**
|
|
8
|
+
* Optionally specifies another JSON config file that this file extends from. This provides a way for standard
|
|
9
|
+
* settings to be shared across multiple projects.
|
|
10
|
+
*/
|
|
11
|
+
// "extends": "base-project/config/typescript.json",
|
|
12
|
+
|
|
7
13
|
/**
|
|
8
14
|
* If provided, emit these module kinds in addition to the modules specified in the tsconfig.
|
|
9
15
|
* Note that this option only applies to the main tsconfig.json configuration.
|
|
@@ -22,6 +28,16 @@
|
|
|
22
28
|
// }
|
|
23
29
|
],
|
|
24
30
|
|
|
31
|
+
/**
|
|
32
|
+
* If true, emit CommonJS module output to the folder specified in the tsconfig "outDir" compiler option with the .cjs extension alongside (or instead of, if TSConfig specifies CommonJS) the default compilation output.
|
|
33
|
+
*/
|
|
34
|
+
// "emitCjsExtensionForCommonJS": true,
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* If true, emit ESNext module output to the folder specified in the tsconfig "outDir" compiler option with the .mjs extension alongside (or instead of, if TSConfig specifies ESNext) the default compilation output.
|
|
38
|
+
*/
|
|
39
|
+
// "emitMjsExtensionForESModule": true,
|
|
40
|
+
|
|
25
41
|
/**
|
|
26
42
|
* Specifies the intermediary folder that tests will use. Because Jest uses the
|
|
27
43
|
* Node.js runtime to execute tests, the module format must be CommonJS.
|
|
@@ -42,7 +58,8 @@
|
|
|
42
58
|
// "maxWriteParallelism": 50,
|
|
43
59
|
|
|
44
60
|
/**
|
|
45
|
-
*
|
|
61
|
+
* Configures additional file types that should be copied into the TypeScript compiler's emit folders, for example
|
|
62
|
+
* so that these files can be resolved by import statements.
|
|
46
63
|
*/
|
|
47
64
|
"staticAssetsToCopy": {
|
|
48
65
|
/**
|