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

I don't get just what it is? #4

Closed
morajabi opened this issue Jul 8, 2017 · 7 comments
Closed

I don't get just what it is? #4

morajabi opened this issue Jul 8, 2017 · 7 comments

Comments

@morajabi
Copy link

morajabi commented Jul 8, 2017

Sorry but I didn't know where to ask this. Feel free to close this if you think it's not OK here.

@threepointone
Copy link

read this for understanding the motivation behind this project facebook/create-react-app#2730

@morajabi
Copy link
Author

morajabi commented Jul 8, 2017

but i'm still a bit confused.

@threepointone
Copy link

You'll have to phrase your question differently then, because I don't know what you're asking beyond this.

@suchipi
Copy link
Contributor

suchipi commented Jul 8, 2017

babel-macros defines a standard interface for libraries that want to use compile-time code transformation without requiring the user to add a babel plugin to their build system (other than babel-macros, which is ideally already in place).

For instance, many css-in-js libraries have a css tagged template string function:

const styles = css`
  .red {
    color: red;
  }
`;

The function compiles your css into (for example) an object with generated class names for each of the classes you defined in your css:

console.log(styles); // { red: "1f-d34j8rn43y587t" }

This class name can be generated at runtime (in the browser), but this has some disadvantages:

  • There is cpu usage/time overhead; the client needs to run the code to generate these classes every time the page loads
  • There is code bundle size overhead; the client needs to receive a CSS parser in order to generate these class names, and shipping this makes the amount of js the client needs to parse larger.

To help solve those issues, many css-in-js libraries write their own babel plugin that generates the class names at compile-time instead of runtime:

// Before running through babel:
const styles = css`
  .red {
    color: red;
  }
`;
// After running through babel, with the library-specific plugin:
const styles = { red: "1f-d34j8rn43y587t" };

If the css-in-js library supported babel-macros instead, then they wouldn't need their own babel plugin to compile these out; they could instead rely on babel-macros to do it for them. So if a user already had babel-macros installed and configured with babel, then they wouldn't need to change their babel configuration to get the compile-time benefits of the library. This would be most useful if the boilerplate they were using came with babel-macros out of the box, which is what we're hoping will be true for create-react-app in the future.

Although css-in-js is the most common example, there are lots of other things you could use babel-macros for, like:

  • Compiling GraphQL fragments into object so that the client doesn't need a GraphQL parser
  • Eval-ing out code at compile time that will be baked into the runtime code, for instance to get a list of directories in the filesystem (see preval)

@kentcdodds
Copy link
Owner

Thanks for that! Could you add that to the README? Very useful and helpful explanation 😀

@suchipi
Copy link
Contributor

suchipi commented Jul 8, 2017

Sure 👍

suchipi added a commit to suchipi/babel-macros that referenced this issue Jul 8, 2017
This explanation comes from response to a user question in kentcdodds#4 asking what this was for.
@morajabi
Copy link
Author

Thank you @suchipi and It will surely help others too

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

4 participants