Add Zig support by MadLittleMods · Pull Request #389 · stkb/Rewrap

MadLittleMods · 2023-11-02T23:54:01Z

Add Zig support, https://ziglang.org/documentation/0.11.0/#Comments

Tests pass and tested the extension in VSCode ✅

Dev notes

Setup

Using Node.js v18.16.0

Install depdencies

$ npm install

Make sure dotnet is installed (see section below for more details)

Testing

$ node .config/do.mjs test

Building

$ node .config/do.mjs package
Core build complete. Running tests:...
Passed: 473; Failed: 0; Errored: 0
Creating VSIX...
 WARNING  Using '*' activation is usually a bad idea as it impacts performance.
VSIX file created at .obj/Rewrap-VSCode.vsix

Install the extension in VSCode (this will just overwrite whatever version of Rewrap you already have installed):

$ code --install-extension .obj/Rewrap-VSCode.vsix
Installing extensions...
(node:310226) [DEP0005] DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.
(Use `code --trace-deprecation ...` to show where the warning was created)
Extension 'Rewrap-VSCode.vsix' was successfully installed.

Other build commands for reference:

$ node .config/do.mjs build
$ node .config/do.mjs build vscode

Installing `dotnet` dependency

Download and install the .NET Core SDK for your platform (tested with .NET 6). For me this looked like the following:

$ cd ~/Downloads/
$ wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
$ chmod +x ./dotnet-install.sh
$ ./dotnet-install.sh
dotnet-install: Attempting to download using aka.ms link https://dotnetcli.azureedge.net/dotnet/Sdk/6.0.415/dotnet-sdk-6.0.415-linux-x64.tar.gz
dotnet-install: Remote file https://dotnetcli.azureedge.net/dotnet/Sdk/6.0.415/dotnet-sdk-6.0.415-linux-x64.tar.gz size is 186298830 bytes.
dotnet-install: Extracting zip from https://dotnetcli.azureedge.net/dotnet/Sdk/6.0.415/dotnet-sdk-6.0.415-linux-x64.tar.gz
dotnet-install: Downloaded file size is 186298830 bytes.
dotnet-install: The remote and local file sizes are equal.
dotnet-install: Installed version is 6.0.415
dotnet-install: Adding to current process PATH: `/home/eric/.dotnet`. Note: This change will be visible only when sourcing script.
dotnet-install: Note that the script does not resolve dependencies during installation.
dotnet-install: To check the list of dependencies, go to https://learn.microsoft.com/dotnet/core/install, select your operating system and check the "Dependencies" section.
dotnet-install: Installation finished successfully.

Update your $PATH environment variable so you can access dotnet from the CLI:
.bashrc

# For .NET dotnet, C# (csharp)
# https://learn.microsoft.com/en-us/dotnet/core/install/linux-scripted-manual#set-environment-variables-system-wide
export DOTNET_ROOT=~/.dotnet
# export MSBuildSDKsPath=$DOTNET_ROOT/sdk/$(${DOTNET_ROOT}/dotnet --version)/Sdks
export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools

Before this change: ```sh $ node .config/do.mjs test Error: ENOENT: no such file or directory, open './docs/specs/readme.md' ``` Tested on Linux (Manjaro, arch-based)

Fix stkb#388

MadLittleMods · 2023-11-02T23:54:55Z

core/Parsing.Documents.fs

+        // Also allow text paragraphs to be wrapped. Though wrapping the whole
+        // file at once will mess it up.


Not sure why adding the Zig entry below causes this error but I was running into this error:

./core/Parsing.Documents.fs(231,9): (232,42) info FSHARP: XML comment is not placed on a valid language element. (code 3520)

MadLittleMods · 2023-11-02T23:56:23Z

core/Tests.fs

 [<EntryPoint>]
 let main argv =
-  let norm (s: String) = s.ToLower().Replace('\\', '/')
+  let norm (s: String) = s.Replace('\\', '/')


This fixes the tests trying to read differing cased files.

Before this change:

$ node .config/do.mjs test Error: ENOENT: no such file or directory, open './docs/specs/readme.md'

The actual file name is docs/specs/README.md

Tested on Linux (Manjaro, arch-based)

See parcel-bundler/parcel#8005

MadLittleMods · 2023-11-03T03:50:37Z

package.json

    "eslint": "^8.9.0",
    "log-update": "^5.0.0",
-    "parcel": "^2.3.2",
+    "parcel": "^2.10.2",


Updated parcel to fix the errors when trying to package things with Node.js 18

See parcel-bundler/parcel#8005

Before this change:

