"name" is a reserved property.

While trying to add a “meta” property parallel to value named name I was greeted to the full name of the token and not the value I placed there.

e.g.

{
    "a": {
        "b": {
            "c": {
                "value": "1",
                "name": "ds"
            }
        }
    },
    "d": {
        "e": {
            "f": {
                "value": "{a.b.c.name}"
            }
        }
    }
}

tokens:

    "a-b-c": "1",
    "d-e-f": "a-b-c"
}

My use case:

declaration

const path = require("path");
module.exports = {
    asset: {
        font: {
            "primary": {
                value: path.resolve(
                    __dirname,
                    "path/to/font"
                ),
                name: "Font-name",
                "content-type": "application/x-font-woff",
                charset: "utf-8",
                format: "woff"
            }
        }
    }
};

referencing

module.exports = {
    font: {
        family: {
            primary: { value: '{asset.font.primary.name}, sans-serif' }
        }
    }
}

replacing namewith something else works.

[didoo]

@rjoaopereira my suggestion is not to mess too much with the expected format of the properties, but t confine all the meta-informations in just a few custom and very controlled fields.

For example, I would avoid this:

{
  "asset": {
    "font": {
      "primary": {
        "value": "123",
        "name": "Roboto",
        "content-type": "application/x-font-woff",
        "charset": "utf-8",
        "format": "woff",
        "deprecated": true,
        "documentation": "Blah blah blah"
      }

in favour of this:

{
  "asset": {
    "font": {
      "primary": {
        "value": "123",
        "meta": {
          "name": "Roboto",
          "content-type": "application/x-font-woff",
          "charset": "utf-8",
          "format": "woff",
        },
        "documentation": {
          "deprecated": true,
          "comment": "Blah blah blah"
        }

The risk of conflict with reserved words and future extensions of the default attributes attached to a property is reduced, and also makes everything semantically more organised.

My 2 cents 😃

[rjoaopereira]

in general terms, we never mutate the actual values of value and name, and instead create new keys on the object with Symbol('name') and Symbol('value') and then reference those in the formats?

That would be the idea.

So if you supply a name, it will also always be in original

It’s good to know but I prefer to use another key. You never know when the inner workings will change.

I guess using Symbols would negate the need for that.

I believe so.