Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

I have some use cases in which I would need the value to be an actual value, not cast to string, to work around this I ended up making my own unist-builder without the String() call.

I don't even understand why we want to force string to it, if it's a value, we can even map it or filter it using the unist-filter and unist-map utilities without having to parse/stringify the value.

Solution

builder shouldn't hard cast to string the value provided, since it limits how we can use the value itself while mixing with other syntax-tree utilities.

Alternatives

• JSON.parse when needed, which isn't much of a good alternative

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions

3.0.0

Link to runnable example

No response

Steps to reproduce

Using jest for running the test throws error for unist-builder version 3.0.0. The same used to work fine for 2.0.3 version,
Error below,
Details:

/Users/lokeshkumar.n/mine/sandbox/doc-framework-monorepo/packages/@salesforcedocs/markdown-compiler/node_modules/unist-builder/index.js:16
export var u = /**
^^^^^^

SyntaxError: Unexpected token 'export'

  3 |
> 4 | import {u} from 'unist-builder';
    | ^

This is the error from Jest,
Jest encountered an unexpected token

This usually means that you are trying to import a file which Jest cannot parse, e.g. it's not plain JavaScript.

By default, if Jest sees a Babel config, it will use that to transform your files, ignoring "node_modules".

Here's what you can do:
 • If you are trying to use ECMAScript Modules, see https://jestjs.io/docs/en/ecmascript-modules for how to enable it.
 • To have some of your "node_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config.
 • If you need a custom transformation specify a "transform" option in your config.
 • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option.

I tried configuring transform option for unist-builder to use babel-jest, but still same problem persists for version 3.0.0

Expected behavior

Tests should be able to use the version 3.0.0

Actual behavior

Throws error while running tests using jest.

Runtime

Node v14

Package manager

yarn v1

OS

macOS

Build and bundle tools

Other (please specify in steps to reproduce)

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

I'm probably doing something cursed, but I'm trying to see if it's able to write unists in JSX. I reproduced the example in the README as:

import { u } from "unist-builder";

const tree = (
  <root>
    <subtree id={1} />
    <subtree id={2}>
      <node>
        <leaf>leaf 1</leaf>
        <leaf>leaf 2</leaf>
      </node>
      <leaf id={3}>leaf 3</leaf>
      <void id={4} />
    </subtree>
  </root>
);

And using u as the JSX factory. Unfortunately, this didn't work, because u only accepts an array of children. In order to make this work, I have to use a single array as children everywhere.

Solution

I propose to make this valid:

var tree = u(
  "root",
  null,
  u("subtree", { id: 1 }),
  u(
    "subtree",
    { id: 2 },
    u("node", null, u("leaf", null, "leaf 1"), u("leaf", null, "leaf 2")),
    u("leaf", { id: 3 }, "leaf 3"),
    u("void", { id: 4 })
  )
);

Because JSX always compiles to type, props, ...children, whenever there are more than three arguments, the rest must all be children, and we can simply collect them into an array.

Alternatives

Do not use JSX for unist? 😄

I'm really curious if I'm able to make it work, though

Build result changed in v1.0.3

code:

u('blockquote', {
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "x"
        }
      ]
    }
  ]
})

v1.0.2:

{"type":"blockquote","children":[{"type":"paragraph","children":[{"type":"text","value":"x"}]}]}

v1.0.3

{"type":"root","children":[{"type":"paragraph","children":[{"type":"text","value":"x"}]}]}

PS: root type is passed from code like this:

u('blockquote', remark().parse('x'))

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

Related to #10. If we think it's cool to write unists as JSX, a natural conclusion is we must support components as well.

Solution

I propose to support this pattern:

const root = u(Comp, { id: 1 }, u("leaf", "leaf 1"), u("leaf", "leaf 2"));

Which will be equivalent to

const root = Comp({ id: 1, children: [u("leaf", "leaf 1"), u("leaf", "leaf 2")] });

We don't necessarily need to support "class components", just the simple idea that you can provide a function which will be called with props and children.

Alternatives

If we are to support JSX—there doesn't seem to be another way.

Subject of the feature

Idea I’m having: this project’s name is very different from hastscript/mdastscript. How about using astscript? (it’s free on npm!)

Problem

Similar projects have different naming schemes.

What do you think?

...or similar.

I was just checking some sizes of libs I’m making and found that object.assign adds about half of the size: object.assign is 7kb, minified; 2.58kb, gzipped.

I known, I know, it’s all not a lot, and I’m nitpicking 😉

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions: unist-builder 3.0.0

Steps to reproduce

1. Imported the package into the project using ES6 and typescript.
2. Imported the u from the package.
3. Received the importing error.

Expected behavior

Should run without any issue, but throws import issues.

Actual behavior

Throwing errors after import.

Errror

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /home/khushal87/Projects/RNE-AutoGen/node_modules/unist-builder/index.js
require() of ES modules is not supported.
require() of /home/khushal87/Projects/RNE-AutoGen/node_modules/unist-builder/index.js from /home/khushal87/Projects/RNE-AutoGen/json-to-markdown/mdast/templates.ts is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename index.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /home/khushal87/Projects/RNE-AutoGen/node_modules/unist-builder/package.json.

Fix

1. Remove type: "module" from package.json.
2. Export u as module.exports = {u};

Note

The above fix works after doing the following changes in the package code under node_modules. So it will be great if this package adapts the new code so that the issue could be resolved.