@eclipse-scout/migrate 23.1.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/LICENSE ADDED
@@ -0,0 +1,277 @@
1
+ Eclipse Public License - v 2.0
2
+
3
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
4
+ PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
5
+ OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
6
+
7
+ 1. DEFINITIONS
8
+
9
+ "Contribution" means:
10
+
11
+ a) in the case of the initial Contributor, the initial content
12
+ Distributed under this Agreement, and
13
+
14
+ b) in the case of each subsequent Contributor:
15
+ i) changes to the Program, and
16
+ ii) additions to the Program;
17
+ where such changes and/or additions to the Program originate from
18
+ and are Distributed by that particular Contributor. A Contribution
19
+ "originates" from a Contributor if it was added to the Program by
20
+ such Contributor itself or anyone acting on such Contributor's behalf.
21
+ Contributions do not include changes or additions to the Program that
22
+ are not Modified Works.
23
+
24
+ "Contributor" means any person or entity that Distributes the Program.
25
+
26
+ "Licensed Patents" mean patent claims licensable by a Contributor which
27
+ are necessarily infringed by the use or sale of its Contribution alone
28
+ or when combined with the Program.
29
+
30
+ "Program" means the Contributions Distributed in accordance with this
31
+ Agreement.
32
+
33
+ "Recipient" means anyone who receives the Program under this Agreement
34
+ or any Secondary License (as applicable), including Contributors.
35
+
36
+ "Derivative Works" shall mean any work, whether in Source Code or other
37
+ form, that is based on (or derived from) the Program and for which the
38
+ editorial revisions, annotations, elaborations, or other modifications
39
+ represent, as a whole, an original work of authorship.
40
+
41
+ "Modified Works" shall mean any work in Source Code or other form that
42
+ results from an addition to, deletion from, or modification of the
43
+ contents of the Program, including, for purposes of clarity any new file
44
+ in Source Code form that contains any contents of the Program. Modified
45
+ Works shall not include works that contain only declarations,
46
+ interfaces, types, classes, structures, or files of the Program solely
47
+ in each case in order to link to, bind by name, or subclass the Program
48
+ or Modified Works thereof.
49
+
50
+ "Distribute" means the acts of a) distributing or b) making available
51
+ in any manner that enables the transfer of a copy.
52
+
53
+ "Source Code" means the form of a Program preferred for making
54
+ modifications, including but not limited to software source code,
55
+ documentation source, and configuration files.
56
+
57
+ "Secondary License" means either the GNU General Public License,
58
+ Version 2.0, or any later versions of that license, including any
59
+ exceptions or additional permissions as identified by the initial
60
+ Contributor.
61
+
62
+ 2. GRANT OF RIGHTS
63
+
64
+ a) Subject to the terms of this Agreement, each Contributor hereby
65
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
66
+ license to reproduce, prepare Derivative Works of, publicly display,
67
+ publicly perform, Distribute and sublicense the Contribution of such
68
+ Contributor, if any, and such Derivative Works.
69
+
70
+ b) Subject to the terms of this Agreement, each Contributor hereby
71
+ grants Recipient a non-exclusive, worldwide, royalty-free patent
72
+ license under Licensed Patents to make, use, sell, offer to sell,
73
+ import and otherwise transfer the Contribution of such Contributor,
74
+ if any, in Source Code or other form. This patent license shall
75
+ apply to the combination of the Contribution and the Program if, at
76
+ the time the Contribution is added by the Contributor, such addition
77
+ of the Contribution causes such combination to be covered by the
78
+ Licensed Patents. The patent license shall not apply to any other
79
+ combinations which include the Contribution. No hardware per se is
80
+ licensed hereunder.
81
+
82
+ c) Recipient understands that although each Contributor grants the
83
+ licenses to its Contributions set forth herein, no assurances are
84
+ provided by any Contributor that the Program does not infringe the
85
+ patent or other intellectual property rights of any other entity.
86
+ Each Contributor disclaims any liability to Recipient for claims
87
+ brought by any other entity based on infringement of intellectual
88
+ property rights or otherwise. As a condition to exercising the
89
+ rights and licenses granted hereunder, each Recipient hereby
90
+ assumes sole responsibility to secure any other intellectual
91
+ property rights needed, if any. For example, if a third party
92
+ patent license is required to allow Recipient to Distribute the
93
+ Program, it is Recipient's responsibility to acquire that license
94
+ before distributing the Program.
95
+
96
+ d) Each Contributor represents that to its knowledge it has
97
+ sufficient copyright rights in its Contribution, if any, to grant
98
+ the copyright license set forth in this Agreement.
99
+
100
+ e) Notwithstanding the terms of any Secondary License, no
101
+ Contributor makes additional grants to any Recipient (other than
102
+ those set forth in this Agreement) as a result of such Recipient's
103
+ receipt of the Program under the terms of a Secondary License
104
+ (if permitted under the terms of Section 3).
105
+
106
+ 3. REQUIREMENTS
107
+
108
+ 3.1 If a Contributor Distributes the Program in any form, then:
109
+
110
+ a) the Program must also be made available as Source Code, in
111
+ accordance with section 3.2, and the Contributor must accompany
112
+ the Program with a statement that the Source Code for the Program
113
+ is available under this Agreement, and informs Recipients how to
114
+ obtain it in a reasonable manner on or through a medium customarily
115
+ used for software exchange; and
116
+
117
+ b) the Contributor may Distribute the Program under a license
118
+ different than this Agreement, provided that such license:
119
+ i) effectively disclaims on behalf of all other Contributors all
120
+ warranties and conditions, express and implied, including
121
+ warranties or conditions of title and non-infringement, and
122
+ implied warranties or conditions of merchantability and fitness
123
+ for a particular purpose;
124
+
125
+ ii) effectively excludes on behalf of all other Contributors all
126
+ liability for damages, including direct, indirect, special,
127
+ incidental and consequential damages, such as lost profits;
128
+
129
+ iii) does not attempt to limit or alter the recipients' rights
130
+ in the Source Code under section 3.2; and
131
+
132
+ iv) requires any subsequent distribution of the Program by any
133
+ party to be under a license that satisfies the requirements
134
+ of this section 3.
135
+
136
+ 3.2 When the Program is Distributed as Source Code:
137
+
138
+ a) it must be made available under this Agreement, or if the
139
+ Program (i) is combined with other material in a separate file or
140
+ files made available under a Secondary License, and (ii) the initial
141
+ Contributor attached to the Source Code the notice described in
142
+ Exhibit A of this Agreement, then the Program may be made available
143
+ under the terms of such Secondary Licenses, and
144
+
145
+ b) a copy of this Agreement must be included with each copy of
146
+ the Program.
147
+
148
+ 3.3 Contributors may not remove or alter any copyright, patent,
149
+ trademark, attribution notices, disclaimers of warranty, or limitations
150
+ of liability ("notices") contained within the Program from any copy of
151
+ the Program which they Distribute, provided that Contributors may add
152
+ their own appropriate notices.
153
+
154
+ 4. COMMERCIAL DISTRIBUTION
155
+
156
+ Commercial distributors of software may accept certain responsibilities
157
+ with respect to end users, business partners and the like. While this
158
+ license is intended to facilitate the commercial use of the Program,
159
+ the Contributor who includes the Program in a commercial product
160
+ offering should do so in a manner which does not create potential
161
+ liability for other Contributors. Therefore, if a Contributor includes
162
+ the Program in a commercial product offering, such Contributor
163
+ ("Commercial Contributor") hereby agrees to defend and indemnify every
164
+ other Contributor ("Indemnified Contributor") against any losses,
165
+ damages and costs (collectively "Losses") arising from claims, lawsuits
166
+ and other legal actions brought by a third party against the Indemnified
167
+ Contributor to the extent caused by the acts or omissions of such
168
+ Commercial Contributor in connection with its distribution of the Program
169
+ in a commercial product offering. The obligations in this section do not
170
+ apply to any claims or Losses relating to any actual or alleged
171
+ intellectual property infringement. In order to qualify, an Indemnified
172
+ Contributor must: a) promptly notify the Commercial Contributor in
173
+ writing of such claim, and b) allow the Commercial Contributor to control,
174
+ and cooperate with the Commercial Contributor in, the defense and any
175
+ related settlement negotiations. The Indemnified Contributor may
176
+ participate in any such claim at its own expense.
177
+
178
+ For example, a Contributor might include the Program in a commercial
179
+ product offering, Product X. That Contributor is then a Commercial
180
+ Contributor. If that Commercial Contributor then makes performance
181
+ claims, or offers warranties related to Product X, those performance
182
+ claims and warranties are such Commercial Contributor's responsibility
183
+ alone. Under this section, the Commercial Contributor would have to
184
+ defend claims against the other Contributors related to those performance
185
+ claims and warranties, and if a court requires any other Contributor to
186
+ pay any damages as a result, the Commercial Contributor must pay
187
+ those damages.
188
+
189
+ 5. NO WARRANTY
190
+
191
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
192
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
193
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
194
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
195
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
196
+ PURPOSE. Each Recipient is solely responsible for determining the
197
+ appropriateness of using and distributing the Program and assumes all
198
+ risks associated with its exercise of rights under this Agreement,
199
+ including but not limited to the risks and costs of program errors,
200
+ compliance with applicable laws, damage to or loss of data, programs
201
+ or equipment, and unavailability or interruption of operations.
202
+
203
+ 6. DISCLAIMER OF LIABILITY
204
+
205
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
206
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
207
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
208
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
209
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
210
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
211
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
212
+ EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
213
+ POSSIBILITY OF SUCH DAMAGES.
214
+
215
+ 7. GENERAL
216
+
217
+ If any provision of this Agreement is invalid or unenforceable under
218
+ applicable law, it shall not affect the validity or enforceability of
219
+ the remainder of the terms of this Agreement, and without further
220
+ action by the parties hereto, such provision shall be reformed to the
221
+ minimum extent necessary to make such provision valid and enforceable.
222
+
223
+ If Recipient institutes patent litigation against any entity
224
+ (including a cross-claim or counterclaim in a lawsuit) alleging that the
225
+ Program itself (excluding combinations of the Program with other software
226
+ or hardware) infringes such Recipient's patent(s), then such Recipient's
227
+ rights granted under Section 2(b) shall terminate as of the date such
228
+ litigation is filed.
229
+
230
+ All Recipient's rights under this Agreement shall terminate if it
231
+ fails to comply with any of the material terms or conditions of this
232
+ Agreement and does not cure such failure in a reasonable period of
233
+ time after becoming aware of such noncompliance. If all Recipient's
234
+ rights under this Agreement terminate, Recipient agrees to cease use
235
+ and distribution of the Program as soon as reasonably practicable.
236
+ However, Recipient's obligations under this Agreement and any licenses
237
+ granted by Recipient relating to the Program shall continue and survive.
238
+
239
+ Everyone is permitted to copy and distribute copies of this Agreement,
240
+ but in order to avoid inconsistency the Agreement is copyrighted and
241
+ may only be modified in the following manner. The Agreement Steward
242
+ reserves the right to publish new versions (including revisions) of
243
+ this Agreement from time to time. No one other than the Agreement
244
+ Steward has the right to modify this Agreement. The Eclipse Foundation
245
+ is the initial Agreement Steward. The Eclipse Foundation may assign the
246
+ responsibility to serve as the Agreement Steward to a suitable separate
247
+ entity. Each new version of the Agreement will be given a distinguishing
248
+ version number. The Program (including Contributions) may always be
249
+ Distributed subject to the version of the Agreement under which it was
250
+ received. In addition, after a new version of the Agreement is published,
251
+ Contributor may elect to Distribute the Program (including its
252
+ Contributions) under the new version.
253
+
254
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
255
+ receives no rights or licenses to the intellectual property of any
256
+ Contributor under this Agreement, whether expressly, by implication,
257
+ estoppel or otherwise. All rights in the Program not expressly granted
258
+ under this Agreement are reserved. Nothing in this Agreement is intended
259
+ to be enforceable by any entity that is not a Contributor or Recipient.
260
+ No third-party beneficiary rights are created under this Agreement.
261
+
262
+ Exhibit A - Form of Secondary Licenses Notice
263
+
264
+ "This Source Code may also be made available under the following
265
+ Secondary Licenses when the conditions for such availability set forth
266
+ in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
267
+ version(s), and exceptions or additional permissions here}."
268
+
269
+ Simply including a copy of this Agreement, including this Exhibit A
270
+ is not sufficient to license the Source Code under Secondary Licenses.
271
+
272
+ If it is not possible or desirable to put the notice in a particular
273
+ file, then You may include the notice in a location (such as a LICENSE
274
+ file in a relevant directory) where a recipient would be likely to
275
+ look for such a notice.
276
+
277
+ You may add additional accurate notices of copyright ownership.
package/README.md ADDED
@@ -0,0 +1,189 @@
1
+ <p align="center">
2
+ <a href="https://www.eclipse.org/scout/" target="_blank" rel="noopener noreferrer"><img src="https://eclipsescout.github.io/assets/img/eclipse-scout-logo.svg"></a>
3
+ </p>
4
+
5
+ <p align="center">
6
+ <a href="https://ci.eclipse.org/scout/view/Scout%20Nightly%20Jobs/job/scout-integration-22.0-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins" src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fview%2FScout%2520Nightly%2520Jobs%2Fjob%2Fscout-integration-22.0-RT-nightly_pipeline%2F"></a>
7
+ <a href="https://ci.eclipse.org/scout/view/Scout%20Nightly%20Jobs/job/scout-integration-22.0-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins tests" src="https://img.shields.io/jenkins/tests?compact_message&jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fview%2FScout%2520Nightly%2520Jobs%2Fjob%2Fscout-integration-22.0-RT-nightly_pipeline%2F"></a>
8
+ <a href="https://www.npmjs.com/package/@eclipse-scout/migrate" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dm/@eclipse-scout/migrate"></a>
9
+ <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank" rel="noopener noreferrer"><img alt="NPM" src="https://img.shields.io/npm/l/@eclipse-scout/migrate"></a>
10
+ <a href="https://www.npmjs.com/package/@eclipse-scout/migrate" target="_blank" rel="noopener noreferrer"><img alt="npm (scoped)" src="https://img.shields.io/npm/v/@eclipse-scout/migrate"></a>
11
+ <a href="https://www.npmjs.com/package/@eclipse-scout/migrate" target="_blank" rel="noopener noreferrer"><img alt="node" src="https://img.shields.io/node/v/@eclipse-scout/migrate"></a>
12
+ <a href="https://www.eclipse.org/scout/" target="_blank" rel="noopener noreferrer"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fwww.eclipse.org%2Fscout%2F"></a>
13
+ </p>
14
+
15
+ # Eclipse Scout - Migrate
16
+
17
+ Migration tool to help migrating the JavaScript/TypeScript code from one Scout release to another.
18
+
19
+ ## Usage
20
+
21
+ To set up the tool, do the following:
22
+
23
+ - Open the `package.json` of your ui module (e.g. `your.project.ui.html`).
24
+ - Add a devDependency to `@eclipse-scout/migrate`.
25
+ - Run `pnpm install` to install the new dependency.
26
+ - Do the required migration as described in the following chapters.
27
+ - When you are finished, remove the added dependency and migration script from you `package.json`.
28
+
29
+ ```json
30
+ {
31
+ "devDependencies": {
32
+ "@eclipse-scout/migrate": "~23.1.0"
33
+ }
34
+ }
35
+ ```
36
+
37
+ ### TSConfig
38
+
39
+ Some migrations require a `tsconfig.json`. You can add it as follows (do it only if stated in the migration description):
40
+
41
+ - Add a devDependency to `@eclipse-scout/tsconfig`.
42
+ - Run `pnpm install` to install the new dependency.
43
+ - Create a `tsconfig.json` beside your `package.json` according to the `Readme.md` of the `@eclipse-scout/tsconfig` module.
44
+
45
+ ```json
46
+ {
47
+ "devDependencies": {
48
+ "@eclipse-scout/tsconfig": "~23.1.0"
49
+ }
50
+ }
51
+ ```
52
+
53
+ ### Module Map
54
+
55
+ The module map is used by certain migration tasks to automatically add imports.
56
+ If a migration task requires a module map, do the following:
57
+
58
+ - Adjust the `moduleMap` argument by replacing `yourNamespace` with the namespace in your `index.js` file.
59
+ The moduleMap entry is used to add imports to your `index.js` automatically. If you omit it, you need to add the imports manually.
60
+ - If you have dependencies to other Scout based modules, you add them to the `moduleMap` to have the imports to these modules created automatically.
61
+ Add the namespace of the other module and the name of the npm package as follows: `--moduleMap.otherNamespace @other/npm-module`
62
+
63
+ ## ObjectType and MenuType Migration
64
+
65
+ In order to migrate string literals to class references and menu type constants, do the following:
66
+
67
+ - Add a script in your `package.json` as described below.
68
+ - Adjust the module map as described in the chapter [Module Map](#module-map)
69
+ - Run the `migrate` script by pressing the play button next to it in IntelliJ or using the command line: `npm run migrate`
70
+ - Review the changes and add the missing imports, if there are any.
71
+
72
+ ```json
73
+ {
74
+ "scripts": {
75
+ "migrate": "scout-migrate --migrate objectType menuTypes --sources src/main/js/**/*.js --moduleMap.yourNamespace path:src/main/js/index.js"
76
+ }
77
+ }
78
+ ```
79
+
80
+ ## Widget and Column Map Migration
81
+
82
+ In order to create widget and column maps, do the following:
83
+
84
+ - Create a `tsconfig.json` as described [here](#tsconfig)
85
+ - Add a rename and a migrate script in your `package.json` as described below.
86
+ - Run the `rename` script by pressing the play button next to it in IntelliJ or using the command line: `npm run rename`.
87
+ Commit the changes to ensure Git can track the renames correctly.
88
+ - Run the `migrate` script.
89
+ - Review and commit the changes.
90
+
91
+ ```json
92
+ {
93
+ "scripts": {
94
+ "rename": "scout-migrate --rename --sources src/main/js/**/*Model.js",
95
+ "migrate": "scout-migrate --migrate widgetColumnMap --sources src/main/js/**/*Model.ts"
96
+ }
97
+ }
98
+ ```
99
+
100
+ ## Migrate to TypeScript
101
+
102
+ If you plan to migrate your Scout JS code base to TypeScript, use the migration tool for the initial migration.
103
+ From there, you need to add the missing types, fix errors and clean up your code.
104
+
105
+ **Important**: if you have dependencies to other Scout based modules, make sure these modules are migrated to TypeScript first.
106
+ We don't recommend migrating to TypeScript unless all dependencies are migrated.
107
+
108
+ The automatic migration includes:
109
+
110
+ - Renaming the files to `*.ts`.
111
+ - Declaring class properties
112
+ - Declaring method parameters and return types based on JsDoc and naming conventions
113
+ - Removing types from JsDoc
114
+ - Adding imports for the types based on module maps
115
+ - Adding method accessors
116
+
117
+ In order to run the TypeScript migration, do the following:
118
+
119
+ - Ensure you have a clean Git working tree (no uncommitted files).
120
+ - Create a `tsconfig.json` as described [here](#tsconfig)
121
+ - Add scripts in your `package.json` as described below.
122
+ - Adjust the module map as described in the chapter [Module Map](#module-map)
123
+ - Add custom type maps if you have a large code base and would like to automate a little more, see [Type Map](#type-map)
124
+ - Run the `rename` script by pressing the play button next to it in IntelliJ or using the command line: `npm run rename`.
125
+ Commit the changes to ensure Git can track the renames correctly.
126
+ - Run the `migrate` script.
127
+ - Review every file:
128
+ - Verify / add the types of the class properties.
129
+ - Verify / add the types of the method parameters and return values.
130
+ - If you have custom widgets, you should create a `Model` and an `EventMap` for each widget.
131
+ Please use existing widgets as template, e.g. `Menu.ts`, `MenuModel.ts`, `MenuEventMap.ts`.
132
+ - The model needs to be extracted manually.
133
+ Copy the relevant class properties to a separate model file.
134
+ In your widget, implement the model interface and declare a model variable.
135
+ - To create the event maps, you can run the `event-maps` script from below and copy the result into a separate event maps file.
136
+
137
+ ```json
138
+ {
139
+ "scripts": {
140
+ "rename": "scout-migrate --rename --sources src/main/js/**/*.js",
141
+ "migrate": "scout-migrate --rename false --migrate ts --sources src/main/js/**/*.ts --moduleMap.yourNamespace path:src/main/js/index.ts",
142
+ "event-maps": "scout-migrate --print-event-maps --sources src/main/js/**/*.ts"
143
+ }
144
+ }
145
+ ```
146
+
147
+ ### Type Map
148
+
149
+ Type maps are used to add types automatically based on naming rules.
150
+ Scout provides many rules out of the box that should detect many types.
151
+ If you have a large code base with custom types, you can add custom type maps.
152
+
153
+ To do so, create a config file ending with `.mjs`, e.g. `migrate-config.mjs` and configure your type maps like in the following example:
154
+
155
+ ```js
156
+ // The key has no special meaning
157
+ // The `name` is the name of the member variable or method parameter.
158
+ // If the predicate returns true, the type is used.
159
+ // The namespace in the type is used to create the import. To make it work, the module map has to contain an entry for that namespace.
160
+ // Example: doSomething(opts) -> doSomething(opts: Options)
161
+ const typeMap = {
162
+ Options: {
163
+ predicate: name => name === 'opts',
164
+ type: 'yourNamespace.Options'
165
+ }
166
+ };
167
+
168
+ // Compared to the typeMap above, the returnTypeMap is only used to determine the return types of functions.
169
+ // The 'name' parameter is the method name
170
+ // Example: createOptions() -> createOptions(): Options
171
+ const returnTypeMap = {
172
+ Options: {
173
+ predicate: name => name === 'createOptions',
174
+ type: 'yourNamespace.Options'
175
+ }
176
+ };
177
+
178
+ // Necessary if the imports should be created automatically.
179
+ const moduleMap = {
180
+ yourNamespace: '@your-module/core'
181
+ };
182
+
183
+ export {typeMap, returnTypeMap, moduleMap};
184
+ ```
185
+
186
+ You can add as many mappings as you like, or none at all, they are completely optional.
187
+
188
+ **Note**: you can either define the module map in the config file or pass it ass arguments to the script.
189
+ If you do both, they will be merged. If they contain the same keys, the value passed via argument wins.
@@ -0,0 +1,166 @@
1
+ #!/usr/bin/env node
2
+
3
+ import {createRequire} from 'module';
4
+ import path from 'path';
5
+ import fs from 'fs';
6
+ import typescript from 'typescript';
7
+ import {eslintFixPlugin, jsDocPlugin} from 'ts-migrate-plugins';
8
+ import {migrate, MigrateConfig} from 'ts-migrate-server';
9
+ import renameModule from 'ts-migrate/build/commands/rename.js';
10
+ import parser from 'yargs-parser';
11
+ import convertToCRLFPlugin from '../src/convertToCRLFPlugin.js';
12
+ import memberAccessModifierPlugin from '../src/memberAccessModifierPlugin.js';
13
+ import convertToLFPlugin from '../src/convertToLFPlugin.js';
14
+ import declareMissingClassPropertiesPlugin from '../src/declareMissingClassPropertiesPlugin.js';
15
+ import methodsPlugin from '../src/methodsPlugin.js';
16
+ import countMethodsPlugin from '../src/countMethodsPlugin.js';
17
+ import printEventMapsPlugin from '../src/printEventMapsPlugin.js';
18
+ import typedObjectTypePlugin from '../src/typedObjectTypePlugin.js';
19
+ import widgetColumnMapPlugin from '../src/widgetColumnMapPlugin.js';
20
+ import menuTypesPlugin from '../src/menuTypesPlugin.js';
21
+
22
+ const rename = renameModule.default; // Default imports don't work as expected when importing from cjs modules
23
+
24
+ const yargsOptions = {
25
+ boolean: ['count', 'rename', 'printEventMaps'],
26
+ array: ['sources', 'migrate'],
27
+ string: ['moduleMap', 'jsDocTypeMap', 'paramTypeMap', 'returnTypeMap', 'menuTypesMap', 'config'],
28
+ default: {'migrate': [], 'rename': null, 'jsDocTypeMap': {}, 'count': false, 'printEventMaps': false},
29
+ choices: ['migrate', ['ts', 'objectType', 'widgetColumnMap', 'menuTypes']]
30
+ };
31
+ const args = parser(process.argv, yargsOptions);
32
+
33
+ let sources = args.sources;
34
+ if (sources) {
35
+ console.log('Processing sources: ' + sources);
36
+ } else if (!tsConfigContainsSources()) {
37
+ console.warn('Please set sources argument or provide a tsconfig.json specifying the sources.');
38
+ process.exit();
39
+ }
40
+
41
+ const rootDir = path.resolve(process.cwd());
42
+ let renameToTs = args.rename;
43
+ if (args.rename === null) {
44
+ // Rename if migrate to ts is enabled and renaming not explicitly disabled
45
+ renameToTs = args.migrate.includes('ts');
46
+ }
47
+ if (renameToTs) {
48
+ rename({rootDir, sources});
49
+ }
50
+ if (!args.migrate.length && !args.count && !args.printEventMaps) {
51
+ process.exit();
52
+ }
53
+
54
+ let config = await readConfig();
55
+ let moduleMap = Object.assign({}, config.moduleMap, args.moduleMap);
56
+ if (moduleMap) {
57
+ for (let [key, value] of Object.entries(moduleMap)) {
58
+ if (Array.isArray(value)) {
59
+ moduleMap[key] = value[value.length - 1]; // If same namespace was passed multiple times, use the last provided
60
+ }
61
+ }
62
+ console.log('Using moduleMap: ' + JSON.stringify(moduleMap));
63
+ }
64
+
65
+ let menuTypesMap = Object.assign({}, config.menuTypesMap, args.menuTypesMap);
66
+ if (menuTypesMap) {
67
+ console.log('Using menuTypesMap: ' + JSON.stringify(menuTypesMap));
68
+ }
69
+
70
+ let tsConfigDir;
71
+ if (!fs.existsSync('./tsconfig.json')) {
72
+ // https://errorsandanswers.com/do-require-resolve-for-es-modules/
73
+ const require = createRequire(import.meta.url);
74
+ tsConfigDir = require.resolve('@eclipse-scout/tsconfig').replace('tsconfig.json', '');
75
+ }
76
+
77
+ const migrateConfig = new MigrateConfig();
78
+ if (args.migrate.length > 0) {
79
+ console.log('Preparing migrations ' + args.migrate);
80
+ migrateConfig.addPlugin(convertToCRLFPlugin, {});
81
+ if (args.migrate.includes('objectType')) {
82
+ migrateConfig.addPlugin(typedObjectTypePlugin, {moduleMap});
83
+ }
84
+ if (args.migrate.includes('menuTypes')) {
85
+ migrateConfig.addPlugin(menuTypesPlugin, {menuTypesMap, moduleMap});
86
+ }
87
+ if (args.migrate.includes('widgetColumnMap')) {
88
+ migrateConfig.addPlugin(widgetColumnMapPlugin, {});
89
+ }
90
+ if (args.migrate.includes('ts')) {
91
+ await configTypeScript();
92
+ }
93
+ migrateConfig.addPlugin(convertToLFPlugin, {});
94
+ migrateConfig.addPlugin(eslintFixPlugin, {});
95
+ }
96
+ if (args.count) {
97
+ migrateConfig.addPlugin(countMethodsPlugin, {});
98
+ }
99
+ if (args.printEventMaps) {
100
+ migrateConfig.addPlugin(printEventMapsPlugin, {});
101
+ }
102
+ if (migrateConfig.plugins.length === 0) {
103
+ console.warn('No tasks executed, please consult README.md');
104
+ } else {
105
+ migrate({rootDir, tsConfigDir, config: migrateConfig, sources}).then(exitCode => process.exit(exitCode));
106
+ }
107
+
108
+ function configTypeScript() {
109
+ // Only consider .ts files for migration, no .less or .js files
110
+ if (sources) {
111
+ sources = sources.map(source => {
112
+ source = source.replace(/(.js)$/, '.ts');
113
+ if (!source.endsWith('.ts')) {
114
+ source += '.ts';
115
+ }
116
+ return source;
117
+ });
118
+ }
119
+
120
+ const jsDocTypeMap = Object.assign({
121
+ function: {
122
+ tsName: 'Function',
123
+ acceptsTypeParameters: false
124
+ },
125
+ $: {
126
+ tsName: 'JQuery',
127
+ acceptsTypeParameters: false
128
+ }
129
+ }, config.jsDocTypeMap);
130
+ let typeMap = config.typeMap;
131
+ let paramTypeMap = config.paramTypeMap || typeMap;
132
+ let returnTypeMap = config.returnTypeMap;
133
+ migrateConfig
134
+ .addPlugin(jsDocPlugin, {typeMap: jsDocTypeMap, annotateReturns: true})
135
+ .addPlugin(declareMissingClassPropertiesPlugin, {moduleMap, typeMap})
136
+ .addPlugin(memberAccessModifierPlugin, {})
137
+ .addPlugin(methodsPlugin, {moduleMap, paramTypeMap, returnTypeMap});
138
+ }
139
+
140
+ function parseTsConfig(path) {
141
+ const content = typescript.sys.readFile(path);
142
+ const {config, error} = typescript.parseConfigFileTextToJson(path, content);
143
+ if (error) {
144
+ const errorMessage = typescript.flattenDiagnosticMessageText(error.messageText, typescript.default.sys.newLine);
145
+ throw new Error(`Parsing TypeScript config failed: ${path}\n${errorMessage}`);
146
+ }
147
+ return config;
148
+ }
149
+
150
+ function tsConfigContainsSources() {
151
+ if (!fs.existsSync('./tsconfig.json')) {
152
+ return false;
153
+ }
154
+ let config = parseTsConfig('./tsconfig.json');
155
+ return config.include || config.files;
156
+ }
157
+
158
+ async function readConfig() {
159
+ let config;
160
+ if (args.config) {
161
+ config = 'file://' + path.resolve(args.config);
162
+ console.log('Using config from file ' + config);
163
+ return import(config);
164
+ }
165
+ return {};
166
+ }
package/package.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "name": "@eclipse-scout/migrate",
3
+ "version": "23.1.1",
4
+ "description": "TypeScript migration module",
5
+ "author": "BSI Business Systems Integration AG",
6
+ "homepage": "https://www.eclipse.org/scout",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/eclipse-scout/scout.rt.git"
10
+ },
11
+ "license": "EPL-2.0",
12
+ "engines": {
13
+ "node": ">=18.12.1",
14
+ "npm": ">=9.1.1",
15
+ "pnpm": ">=7.16.0"
16
+ },
17
+ "keywords": [
18
+ "scout",
19
+ "eclipse-scout",
20
+ "migrate",
21
+ "typescript"
22
+ ],
23
+ "files": [
24
+ "bin",
25
+ "src"
26
+ ],
27
+ "type": "module",
28
+ "bin": {
29
+ "scout-migrate": "bin/scout-migrate.js"
30
+ },
31
+ "dependencies": {
32
+ "ts-migrate": "0.1.35",
33
+ "ts-migrate-plugins": "0.1.35",
34
+ "ts-migrate-server": "0.1.33",
35
+ "yargs-parser": "21.1.1",
36
+ "jscodeshift": "0.14.0",
37
+ "typescript": "4.9.3"
38
+ },
39
+ "devDependencies": {
40
+ "@types/jscodeshift": "^0.11.5",
41
+ "@types/yargs": "^17.0.13",
42
+ "jest": "29.3.1",
43
+ "@babel/preset-env": "7.20.2",
44
+ "@babel/core": "7.20.5",
45
+ "@eclipse-scout/tsconfig": "23.1.1"
46
+ },
47
+ "scripts": {
48
+ "scout-migrate": "node bin/scout-migrate",
49
+ "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest-config.json"
50
+ }
51
+ }