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.

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

How to disable token camelCase in HTML output #188

Open
withinsight opened this issue Sep 30, 2019 · 5 comments
Open

How to disable token camelCase in HTML output #188

withinsight opened this issue Sep 30, 2019 · 5 comments

Comments

@withinsight
Copy link

The default for token names in the html output is camelCase. I should be able to override this by setting up a setup.js file, and defining a custom formatOption.

I currently see this error:

Error: No options? at transform.chain.fold.e (/Users/{un}/{project}/node_modules/theo/lib/index.js:122:32)

Here's my setup.js:

module.exports = theo => {
  let formatOptions = {
    type: 'html',
    options: {
      transformPropName: name => name
    }
  }

  theo.convert(formatOptions).then((result) => {
    console.log(result);
  }).catch((result) => {
    console.log(result);
  });
}

As you can see I'm simply returning the token name, so it should remain unchanged.

I'm using the CLI:

theo src/lib/tokens/tokens.yml --format html --dest src/lib/tokens --setup src/lib/tokens/setup.js

How can I disable the camelCase formatting for our tokens when displayed in HTML output?

@withinsight
Copy link
Author

Any examples of customizing Theo's formatOptions out there?

@withinsight
Copy link
Author

Still no luck here. Anybody?!?

@axyz
Copy link

axyz commented Jan 17, 2020

@withinsight I have the same issue, haven't digged too much into the code, but as far as I can tell it is not possible to pass options to the convert function.

What happen with the setup file is that it gives you the theo object so that you can decorate it before the convert function is called, but you cannot call the convert function yourself there.

I think the only options here would be to either use the full API and write a simple script to call theo.convert yourself or use registerFormat to reimplement the html format in your setup file omitting the camel case part.

But maybe some maintainer may have some more insights here.

@myamolane
Copy link

myamolane commented Apr 8, 2021

@withinsight Hey, this should works, take a try ~
const htmlFormat = require('theo/lib/formats/html'); theo.registerFormat( 'html', (result) => { const newResult = result.set('options', { transformPropName: (propName) => { // convert to whatevery case you want return propName; } }) return htmlFormat(newResult) } )

image

@myamolane
Copy link

Another way, pass the transformPropName through formatOptions
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants