@kubohiroya/turbowarp-text-lines 0.1.0 → 0.2.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/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md CHANGED
@@ -1,8 +1,62 @@
1
- # TurboWarp Text Lines
1
+ # TurboWarp-Text-Lines
2
2
 
3
- A TurboWarp extension for counting, reading, and splitting text by lines.
3
+ Use multiline text in TurboWarp projects. Text Lines adds three blocks that can:
4
4
 
5
- ## Blocks
5
+ - count the lines in some text;
6
+ - return one line by its position; and
7
+ - replace a Scratch list with every line from the text.
8
+
9
+ **User guide:** [English](https://kubohiroya.github.io/turbowarp-text-lines/) · [日本語](https://kubohiroya.github.io/turbowarp-text-lines/ja/)
10
+
11
+ ## Quick start
12
+
13
+ 1. Download [`dist/text-lines.js`](dist/text-lines.js?raw=1).
14
+ 2. In **TurboWarp Desktop**, open **Extensions**, choose **Custom Extension**, and load the downloaded file.
15
+ 3. Enable **Run extension without sandbox** when TurboWarp asks.
16
+
17
+ > [!IMPORTANT]
18
+ > Text Lines needs to run without the sandbox because its command block writes directly to Scratch lists.
19
+
20
+ The ready-to-use JavaScript file is committed to this repository. You do not need Node.js to install the extension.
21
+
22
+ ## See it in action
23
+
24
+ Start with this text:
25
+
26
+ ```text
27
+ Apple
28
+ Banana
29
+ Cherry
30
+ ```
31
+
32
+ Each block uses the same text in a different way:
33
+
34
+ ```mermaid
35
+ flowchart TD
36
+ input["Input text<br/>Apple<br/>Banana<br/>Cherry"]
37
+ input --> count["number of lines in TEXT<br/>returns: 3"]
38
+ input --> line["line 2 of TEXT<br/>returns: Banana"]
39
+ input --> list["put lines of TEXT into list items<br/>list: Apple · Banana · Cherry"]
40
+
41
+ classDef source fill:#ffffff,color:#18212b,stroke:#5b80a5,stroke-width:2px
42
+ classDef extension fill:#5b80a5,color:#ffffff,stroke:#3f658a,stroke-width:2px
43
+ class input source
44
+ class count,line,list extension
45
+ ```
46
+
47
+ The two rounded reporter blocks return a value. The command block changes the selected list immediately.
48
+
49
+ ## Block reference
50
+
51
+ ### Which block should I use?
52
+
53
+ | Goal | Block | Result for the example above |
54
+ |---|---|---|
55
+ | Count all lines | `number of lines in [TEXT]` | `3` |
56
+ | Read one line | `line [LINE] of [TEXT]` with line `2` | `Banana` |
57
+ | Turn the text into list items | `put lines of [TEXT] into list [LIST]` | `Apple`, `Banana`, `Cherry` |
58
+
59
+ The exact block definitions are generated from [`src/block-definitions.json`](src/block-definitions.json):
6
60
 
7
61
  <!-- BEGIN GENERATED BLOCKS -->
8
62
 
@@ -10,16 +64,24 @@ A TurboWarp extension for counting, reading, and splitting text by lines.
10
64
 
11
65
  Returns the number of lines in the supplied text.
12
66
 
67
+ <details>
68
+ <summary>Block metadata</summary>
69
+
13
70
  | Property | Value |
14
71
  |---|---|
15
72
  | Type | Reporter |
16
73
  | Opcode | `lineCount` |
17
74
  | `TEXT` | String, default: `first line\nsecond line` |
18
75
 
76
+ </details>
77
+
19
78
  ### `line [LINE] of [TEXT]`
20
79
 
21
80
  Returns one line using a one-based line number. Invalid line numbers return an empty string.
22
81
 
82
+ <details>
83
+ <summary>Block metadata</summary>
84
+
23
85
  | Property | Value |
24
86
  |---|---|
25
87
  | Type | Reporter |
@@ -27,40 +89,75 @@ Returns one line using a one-based line number. Invalid line numbers return an e
27
89
  | `TEXT` | String, default: `first line\nsecond line` |
28
90
  | `LINE` | Number, default: `1` |
29
91
 
92
+ </details>
93
+
30
94
  ### `put lines of [TEXT] into list [LIST]`
31
95
 
32
96
  Replaces the contents of the named Scratch list with the lines of the supplied text.
33
97
 
98
+ <details>
99
+ <summary>Block metadata</summary>
100
+
34
101
  | Property | Value |
35
102
  |---|---|
36
103
  | Type | Command |
37
104
  | Opcode | `writeLinesToList` |
38
105
  | `TEXT` | String, default: `first line\nsecond line` |
39
- | `LIST` | String, default: `lines` |
106
+ | `LIST` | String, menu: `LIST_MENU` |
107
+
108
+ </details>
40
109
 
41
110
  <!-- END GENERATED BLOCKS -->
42
111
 
43
- Line numbers are one-based. An invalid line number returns an empty string. The list block replaces the contents of the named Scratch list.
112
+ ## Important behavior
113
+
114
+ | Situation | What Text Lines does |
115
+ |---|---|
116
+ | Line numbers | Starts counting at `1`, not `0` |
117
+ | Invalid line number | Returns an empty string |
118
+ | Empty text | Treats it as one empty line |
119
+ | Text ending with a line break | Adds an empty final line |
120
+ | List command | Replaces all existing items in the selected list |
121
+ | Line endings | Accepts LF (`\n`), CRLF (`\r\n`), and CR (`\r`) |
122
+
123
+ > [!WARNING]
124
+ > Copy any list contents you need to keep before running the list command.
44
125
 
45
- The extension accepts LF, CRLF, and CR line endings.
126
+ For illustrated examples and the Japanese version, open the [complete user guide](https://kubohiroya.github.io/turbowarp-text-lines/).
46
127
 
47
128
  ## Development
48
129
 
130
+ Install dependencies with Node.js 22 or later and run every check:
131
+
49
132
  ```bash
50
- npm install
51
- npm run check
133
+ corepack enable
134
+ pnpm install --frozen-lockfile
135
+ pnpm run check
52
136
  ```
53
137
 
54
- Regenerate the block documentation after changing `src/block-definitions.json`:
138
+ Useful commands:
55
139
 
56
- ```bash
57
- npm run docs
58
- ```
140
+ | Command | Purpose |
141
+ |---|---|
142
+ | `pnpm run dev` | Rebuild the extension while files change |
143
+ | `pnpm run test` | Run the test suite once |
144
+ | `pnpm run typecheck` | Check TypeScript types |
145
+ | `pnpm run build` | Build `dist/text-lines.js` |
146
+ | `pnpm run docs` | Regenerate the block reference from the canonical definitions |
147
+
148
+ When extension source changes, rebuild and commit [`dist/text-lines.js`](dist/text-lines.js). When block definitions change, run `pnpm run docs` before committing.
149
+
150
+ ## Release metadata
59
151
 
60
- The build produces `dist/text-lines.js`.
152
+ MPL-2.0 is the forward license source of truth for this repository. The decision is based on the
153
+ repository license history, Vite extension metadata, and generated bundle header. Published package
154
+ versions keep the terms they were distributed with; this repository does not revoke earlier grants
155
+ retroactively.
61
156
 
62
- Because the extension writes directly to Scratch list variables, load it as an unsandboxed custom extension.
157
+ `package.json` is the package metadata source of truth. `repo-policy.json` records the repository
158
+ policy, and `pnpm run check` verifies README, LICENSE, package metadata, generated `dist/`, and npm
159
+ package contents.
63
160
 
64
161
  ## License
65
162
 
66
- MPL-2.0
163
+ SPDX-License-Identifier: MPL-2.0
@@ -0,0 +1,124 @@
1
+ // Name: Text Lines
2
+ // ID: kubohiroyatextlines
3
+ // Description: Count, read, and split text by lines in TurboWarp.
4
+ // By: Hiroya Kubo
5
+ // License: MPL-2.0
6
+
7
+ (function (Scratch) {
8
+ 'use strict';
9
+
10
+ var block_definitions_default = {
11
+ extensionName: "Text Lines",
12
+ blocks: [
13
+ {
14
+ "opcode": "lineCount",
15
+ "blockType": "REPORTER",
16
+ "text": "number of lines in [TEXT]",
17
+ "description": "Returns the number of lines in the supplied text.",
18
+ "arguments": { "TEXT": {
19
+ "type": "STRING",
20
+ "defaultValue": "first line\nsecond line"
21
+ } }
22
+ },
23
+ {
24
+ "opcode": "lineAt",
25
+ "blockType": "REPORTER",
26
+ "text": "line [LINE] of [TEXT]",
27
+ "description": "Returns one line using a one-based line number. Invalid line numbers return an empty string.",
28
+ "arguments": {
29
+ "TEXT": {
30
+ "type": "STRING",
31
+ "defaultValue": "first line\nsecond line"
32
+ },
33
+ "LINE": {
34
+ "type": "NUMBER",
35
+ "defaultValue": 1
36
+ }
37
+ }
38
+ },
39
+ {
40
+ "opcode": "writeLinesToList",
41
+ "blockType": "COMMAND",
42
+ "text": "put lines of [TEXT] into list [LIST]",
43
+ "description": "Replaces the contents of the named Scratch list with the lines of the supplied text.",
44
+ "arguments": {
45
+ "TEXT": {
46
+ "type": "STRING",
47
+ "defaultValue": "first line\nsecond line"
48
+ },
49
+ "LIST": {
50
+ "type": "STRING",
51
+ "menu": "LIST_MENU"
52
+ }
53
+ }
54
+ }
55
+ ]
56
+ };
57
+ //#endregion
58
+ //#region src/extension.ts
59
+ var blockDefinitions = block_definitions_default.blocks;
60
+ var TextLinesExtension = class {
61
+ getInfo() {
62
+ const translate = Scratch.translate;
63
+ return {
64
+ id: "kubohiroyatextlines",
65
+ name: translate(block_definitions_default.extensionName),
66
+ docsURI: "https://kubohiroya.github.io/turbowarp-text-lines/",
67
+ color1: "#5B80A5",
68
+ blocks: blockDefinitions.map((block) => this.toScratchBlock(block)),
69
+ menus: { LIST_MENU: {
70
+ acceptReporters: true,
71
+ items: "getLists"
72
+ } }
73
+ };
74
+ }
75
+ getLists() {
76
+ const stage = Scratch.vm.runtime.getTargetForStage();
77
+ const editingTarget = Scratch.vm.editingTarget;
78
+ const lists = [...stage ? Object.values(stage.variables) : [], ...editingTarget && editingTarget !== stage ? Object.values(editingTarget.variables) : []].filter((variable) => variable.type === "list");
79
+ if (lists.length === 0) return [""];
80
+ return lists.map((list) => ({
81
+ text: list.name,
82
+ value: list.id
83
+ }));
84
+ }
85
+ lineCount(args) {
86
+ return splitLines(Scratch.Cast.toString(args.TEXT)).length;
87
+ }
88
+ lineAt(args) {
89
+ const lines = splitLines(Scratch.Cast.toString(args.TEXT));
90
+ const line = Math.trunc(Scratch.Cast.toNumber(args.LINE));
91
+ if (!Number.isFinite(line) || line < 1 || line > lines.length) return "";
92
+ return lines[line - 1] ?? "";
93
+ }
94
+ writeLinesToList(args, util) {
95
+ const listIdOrName = Scratch.Cast.toString(args.LIST);
96
+ const stage = Scratch.vm.runtime.getTargetForStage();
97
+ const variable = util.target.lookupVariableById(listIdOrName) ?? stage?.lookupVariableById(listIdOrName) ?? util.target.lookupVariableByNameAndType(listIdOrName, "list") ?? stage?.lookupVariableByNameAndType(listIdOrName, "list");
98
+ if (!variable || variable.type !== "list") throw new Error(`List not found: ${listIdOrName}`);
99
+ variable.value = splitLines(Scratch.Cast.toString(args.TEXT));
100
+ variable._monitorUpToDate = false;
101
+ }
102
+ toScratchBlock(block) {
103
+ return {
104
+ opcode: block.opcode,
105
+ blockType: Scratch.BlockType[block.blockType],
106
+ text: Scratch.translate(block.text),
107
+ arguments: Object.fromEntries(Object.entries(block.arguments).map(([name, argument]) => [name, Object.fromEntries(Object.entries({
108
+ type: Scratch.ArgumentType[argument.type],
109
+ defaultValue: argument.defaultValue,
110
+ menu: argument.menu
111
+ }).filter(([, value]) => value !== void 0))]))
112
+ };
113
+ }
114
+ };
115
+ function splitLines(text) {
116
+ return text.split(/\r\n|\n|\r/);
117
+ }
118
+ //#endregion
119
+ //#region src/index.ts
120
+ if (!Scratch.extensions.unsandboxed) throw new Error("Text Lines must run unsandboxed to write to Scratch lists.");
121
+ Scratch.extensions.register(new TextLinesExtension());
122
+ //#endregion
123
+
124
+ })(Scratch);
package/package.json CHANGED
@@ -1,21 +1,55 @@
1
1
  {
2
2
  "name": "@kubohiroya/turbowarp-text-lines",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
+ "description": "Use multiline text in TurboWarp projects with line counting, lookup, and list-writing blocks.",
4
5
  "author": "Hiroya Kubo <hiroya@cuc.ac.jp>",
6
+ "license": "MPL-2.0",
7
+ "homepage": "https://github.com/kubohiroya/turbowarp-text-lines#readme",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/kubohiroya/turbowarp-text-lines.git"
11
+ },
12
+ "bugs": {
13
+ "url": "https://github.com/kubohiroya/turbowarp-text-lines/issues"
14
+ },
15
+ "keywords": [
16
+ "turbowarp",
17
+ "scratch",
18
+ "extension",
19
+ "text",
20
+ "lines",
21
+ "list"
22
+ ],
5
23
  "type": "module",
24
+ "files": [
25
+ "dist/",
26
+ "README.md",
27
+ "LICENSE"
28
+ ],
29
+ "publishConfig": {
30
+ "access": "public",
31
+ "registry": "https://registry.npmjs.org/"
32
+ },
33
+ "engines": {
34
+ "node": ">=22.18.0"
35
+ },
36
+ "devDependencies": {
37
+ "@kubohiroya/vite-plugin-turbowarp-extension": "0.4.0",
38
+ "@types/node": "^22.20.1",
39
+ "typescript": "^5.9.3",
40
+ "vite": "^8.2.2",
41
+ "vitest": "^4.1.10"
42
+ },
6
43
  "scripts": {
7
44
  "dev": "vite build --watch",
8
45
  "typecheck": "tsc --noEmit",
9
46
  "build": "vite build",
10
47
  "test": "vitest run",
11
- "docs": "node scripts/generate-readme.mjs",
48
+ "docs": "node scripts/generate-readme.ts",
12
49
  "docs:check": "pnpm run docs && git diff --exit-code -- README.md",
13
- "check": "pnpm run typecheck && pnpm run test && pnpm run build && pnpm run docs:check"
14
- },
15
- "devDependencies": {
16
- "@kubohiroya/vite-plugin-turbowarp-extension": "0.1.0",
17
- "typescript": "^5.9.3",
18
- "vite": "^7.3.6",
19
- "vitest": "^4.1.10"
50
+ "check:dist": "pnpm run build && git diff --exit-code -- dist",
51
+ "repo:check": "node scripts/check-repo.ts",
52
+ "pack:check": "npm pack --dry-run --ignore-scripts",
53
+ "check": "pnpm run typecheck && pnpm run test && pnpm run build && pnpm run docs:check && pnpm run check:dist && pnpm run repo:check && pnpm run pack:check"
20
54
  }
21
- }
55
+ }
@@ -1,17 +0,0 @@
1
- name: CI
2
-
3
- on:
4
- push:
5
- branches: [main]
6
- pull_request:
7
-
8
- jobs:
9
- check:
10
- runs-on: ubuntu-latest
11
- steps:
12
- - uses: actions/checkout@v4
13
- - uses: actions/setup-node@v4
14
- with:
15
- node-version: 22
16
- - run: npm install
17
- - run: npm run check
@@ -1,4 +0,0 @@
1
- allowBuilds:
2
- esbuild: set this to true or false
3
- minimumReleaseAgeExclude:
4
- - '@kubohiroya/vite-plugin-turbowarp-extension@0.1.0'
@@ -1,57 +0,0 @@
1
- import {readFile, writeFile} from 'node:fs/promises';
2
-
3
- const START = '<!-- BEGIN GENERATED BLOCKS -->';
4
- const END = '<!-- END GENERATED BLOCKS -->';
5
-
6
- const definitions = JSON.parse(
7
- await readFile(new URL('../src/block-definitions.json', import.meta.url), 'utf8')
8
- );
9
- const readmeUrl = new URL('../README.md', import.meta.url);
10
- const readme = await readFile(readmeUrl, 'utf8');
11
-
12
- const generated = definitions.blocks.map(renderBlock).join('\n\n');
13
- const replacement = `${START}\n\n${generated}\n\n${END}`;
14
-
15
- if (!readme.includes(START) || !readme.includes(END)) {
16
- throw new Error('README.md does not contain the generated block markers.');
17
- }
18
-
19
- const next = readme.replace(
20
- new RegExp(`${escapeRegExp(START)}[\\s\\S]*?${escapeRegExp(END)}`),
21
- replacement
22
- );
23
- await writeFile(readmeUrl, next);
24
-
25
- function renderBlock(block) {
26
- const rows = [
27
- ['Type', titleCase(block.blockType)],
28
- ['Opcode', `\`${block.opcode}\``]
29
- ];
30
- for (const [name, argument] of Object.entries(block.arguments ?? {})) {
31
- rows.push([
32
- `\`${name}\``,
33
- `${titleCase(argument.type)}, default: \`${formatDefault(argument.defaultValue)}\``
34
- ]);
35
- }
36
- return [
37
- `### \`${block.text}\``,
38
- '',
39
- block.description,
40
- '',
41
- '| Property | Value |',
42
- '|---|---|',
43
- ...rows.map(([name, value]) => `| ${name} | ${value} |`)
44
- ].join('\n');
45
- }
46
-
47
- function titleCase(value) {
48
- return value.charAt(0) + value.slice(1).toLowerCase();
49
- }
50
-
51
- function formatDefault(value) {
52
- return String(value).replaceAll('\\', '\\\\').replaceAll('\n', '\\n').replaceAll('`', '\\`');
53
- }
54
-
55
- function escapeRegExp(value) {
56
- return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
57
- }
@@ -1,34 +0,0 @@
1
- {
2
- "extensionName": "Text Lines",
3
- "blocks": [
4
- {
5
- "opcode": "lineCount",
6
- "blockType": "REPORTER",
7
- "text": "number of lines in [TEXT]",
8
- "description": "Returns the number of lines in the supplied text.",
9
- "arguments": {
10
- "TEXT": {"type": "STRING", "defaultValue": "first line\nsecond line"}
11
- }
12
- },
13
- {
14
- "opcode": "lineAt",
15
- "blockType": "REPORTER",
16
- "text": "line [LINE] of [TEXT]",
17
- "description": "Returns one line using a one-based line number. Invalid line numbers return an empty string.",
18
- "arguments": {
19
- "TEXT": {"type": "STRING", "defaultValue": "first line\nsecond line"},
20
- "LINE": {"type": "NUMBER", "defaultValue": 1}
21
- }
22
- },
23
- {
24
- "opcode": "writeLinesToList",
25
- "blockType": "COMMAND",
26
- "text": "put lines of [TEXT] into list [LIST]",
27
- "description": "Replaces the contents of the named Scratch list with the lines of the supplied text.",
28
- "arguments": {
29
- "TEXT": {"type": "STRING", "defaultValue": "first line\nsecond line"},
30
- "LIST": {"type": "STRING", "defaultValue": "lines"}
31
- }
32
- }
33
- ]
34
- }
package/src/extension.ts DELETED
@@ -1,72 +0,0 @@
1
- import definitions from './block-definitions.json' with {type: 'json'};
2
-
3
- type BlockTypeName = 'COMMAND' | 'REPORTER';
4
- type ArgumentTypeName = 'STRING' | 'NUMBER';
5
-
6
- interface DefinitionArgument {
7
- type: ArgumentTypeName;
8
- defaultValue: string | number;
9
- }
10
-
11
- interface BlockDefinition {
12
- opcode: string;
13
- blockType: BlockTypeName;
14
- text: string;
15
- description: string;
16
- arguments: Record<string, DefinitionArgument>;
17
- }
18
-
19
- const blockDefinitions = definitions.blocks as readonly BlockDefinition[];
20
-
21
- export class TextLinesExtension {
22
- getInfo() {
23
- const translate = Scratch.translate;
24
- return {
25
- id: 'kubohiroyatextlines',
26
- name: translate(definitions.extensionName),
27
- color1: '#5B80A5',
28
- blocks: blockDefinitions.map((block) => this.toScratchBlock(block))
29
- };
30
- }
31
-
32
- lineCount(args: {TEXT: unknown}): number {
33
- return splitLines(Scratch.Cast.toString(args.TEXT)).length;
34
- }
35
-
36
- lineAt(args: {TEXT: unknown; LINE: unknown}): string {
37
- const lines = splitLines(Scratch.Cast.toString(args.TEXT));
38
- const line = Math.trunc(Scratch.Cast.toNumber(args.LINE));
39
- if (!Number.isFinite(line) || line < 1 || line > lines.length) return '';
40
- return lines[line - 1] ?? '';
41
- }
42
-
43
- writeLinesToList(args: {TEXT: unknown; LIST: unknown}, util: ScratchBlockUtility): void {
44
- const name = Scratch.Cast.toString(args.LIST);
45
- const variable =
46
- util.target.lookupVariableByNameAndType(name, 'list') ??
47
- Scratch.vm.runtime.getTargetForStage().lookupVariableByNameAndType(name, 'list');
48
- if (!variable) throw new Error(`List not found: ${name}`);
49
- variable.value = splitLines(Scratch.Cast.toString(args.TEXT));
50
- }
51
-
52
- private toScratchBlock(block: BlockDefinition): Record<string, unknown> {
53
- return {
54
- opcode: block.opcode,
55
- blockType: Scratch.BlockType[block.blockType],
56
- text: Scratch.translate(block.text),
57
- arguments: Object.fromEntries(
58
- Object.entries(block.arguments).map(([name, argument]) => [
59
- name,
60
- {
61
- type: Scratch.ArgumentType[argument.type],
62
- defaultValue: argument.defaultValue
63
- }
64
- ])
65
- )
66
- };
67
- }
68
- }
69
-
70
- export function splitLines(text: string): string[] {
71
- return text.split(/\r\n|\n|\r/);
72
- }
package/src/globals.d.ts DELETED
@@ -1,16 +0,0 @@
1
- interface ScratchVariable { value: unknown[]; type: string; name: string; }
2
- interface ScratchTarget { lookupVariableByNameAndType(name: string, type: string): ScratchVariable | null; }
3
- interface ScratchBlockUtility { target: ScratchTarget; }
4
- interface ScratchTranslate {
5
- (text: string): string;
6
- (message: {default: string; description?: string}, placeholders?: Record<string, string | number>): string;
7
- }
8
- interface ScratchApi {
9
- extensions: { unsandboxed: boolean; register(extension: unknown): void };
10
- BlockType: Record<'COMMAND' | 'REPORTER', string>;
11
- ArgumentType: Record<'STRING' | 'NUMBER', string>;
12
- Cast: { toString(value: unknown): string; toNumber(value: unknown): number };
13
- translate: ScratchTranslate;
14
- vm: { runtime: { getTargetForStage(): ScratchTarget } };
15
- }
16
- declare const Scratch: ScratchApi;
package/src/index.ts DELETED
@@ -1,7 +0,0 @@
1
- import {TextLinesExtension} from './extension.js';
2
-
3
- if (!Scratch.extensions.unsandboxed) {
4
- throw new Error('Text Lines must run unsandboxed to write to Scratch lists.');
5
- }
6
-
7
- Scratch.extensions.register(new TextLinesExtension());
@@ -1,48 +0,0 @@
1
- import {beforeEach, describe, expect, it, vi} from 'vitest';
2
- import {TextLinesExtension, splitLines} from '../src/extension.js';
3
-
4
- beforeEach(() => {
5
- vi.stubGlobal('Scratch', {
6
- Cast: {
7
- toString: (value: unknown) => String(value ?? ''),
8
- toNumber: (value: unknown) => Number(value)
9
- }
10
- });
11
- });
12
-
13
- describe('splitLines', () => {
14
- it('supports LF, CRLF, and CR', () => {
15
- expect(splitLines('a\nb\r\nc\rd')).toEqual(['a', 'b', 'c', 'd']);
16
- });
17
- });
18
-
19
- describe('TextLinesExtension', () => {
20
- it('counts lines', () => {
21
- const extension = new TextLinesExtension();
22
- expect(extension.lineCount({TEXT: 'a\nb'})).toBe(2);
23
- });
24
-
25
- it('returns a one-based line', () => {
26
- const extension = new TextLinesExtension();
27
- expect(extension.lineAt({TEXT: 'a\nb', LINE: 2})).toBe('b');
28
- expect(extension.lineAt({TEXT: 'a\nb', LINE: 3})).toBe('');
29
- });
30
-
31
- it('replaces a Scratch list with lines', () => {
32
- const extension = new TextLinesExtension();
33
- const list = {name: 'lines', type: 'list', value: [] as unknown[]};
34
- const target = {
35
- lookupVariableByNameAndType: (name: string, type: string) =>
36
- name === 'lines' && type === 'list' ? list : null
37
- };
38
- vi.stubGlobal('Scratch', {
39
- Cast: {
40
- toString: (value: unknown) => String(value ?? ''),
41
- toNumber: (value: unknown) => Number(value)
42
- },
43
- vm: {runtime: {getTargetForStage: () => target}}
44
- });
45
- extension.writeLinesToList({TEXT: 'a\nb', LIST: 'lines'}, {target});
46
- expect(list.value).toEqual(['a', 'b']);
47
- });
48
- });
package/tsconfig.json DELETED
@@ -1,14 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "target": "ES2022",
4
- "module": "NodeNext",
5
- "moduleResolution": "NodeNext",
6
- "resolveJsonModule": true,
7
- "strict": true,
8
- "noUncheckedIndexedAccess": true,
9
- "exactOptionalPropertyTypes": true,
10
- "skipLibCheck": true,
11
- "types": ["vitest/globals"]
12
- },
13
- "include": ["src", "tests", "vite.config.ts"]
14
- }
package/vite.config.ts DELETED
@@ -1,15 +0,0 @@
1
- import {defineConfig} from 'vite';
2
- import {turboWarpExtension} from '@kubohiroya/vite-plugin-turbowarp-extension';
3
-
4
- export default defineConfig({
5
- plugins: [
6
- turboWarpExtension({
7
- id: 'kubohiroyatextlines',
8
- name: 'Text Lines',
9
- description: 'Count, read, and split text by lines in TurboWarp.',
10
- author: 'Hiroya Kubo',
11
- license: 'MPL-2.0',
12
- fileName: 'text-lines.js'
13
- })
14
- ]
15
- });