Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[VRL Playground] Separate JS/resources files from WASM generated files #17827

Closed
pront opened this issue Jun 30, 2023 · 0 comments · Fixed by #17871
Closed

[VRL Playground] Separate JS/resources files from WASM generated files #17827

pront opened this issue Jun 30, 2023 · 0 comments · Fixed by #17871
Labels
type: tech debt A code change that does not add user value. vrl: playground Changes to the VRL Web Playground.

Comments

@pront
Copy link
Contributor

pront commented Jun 30, 2023 •
edited
Loading

In lib/vector-vrl/web-playground/public there is a mix of handwritten and generated files.

Specifically wasm-pack build generates the following files:

README.md
vector_vrl_web_playground.d.ts
vector_vrl_web_playground_bg.wasm
package.json
vector_vrl_web_playground.js
vector_vrl_web_playground_bg.wasm.d.ts

Also, the wasm-pack build --target web --out-dir public command will also generate a .gitignore file that contains a single * so it requires manually editing before committing since we cannot exclude everything.

It would be cleaner to separate the above files and ensure that the build command generates a folder that doesn't need to be committed to the repo.
@pront pront added type: tech debt A code change that does not add user value. vrl: playground Changes to the VRL Web Playground. labels Jun 30, 2023
@pront pront mentioned this issue Jun 30, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Jul 5, 2023
@pront
fix: propagate and display invalid JSON errors in VRL web playground (#…
8519cb1 
…17826)

<!--
**Your PR title must conform to the conventional commit spec!**

  <type>(<scope>)!: <description>

  * `type` = chore, enhancement, feat, fix, docs
  * `!` = OPTIONAL: signals a breaking change
* `scope` = Optional when `type` is "chore" or "docs", available scopes
https://github.com/vectordotdev/vector/blob/master/.github/semantic.yml#L20
  * `description` = short description of the change

Examples:

  * enhancement(file source): Add `sort` option to sort discovered files
  * feat(new source): Initial `statsd` source
  * fix(file source): Fix a bug discovering new files
  * chore(external docs): Clarify `batch_size` option
-->

closes: #17445 

Note that `wasm-pack build` modified some previously generated files.
Created #17827.

Example:

![image](https://github.com/vectordotdev/vector/assets/1138161/4fd0b825-8e1b-4466-9c90-5ab8705ad0e8)
@pront pront mentioned this issue Jul 5, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Jul 5, 2023
@pront
chore: separate hanwritten and generated files in web-playground (#17871
9ec0443 
)

<!--
**Your PR title must conform to the conventional commit spec!**

  <type>(<scope>)!: <description>

  * `type` = chore, enhancement, feat, fix, docs
  * `!` = OPTIONAL: signals a breaking change
* `scope` = Optional when `type` is "chore" or "docs", available scopes
https://github.com/vectordotdev/vector/blob/master/.github/semantic.yml#L20
  * `description` = short description of the change

Examples:

  * enhancement(file source): Add `sort` option to sort discovered files
  * feat(new source): Initial `statsd` source
  * fix(file source): Fix a bug discovering new files
  * chore(external docs): Clarify `batch_size` option
-->
closes: #17827 

I went with the simplest solution since we might do a major overhaul
later. It should be good enough for now.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: tech debt A code change that does not add user value. vrl: playground Changes to the VRL Web Playground.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: separate hanwritten and generated files in web-playground vectordotdev/vector
1 participant
@pront