$ node .config/do.mjs package Bundling Core tests with Parcel... @parcel/optimizer-terser: You must provide the URL of lib/mappings.wasm by calling SourceMapConsumer.initialize({ 'lib/mappings.wasm': ... }) before using SourceMapConsumer Error: You must provide the URL of lib/mappings.wasm by calling SourceMapConsumer.initialize({ 'lib/mappings.wasm': ... }) before using SourceMapConsumer at readWasm (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/node_modules/source-map/lib/read-wasm.js:8:13) at wasm (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/node_modules/source-map/lib/wasm.js:25:16) at /home/eric/Documents/github/vscode-rewrap/node_modules/terser/node_modules/source-map/lib/source-map-consumer.js:264:14 at process.processTicksAndRejections (node:internal/process/task_queues:95:5) at async SourceMap (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/dist/bundle.min.js:19362:20) at async minify (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/dist/bundle.min.js:27714:41) at async Object.optimize (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/optimizer-terser/lib/TerserOptimizer.js:131:16) at async PackagerRunner.optimize (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/core/lib/PackagerRunner.js:364:20) at async PackagerRunner.getBundleResult (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/core/lib/PackagerRunner.js:255:15) at async PackagerRunner.getBundleInfo (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/core/lib/PackagerRunner.js:239:9) Error running: npx --silent parcel build core/test --cache-dir .obj/parcel @parcel/optimizer-terser: You must provide the URL of lib/mappings.wasm by calling SourceMapConsumer.initialize({ 'lib/mappings.wasm': ... }) before using SourceMapConsumer Error: You must provide the URL of lib/mappings.wasm by calling SourceMapConsumer.initialize({ 'lib/mappings.wasm': ... }) before using SourceMapConsumer at readWasm (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/node_modules/source-map/lib/read-wasm.js:8:13) at wasm (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/node_modules/source-map/lib/wasm.js:25:16) at /home/eric/Documents/github/vscode-rewrap/node_modules/terser/node_modules/source-map/lib/source-map-consumer.js:264:14 at process.processTicksAndRejections (node:internal/process/task_queues:95:5) at async SourceMap (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/dist/bundle.min.js:19362:20) at async minify (/home/eric/Documents/github/vscode-rewrap/node_modules/terser/dist/bundle.min.js:27714:41) at async Object.optimize (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/optimizer-terser/lib/TerserOptimizer.js:131:16) at async PackagerRunner.optimize (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/core/lib/PackagerRunner.js:364:20) at async PackagerRunner.getBundleResult (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/core/lib/PackagerRunner.js:255:15) at async PackagerRunner.getBundleInfo (/home/eric/Documents/github/vscode-rewrap/node_modules/@parcel/core/lib/PackagerRunner.js:239:9) Packaging & Optimizing... 🚨 Build failed.

I fixed the VSCode Rewrap plugin fixed for Zig in stkb/Rewrap#389

migrated from stkb#389 --------- * Fix tests trying to read differing cased files Before this change: ```sh $ node .config/do.mjs test Error: ENOENT: no such file or directory, open './docs/specs/readme.md' ``` Tested on Linux (Manjaro, arch-based) * Add support for Zig comments Fix stkb#388 * Update `parcel` to fix packaging errors with Node.js 18 See parcel-bundler/parcel#8005 * build: package-lock.json * ci: meaningless change to debug workflow --------- Co-authored-by: Eric Eastwood <contact@ericeastwood.com>

dnut · 2024-12-26T16:53:04Z

Since this repository is dead, I forked rewrap and published it to the vscode marketplace.

I migrated this PR to the new repository and merged it to master. The changes are working for me in Zig. After some more testing, I'll publish this in a pre-release version.

dnut#1

MadLittleMods · 2024-12-26T18:36:46Z

Thanks for the follow-up @dnut 🙂

MadLittleMods added 2 commits November 2, 2023 17:43

Fix tests trying to read differing cased files

2bfb6c2

Before this change: ```sh $ node .config/do.mjs test Error: ENOENT: no such file or directory, open './docs/specs/readme.md' ``` Tested on Linux (Manjaro, arch-based)

Add support for Zig comments

435e4f6

Fix stkb#388

MadLittleMods commented Nov 2, 2023

View reviewed changes

Update parcel to fix packaging errors with Node.js 18

71ba67b

See parcel-bundler/parcel#8005

MadLittleMods commented Nov 3, 2023

View reviewed changes

MadLittleMods added a commit to MadLittleMods/zig-neural-networks that referenced this pull request Nov 3, 2023

Update to Zig doc comments now that we can wrap them

c0e42d2

I fixed the VSCode Rewrap plugin fixed for Zig in stkb/Rewrap#389

dnut mentioned this pull request Dec 18, 2024

Unmaintained? #392

Open

dnut mentioned this pull request Dec 26, 2024

feat: zig language support dnut/Rewrap#1

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Zig support#389

Add Zig support#389
MadLittleMods wants to merge 3 commits intostkb:stablefrom
MadLittleMods:madlittlemods/add-zig-support

MadLittleMods commented Nov 2, 2023 •

edited

Loading

Uh oh!

MadLittleMods Nov 2, 2023

Uh oh!

MadLittleMods Nov 2, 2023

Uh oh!

MadLittleMods Nov 3, 2023

Uh oh!

dnut commented Dec 26, 2024 •

edited

Loading

Uh oh!

MadLittleMods commented Dec 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		// Also allow text paragraphs to be wrapped. Though wrapping the whole
		// file at once will mess it up.

Uh oh!

Conversation

MadLittleMods commented Nov 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dev notes

Setup

Testing

Building

Installing dotnet dependency

Uh oh!

MadLittleMods Nov 2, 2023

Choose a reason for hiding this comment

Uh oh!

MadLittleMods Nov 2, 2023

Choose a reason for hiding this comment

Uh oh!

MadLittleMods Nov 3, 2023

Choose a reason for hiding this comment

Uh oh!

dnut commented Dec 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MadLittleMods commented Dec 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MadLittleMods commented Nov 2, 2023 •

edited

Loading

Installing `dotnet` dependency

dnut commented Dec 26, 2024 •

edited

Loading