Code Monkey home page Code Monkey logo

babel-plugin-transform-import-css's Introduction

So Alpha. Current version is unstable 1.0.0-alpha with babel@7 and postcss@7 support! Use stable 0.x.x version for babel@6 and postcss@6

Injects class map imported from css-modules into js.

Plugin respects webpack css-modules API and postcss config.

Requirements

  • babel == 7, postcss == 7, node >= 8.
    Note. For babel@6 use previous version of plugin: 0.x.x
  • babel and postcss configs for best results

Installation & configuration

npm add -SD babel-plugin-transform-import-css

.babelrc example:

{
  "sourceMaps": "inline",
  "presets": [
    "@babel/env",
    "react"
  ],
  "plugins": [
    ["transform-import-css", {
      "generateScopedName": "lib-[name]-[local]-[hash:base64:4]"
    }]
  ]
}

Every js file that has a statement such as:

import classes from './Component.css'
// ... some code

will be transpiled to:

var classes = {
    root: 'lib-foo-root-SFs0',
    // ... some classes ...
}
require('load-styles')('.root{color:red}; ...some css...') // puts styles into the head
// ... some code

Api

  • generateScopedName — css-modules scope template. Default: [name]__[local]___[hash:base64:5]
  • configPath — postcss config path. Default: auto detect
  • ext — postcss files' extension. Typical use: ext: '.pcss'. Default: '.css'

Note. Plugin rely on some @babel/ peerDependencies, that are typically included in your project by @babel/core self.

Use Cases

Bundling the css with npm packed library of js/react components. It is good for portability.

TODO

  • babel@7
  • configPath and ext options
  • Compatibility with mini-css-extract-plugin and extract-text-webpack-plugin. babel-plugin-transform-import-css should skip require('load-styles')(css) inserting in that cases.
  • Support postcss configs in package.json
  • More flexible postcss config loader. (asynchronous postcss-load-config lib can't be used due to synchronous nature of the babel).

Alternatives


Sponsored with ❤️ by RocketBank

Russian Fintech startup

babel-plugin-transform-import-css's People

Contributors

a-x- avatar dependabot[bot] avatar kmarple1 avatar pdparchitect avatar pdpwebsecurify avatar sara2009 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

babel-plugin-transform-import-css's Issues

Empty config crash caused by repeated require()

For whatever reason, babel is currently calling this plugin twice in my project (I verified this with console logs). Due to the way Node handles repeated requires, the require() call on my postcss.config.js was returning an empty object on the subsequent call. This in turn causes an error from postcss-load-config, which doesn't handle an empty config object correctly (and it would end up with the wrong options even if it did).

I've already put in a PR that resolves this issue by removing the config from Node's resolve cache before it gets re-required.

Fails for import statement with no name

Thank you for making this very useful babel plugin!

I have verified that version 1.0.0-alpha.11 fails when a import statement for a css file has no explicit name, reporting:

babel-plugin-transform-import-css: ./App.css TypeError: Cannot read property 'name' of undefined

Replicate by placing an import statement like import './App.css' in a javascript file to be processed by transform-import-css.

The offending code is in the classesMapConstAst of index.js due to importNode.local being undefined.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.