@storm-software/workspace-tools 1.16.0 → 1.16.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/CHANGELOG.md +7 -0
- package/README.md +120 -5
- package/package.json +1 -1
- package/src/executors/tsup/schema.json +35 -35
- package/src/generators/node-library/schema.json +1 -1
- package/src/generators/preset/files/docs/readme-templates/README.footer.md.template +2 -0
- package/src/generators/preset/schema.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
# [1.16.0](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.15.3...workspace-tools-v1.16.0) (2023-11-29)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* **git-tools:** Added executors and generators sections to the readme-gen CLI ([99aacba](https://github.com/storm-software/storm-ops/commit/99aacba62747cef1347bc87a0fff35fb2ffb0bde))
|
|
7
|
+
|
|
1
8
|
## [1.15.3](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.15.2...workspace-tools-v1.15.3) (2023-11-29)
|
|
2
9
|
|
|
3
10
|
|
package/README.md
CHANGED
|
@@ -3,7 +3,8 @@
|
|
|
3
3
|
<!-- markdownlint-disable -->
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/
|
|
6
|
+
<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" width="100%" altText="Storm Software" /></div>
|
|
7
|
+
<br />
|
|
7
8
|
|
|
8
9
|
<div align="center">
|
|
9
10
|
<a href="https://stormsoftware.org" target="_blank">Website</a> | <a href="https://stormsoftware.org/contact" target="_blank">Contact</a> | <a href="https://github.com/storm-software/stormstack" target="_blank">Repository</a> | <a href="https://stormstack.github.io/stormstack/" target="_blank">Documentation</a> | <a href="https://github.com/storm-software/stormstack/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a> | <a href="https://github.com/storm-software/stormstack/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=Feature Request%3A+">Request a Feature</a> | <a href="https://github.com/storm-software/stormstack/issues/new?assignees=&labels=documentation&template=documentation.yml&title=Documentation Request%3A+">Request Documentation</a> | <a href="https://github.com/storm-software/stormstack/discussions">Ask a Question</a>
|
|
@@ -15,10 +16,10 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
|
|
|
15
16
|
|
|
16
17
|
<h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
|
|
17
18
|
|
|
18
|
-
[](https://prettier.io/)
|
|
19
20
|
[](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://docusaurus.io/) 
|
|
20
21
|
|
|
21
|
-
<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️
|
|
22
|
+
<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.</h3><br />
|
|
22
23
|
|
|
23
24
|
|
|
24
25
|
<!-- markdownlint-restore -->
|
|
@@ -39,13 +40,125 @@ This library was generated with [Nx](https://nx.dev).
|
|
|
39
40
|
|
|
40
41
|
The following executors are available in this package to invoke common tasks for the workspace's projects:
|
|
41
42
|
|
|
42
|
-
|
|
43
|
+
## Tsup Build executor
|
|
44
|
+
|
|
45
|
+
Run a build on the project using tsup configuration
|
|
46
|
+
|
|
47
|
+
### Example
|
|
48
|
+
|
|
49
|
+
This executor can be used by executing the following in a command line utility:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
nx run my-project:tsup
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**Please note:** _The tsup executor should be included in the desired projects's `project.json` file._
|
|
56
|
+
|
|
57
|
+
### Options
|
|
58
|
+
|
|
59
|
+
The following executor options are available:
|
|
60
|
+
|
|
61
|
+
| Option | Type | Description | Default || --------- | ------ | ------------- | --------- || entry | `string` | The path to the entry file, relative to project. | "{sourceRoot}/index.ts" |
|
|
62
|
+
,| outputPath | `string` | The output path of the generated files. | "dist/{projectRoot}" |
|
|
63
|
+
,| tsConfig | `string` | The path to tsconfig file. | "tsconfig.json" |
|
|
64
|
+
,| additionalEntryPoints | `string[]` | List of additional entry points. | `` |
|
|
65
|
+
,| external | `string[]` | Mark one or more module as external. Can use * wildcards, such as '*.png'. | |
|
|
66
|
+
,| bundle | `boolean` | Whether to bundle the main entry point and additional entry points. Set to false to keep individual output files. | `true` |
|
|
67
|
+
,| watch | `boolean` | Enable re-building when files change. | |
|
|
68
|
+
,| assets | `array` | List of static assets. |`` |
|
|
69
|
+
,| clean | `boolean` | Remove previous output before build. | `true` |
|
|
70
|
+
,| includeSrc | `boolean` | Should the source files be added to the distribution folder in an `src` directory. | `true` |
|
|
71
|
+
,| debug | `boolean` | Should output be unminified with source mappings. | |
|
|
72
|
+
,| platform | "browser" \| "neutral" \| "node" \| "worker" | Platform target for outputs. | "neutral" |
|
|
73
|
+
,| banner | `string` | A short heading added to the top of each typescript file added in the output folder's src directory. | "This code was developed by Storm Software (https://stormsoftware.org) and is licensed under the Apache License 2.0." |
|
|
74
|
+
,| verbose | `boolean` | Should write extra log outputs with details from the executor. | |
|
|
75
|
+
,| define | `object` | Define global constants that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
76
|
+
,| env | `object` | Define environment variables that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
77
|
+
,| apiReport | `boolean` | Should API Extractor generate an API Report file. | `true` |
|
|
78
|
+
,| docModel | `boolean` | Should API Extractor generate an Doc Model markdown file. | `true` |
|
|
79
|
+
,| tsdocMetadata | `boolean` | Should API Extractor generate an TSDoc Metadata file. | `true` |
|
|
80
|
+
,| options | `object` | Additional options to pass to tsup. See https://paka.dev/npm/tsup@7.2.0/api#d35d54aca71eb26e. | |
|
|
81
|
+
,| plugins | `object[]` | List of ESBuild plugins to use during processing | `` |
|
|
82
|
+
,| required |`string` | | |
|
|
83
|
+
,| definitions |`string` | | |
|
|
43
84
|
|
|
44
85
|
## Generators
|
|
45
86
|
|
|
46
87
|
The following generators are available with this package to assist in workspace management:
|
|
47
88
|
|
|
48
|
-
|
|
89
|
+
## Init Storm Workspace Plugin
|
|
90
|
+
|
|
91
|
+
Init Storm Workspace Plugin.
|
|
92
|
+
|
|
93
|
+
### Options
|
|
94
|
+
|
|
95
|
+
The following executor options are available:
|
|
96
|
+
|
|
97
|
+
| Option | Type | Description | Default || --------- | ------ | ------------- | --------- || skipFormat | `boolean` | Skip formatting files. | |
|
|
98
|
+
|
|
99
|
+
## Storm Workspace preset
|
|
100
|
+
|
|
101
|
+
Storm workspace preset generator
|
|
102
|
+
|
|
103
|
+
### Examples
|
|
104
|
+
|
|
105
|
+
This generator can be used by executing the following examples in a command line utility:
|
|
106
|
+
|
|
107
|
+
#### Generate a storm workspace with the name: example-repo, namespace: storm-software, organization: storm-software, and repositoryUrl: 'https://github.com/storm-software/example-repo'.
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
nx g @storm-software/workspace-tools:preset --name 'example-repo'
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### Generate a storm workspace with the name: example-repo, namespace: example, and repositoryUrl: 'https://github.com/storm-software/example-repo'.
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example'
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
#### Generate a storm workspace with the name: example-repo, namespace: example, organization: example-org, description: 'An example workspace', and repositoryUrl: 'https://github.com/example-org/example-repo'.
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example' --organization 'example-org' --description 'An example workspace'
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Options
|
|
126
|
+
|
|
127
|
+
The following executor options are available:
|
|
128
|
+
|
|
129
|
+
| Option | Type | Description | Default || --------- | ------ | ------------- | --------- || name\* | `string` | The name of the workspace root. | |
|
|
130
|
+
,| organization\* | `string` | The organization that owns the workspace. | "storm-software" |
|
|
131
|
+
,| namespace | `string` | The npm scope used for the workspace. Defaults to the organization name. | |
|
|
132
|
+
,| includeApps\* | `boolean` | Should a separate `apps` folder be created for this workspace (if Yes: `apps` and `libs` folders will be added, if No: `packages` folders will be added)? | |
|
|
133
|
+
,| description | `string` | The description of the workspace to use in the package.json and README.md files. | |
|
|
134
|
+
,| repositoryUrl | `string` | The URL of the workspace in GitHub. Defaults to the https://github.com/<organization>/<name> | |
|
|
135
|
+
,| nxCloud | `boolean` | Should distributed caching with Nx Cloud be enabled for the workspace? | |
|
|
136
|
+
,| mode\* | "light" \| "dark" | Which client mode should be used for the Nx Task Runner? | "dark" |
|
|
137
|
+
,| packageManager | "npm" \| "yarn" \| "pnpm" | What package manager is used for the workspace? | "pnpm" |
|
|
138
|
+
|
|
139
|
+
**Please note:** _Option names followed by _ above are required, and must be provided to run the executor.\*
|
|
140
|
+
|
|
141
|
+
## node-library
|
|
142
|
+
|
|
143
|
+
Generate a new node library project in the Storm workspace
|
|
144
|
+
|
|
145
|
+
### Options
|
|
146
|
+
|
|
147
|
+
The following executor options are available:
|
|
148
|
+
|
|
149
|
+
| Option | Type | Description | Default || --------- | ------ | ------------- | --------- || name\* | `string` | A name for the library. | |
|
|
150
|
+
,| description | `string` | The library used by Storm Software for building TypeScript applications. | |
|
|
151
|
+
,| directory\* | `string` | A directory where the lib is placed. | |
|
|
152
|
+
,| projectNameAndRootFormat\* | "as-provided" \| "derived" | Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`). | |
|
|
153
|
+
,| tags | `string` | Add tags to the library (used for linting). | |
|
|
154
|
+
,| strict | `boolean` | Whether to enable tsconfig strict mode or not. | `true` |
|
|
155
|
+
,| publishable\* | `boolean` | Generate a publishable library. | |
|
|
156
|
+
,| importPath\* | `string` | The library name used to import it, like @storm-software/my-awesome-lib. Required for publishable library. | |
|
|
157
|
+
,| buildable\* | `boolean` | Generate a buildable library. | `true` |
|
|
158
|
+
,| setParserOptionsProject | `boolean` | Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons. | |
|
|
159
|
+
,| rootProject | `boolean` | Is the current project the root project in the workspace. | |
|
|
160
|
+
|
|
161
|
+
**Please note:** _Option names followed by _ above are required, and must be provided to run the executor.\*
|
|
49
162
|
|
|
50
163
|
## Building
|
|
51
164
|
|
|
@@ -139,6 +252,8 @@ This project follows the [all-contributors](https://github.com/all-contributors/
|
|
|
139
252
|
<div align="center">
|
|
140
253
|
<img src="https://pub-e71cff0f90204755bc910518d63cacf8.r2.dev/logo-opengraph.gif" width="100%"/>
|
|
141
254
|
</div>
|
|
255
|
+
<br />
|
|
256
|
+
|
|
142
257
|
<div align="center">
|
|
143
258
|
<a href="https://www.patsullivan.org" target="_blank">Website</a> | <a href="https://www.patsullivan.org/contact" target="_blank">Contact</a> | <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> | <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> | <a href="https://github.com/sullivanpj" target="_blank">GitHub</a> | <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
|
|
144
259
|
</div>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/schema",
|
|
3
3
|
"version": 2,
|
|
4
|
-
"title": "Tsup
|
|
4
|
+
"title": "Tsup Builder",
|
|
5
5
|
"description": "Run a build on the project using tsup configuration",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
@@ -129,42 +129,42 @@
|
|
|
129
129
|
"items": {
|
|
130
130
|
"type": "object"
|
|
131
131
|
}
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
"output": {
|
|
149
|
-
"type": "string",
|
|
150
|
-
"description": "Relative path within the output folder."
|
|
151
|
-
},
|
|
152
|
-
"ignore": {
|
|
153
|
-
"description": "An array of globs to ignore.",
|
|
154
|
-
"type": "array",
|
|
155
|
-
"items": {
|
|
156
|
-
"type": "string"
|
|
157
|
-
}
|
|
158
|
-
}
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"required": ["tsConfig", "platform", "banner"],
|
|
135
|
+
"definitions": {
|
|
136
|
+
"assetPattern": {
|
|
137
|
+
"oneOf": [
|
|
138
|
+
{
|
|
139
|
+
"type": "object",
|
|
140
|
+
"properties": {
|
|
141
|
+
"glob": {
|
|
142
|
+
"type": "string",
|
|
143
|
+
"description": "The pattern to match."
|
|
144
|
+
},
|
|
145
|
+
"input": {
|
|
146
|
+
"type": "string",
|
|
147
|
+
"description": "The input directory path in which to apply `glob`. Defaults to the project root."
|
|
159
148
|
},
|
|
160
|
-
"
|
|
161
|
-
|
|
149
|
+
"output": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"description": "Relative path within the output folder."
|
|
152
|
+
},
|
|
153
|
+
"ignore": {
|
|
154
|
+
"description": "An array of globs to ignore.",
|
|
155
|
+
"type": "array",
|
|
156
|
+
"items": {
|
|
157
|
+
"type": "string"
|
|
158
|
+
}
|
|
159
|
+
}
|
|
162
160
|
},
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
161
|
+
"additionalProperties": false,
|
|
162
|
+
"required": ["glob", "input", "output"]
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
"type": "string"
|
|
166
|
+
}
|
|
167
|
+
]
|
|
168
168
|
}
|
|
169
169
|
}
|
|
170
170
|
}
|
|
@@ -77,6 +77,8 @@ This project follows the [all-contributors](https://github.com/all-contributors/
|
|
|
77
77
|
<div align="center">
|
|
78
78
|
<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" altText="Storm Software" />
|
|
79
79
|
</div>
|
|
80
|
+
<br />
|
|
81
|
+
|
|
80
82
|
<div align="center">
|
|
81
83
|
<a href="https://stormsoftware.org" target="_blank">Website</a> | <a href="https://stormsoftware.org/contact" target="_blank">Contact</a> | <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> | <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> | <a href="https://github.com/storm-software" target="_blank">GitHub</a> | <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
|
|
82
84
|
</div>
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/schema",
|
|
3
3
|
"$id": "Preset",
|
|
4
|
-
"title": "
|
|
5
|
-
"description": "Storm workspace
|
|
4
|
+
"title": "Workspace Preset",
|
|
5
|
+
"description": "Create a Storm workspace with all of the required files and recommended packages installed.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"example": [
|
|
8
8
|
{
|
|
9
9
|
"command": "nx g @storm-software/workspace-tools:preset --name 'example-repo'",
|
|
10
|
-
"description": "Generate a storm workspace with
|
|
10
|
+
"description": "Generate a storm workspace with: \n- name: example-repo \n- namespace: storm-software \n- organization: storm-software \n- repositoryUrl: <https://github.com/storm-software/example-repo>"
|
|
11
11
|
},
|
|
12
12
|
|
|
13
13
|
{
|
|
14
14
|
"command": "nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example'",
|
|
15
|
-
"description": "Generate a storm workspace with
|
|
15
|
+
"description": "Generate a storm workspace with: \n- name: example-repo \n- namespace: example \n- repositoryUrl: <https://github.com/storm-software/example-repo>"
|
|
16
16
|
},
|
|
17
17
|
{
|
|
18
18
|
"command": "nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example' --organization 'example-org' --description 'An example workspace'",
|
|
19
|
-
"description": "Generate a storm workspace with
|
|
19
|
+
"description": "Generate a storm workspace with: \n- name: example-repo \n- namespace: example \n- organization: example-org \n- description: An example workspace \n- repositoryUrl: <https://github.com/example-org/example-repo>"
|
|
20
20
|
}
|
|
21
21
|
],
|
|
22
22
|
"properties": {
|
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
},
|
|
70
70
|
"repositoryUrl": {
|
|
71
71
|
"type": "string",
|
|
72
|
-
"description": "The URL of the workspace in GitHub. Defaults to
|
|
72
|
+
"description": "The URL of the workspace in GitHub. Defaults to <https://github.com/{organization}/{name}>",
|
|
73
73
|
"$default": {
|
|
74
74
|
"$source": "argv",
|
|
75
75
|
"index": 5
|