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.

Sign up for GitHub

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

Jump to bottom

Relative path for template option does not work #211

Closed
varya opened this issue Nov 2, 2016 · 3 comments
Closed

Relative path for template option does not work #211

varya opened this issue Nov 2, 2016 · 3 comments
Labels
bug

Comments

@varya
Copy link
Contributor

varya commented Nov 2, 2016 •
edited by sapegin

In my project, I store styleguide.config.js not in the root but in client-src/webpack folder.

For the components and the assets directories I needed to use relative path. But for the template option, the tool wants me to have a path from the root of the project. It looks very confusing.

This is the content of my config:

const path = require("path");
const glob = require('glob');

const siteWebpack = require("./webpack.config.js");

module.exports = {
  title: 'Awesome styleguide',
  components: '../react/components/**/*.jsx',
  updateWebpackConfig(webpackConfig) {
    siteWebpack.module.loaders.forEach(function(loader) {
      webpackConfig.module.loaders.push(loader);
    });
    webpackConfig.module.noParse = siteWebpack.module.noParse;
    siteWebpack.plugins.forEach(function(plugin) {
       webpackConfig.plugins.push(plugin);
    });
    webpackConfig.postcss = siteWebpack.postcss;

    return webpackConfig;
  },
  assetsDir: '../../assets',
  template: './client-src/webpack/styleguide.template.html'
};
@sapegin
Copy link
Member

sapegin commented Nov 2, 2016

I thinks it’s easy to change ;-) You can try if you have time, or I’ll fix it later.

@sapegin sapegin added the bug label Nov 2, 2016
sapegin added a commit that referenced this issue Dec 6, 2016
@sapegin
Refactor: Config refactoring
a3d143c 
1. Proper schema validation.
2. Get rid of dependencies validation.
3. Also fixes #211.
@sapegin
Copy link
Member

sapegin commented Jan 25, 2017

It should be fixed in the 5.0.0 beta. Could you please try it?

https://github.com/styleguidist/react-styleguidist/releases/tag/5.0.0%40beta.9

@sapegin
Copy link
Member

sapegin commented Feb 17, 2017

Closing this for now. Feel free to reopen if you still have this issue.

@sapegin sapegin closed this as completed Feb 17, 2017
sapegin added a commit that referenced this issue Mar 31, 2017
@sapegin
Changelog: 🚀
32345a0 
[link to medium article]()

## Highlights

1. create-react-app support out of the box.
2. New webpack configuration options + user config auto load.

## Breaking changes

### create-react-app support

Now Styleguidst works with [create-react-app](https://github.com/facebookincubator/create-react-app) even without config.

It will load components from `src/components/**/*.js`. And example files from `Component/Readme.md` or `Component/Component.md`.

### User webpack config auto load

By default Styleguidist will try to find `webpack.config.js` in your project’s root directory and use it.

If your webpack config is located somewhere else, you need to load it manually:

```javascript
module.exports = {
  webpackConfig: require('./configs/webpack.js')
};
```

> **Note:** `entry`, `externals`, `output`, `watch`, `stats` and `devtool` options will be ignored.

> **Note:** `CommonsChunkPlugins`, `HtmlWebpackPlugin`, `UglifyJsPlugin`, `HotModuleReplacementPlugin` plugins will be ignored because Styleguidist already includes them or they may break Styleguidist.

> **Note:** Babelified webpack configs (like `webpack.config.babel.js`) are not supported. We recommend to convert your config to native Node — Node 6 supports [many ES6 features](http://node.green/).

### Easier webpack configuration

With the new [webpackConfig](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#webpackconfig):

```javascript
module.exports = {
  webpackConfig: {
    module: {
      loaders: [
        // Babel loader, will use your project’s .babelrc
        {
          test: /\.jsx?$/,
          exclude: /node_modules/,
          loader: 'babel-loader',
        },
        // Other loaders that is needed for your components
        {
          test: /\.css$/,
          loader: 'style-loader!css-loader?modules',
        },
      ],
    },
  },
};
```

See the new [webpack configuration guide](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Webpack.md) for more examples.

Also:

* `include`/`exclude` options in you webpack loaders are no longer required.
* JSON loader will be added automatically if needed.

### No global Lodash in examples

Lodash will not be available in examples as `_`. You can load function you need with the new [context](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#context) option:

```javascript
module.exports = {
  context: {
    forEach: 'lodash/forEach',
    map: 'lodash/map',
  },
};
```

Or replicate previous behavior though it’s not recommended:

```javascript
module.exports = {
  context: {
    _: 'lodash',
  },
};
```

### Use JSS for styling instead of CSS Modules

Use config option [theme](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#theme) to change fonts, colors, etc. and option [styles](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#styles) to tweak style of particular Styleguidist’s components:

```javascript
module.exports = {
	theme: {
		link: 'firebrick',
		linkHover: 'salmon',
		font: '"Comic Sans MS", "Comic Sans", cursive',
	},
	styles: {
		Logo: {
			logo: {
				animation: 'blink ease-in-out 300ms infinite',
			},
			'@Keyframes blink': {
				to: { opacity: 0 },
			},
		},
	},
};
```

We now use [JSS](http://cssinjs.org/) under the hoood.

### New default config options

* `components`: `src/components/**/*.js`
* `getExampleFilename`: `Component/Readme.md` or `Component/Component.md`
* `title`: `<app name from package.json> Style Guide`

### New default dev-server port

Default port is now 6060 because create-react-app uses 3000 too.

### Use findAllExportedComponentDefinitions as a default resolver

Fixes #260.

### Drop npm2 support

## Other changes and new features

* New config option [require](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#require) to add new webpack entries like polyfills and custom styles
* New config option [ignore](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#ignore) to exclude components from the style guide.
* New config option [showSidebar](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#showsidebar) (#310)
* Ignoring props with `@ignore` JSDoc tag (#353)
* `objectOf` propType support (#347)
* `updateWebpackConfig` option was renamed to `dangerouslyUpdateWebpackConfig` and should be used in very rare cases when `webpackConfig` isn’t enough
* Style guide config validation
* Reduced build size

## Bug fixes

* Path for `template` config option should be relative to style guide config (#211)
* Do not show isolated links on Markdown examples (#251)
* Show function PropType.func’s source in a tooltip (#343)
* Escape and highlight code in Markdown in descriptions (#284)
* Do not change level of Markdown headings (#329)
* Search should work for subsections (#245)
* Better anchors navigation with unique slugs (#318)
* User’s html-loader should not affect Styleguidist (#312)
* Show webpack build errors and warnings
* Exit with error code when build fails
* Show error when no components found on style guide start
* Do not fail when one of the files doesn’t export a component

---

https://github.com/n1313
https://github.com/okonet
https://github.com/kof
sapegin added a commit that referenced this issue Mar 31, 2017
@sapegin
Changelog: 🚀
be6e3f9 
Huge thanks to @n1313, @okonet and @kof for help with this release!

## Highlights

1. create-react-app support out of the box.
2. New webpack configuration options + user config auto load.

## Breaking changes

### create-react-app support

Now Styleguidst works with [create-react-app](https://github.com/facebookincubator/create-react-app) even without config.

It will load components from `src/components/**/*.js`. And example files from `Component/Readme.md` or `Component/Component.md`.

### User webpack config auto load

By default Styleguidist will try to find `webpack.config.js` in your project’s root directory and use it.

If your webpack config is located somewhere else, you need to load it manually:

```javascript
module.exports = {
  webpackConfig: require('./configs/webpack.js')
};
```

> **Note:** `entry`, `externals`, `output`, `watch`, `stats` and `devtool` options will be ignored.

> **Note:** `CommonsChunkPlugins`, `HtmlWebpackPlugin`, `UglifyJsPlugin`, `HotModuleReplacementPlugin` plugins will be ignored because Styleguidist already includes them or they may break Styleguidist.

> **Note:** Babelified webpack configs (like `webpack.config.babel.js`) are not supported. We recommend to convert your config to native Node — Node 6 supports [many ES6 features](http://node.green/).

### Easier webpack configuration

With the new [webpackConfig](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#webpackconfig):

```javascript
module.exports = {
  webpackConfig: {
    module: {
      loaders: [
        // Babel loader, will use your project’s .babelrc
        {
          test: /\.jsx?$/,
          exclude: /node_modules/,
          loader: 'babel-loader',
        },
        // Other loaders that is needed for your components
        {
          test: /\.css$/,
          loader: 'style-loader!css-loader?modules',
        },
      ],
    },
  },
};
```

See the new [webpack configuration guide](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Webpack.md) for more examples.

Also:

* `include`/`exclude` options in you webpack loaders are no longer required.
* JSON loader will be added automatically if needed.

### No global Lodash in examples

Lodash will not be available in examples as `_`. You can load function you need with the new [context](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#context) option:

```javascript
module.exports = {
  context: {
    forEach: 'lodash/forEach',
    map: 'lodash/map',
  },
};
```

Or replicate previous behavior though it’s not recommended:

```javascript
module.exports = {
  context: {
    _: 'lodash',
  },
};
```

### Use JSS for styling instead of CSS Modules

Use config option [theme](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#theme) to change fonts, colors, etc. and option [styles](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#styles) to tweak style of particular Styleguidist’s components:

```javascript
module.exports = {
	theme: {
		link: 'firebrick',
		linkHover: 'salmon',
		font: '"Comic Sans MS", "Comic Sans", cursive',
	},
	styles: {
		Logo: {
			logo: {
				animation: 'blink ease-in-out 300ms infinite',
			},
			'@Keyframes blink': {
				to: { opacity: 0 },
			},
		},
	},
};
```

We now use [JSS](http://cssinjs.org/) under the hoood.

### New default config options

* `components`: `src/components/**/*.js`
* `getExampleFilename`: `Component/Readme.md` or `Component/Component.md`
* `title`: `<app name from package.json> Style Guide`

### New default dev-server port

Default port is now 6060 because create-react-app uses 3000 too.

### Use findAllExportedComponentDefinitions as a default resolver

Fixes #260.

### Drop npm2 support

## Other changes and new features

* New config option [require](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#require) to add new webpack entries like polyfills and custom styles
* New config option [ignore](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#ignore) to exclude components from the style guide.
* New config option [showSidebar](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#showsidebar) (#310)
* Ignoring props with `@ignore` JSDoc tag (#353)
* `objectOf` propType support (#347)
* `updateWebpackConfig` option was renamed to `dangerouslyUpdateWebpackConfig` and should be used in very rare cases when `webpackConfig` isn’t enough
* Style guide config validation
* Reduced build size

## Bug fixes

* Path for `template` config option should be relative to style guide config (#211)
* Do not show isolated links on Markdown examples (#251)
* Show function PropType.func’s source in a tooltip (#343)
* Escape and highlight code in Markdown in descriptions (#284)
* Do not change level of Markdown headings (#329)
* Search should work for subsections (#245)
* Better anchors navigation with unique slugs (#318)
* User’s html-loader should not affect Styleguidist (#312)
* Show webpack build errors and warnings
* Exit with error code when build fails
* Show error when no components found on style guide start
* Do not fail when one of the files doesn’t export a component
sapegin added a commit that referenced this issue Mar 31, 2017
@sapegin
Changelog: 🚀
53a917e 
Huge thanks to @n1313, @okonet and @kof for help with this release!

## Highlights

1. create-react-app support out of the box.
2. New webpack configuration options + user config auto load.

## Breaking changes

### create-react-app support

Now Styleguidst works with [create-react-app](https://github.com/facebookincubator/create-react-app) even without config.

It will load components from `src/components/**/*.js`. And example files from `Component/Readme.md` or `Component/Component.md`.

### User webpack config auto load

By default Styleguidist will try to find `webpack.config.js` in your project’s root directory and use it.

If your webpack config is located somewhere else, you need to load it manually:

```javascript
module.exports = {
  webpackConfig: require('./configs/webpack.js')
};
```

> **Note:** `entry`, `externals`, `output`, `watch`, `stats` and `devtool` options will be ignored.

> **Note:** `CommonsChunkPlugins`, `HtmlWebpackPlugin`, `UglifyJsPlugin`, `HotModuleReplacementPlugin` plugins will be ignored because Styleguidist already includes them or they may break Styleguidist.

> **Note:** Babelified webpack configs (like `webpack.config.babel.js`) are not supported. We recommend to convert your config to native Node — Node 6 supports [many ES6 features](http://node.green/).

### Easier webpack configuration

With the new [webpackConfig](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#webpackconfig):

```javascript
module.exports = {
  webpackConfig: {
    module: {
      loaders: [
        // Babel loader, will use your project’s .babelrc
        {
          test: /\.jsx?$/,
          exclude: /node_modules/,
          loader: 'babel-loader',
        },
        // Other loaders that is needed for your components
        {
          test: /\.css$/,
          loader: 'style-loader!css-loader?modules',
        },
      ],
    },
  },
};
```

See the new [webpack configuration guide](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Webpack.md) for more examples.

Also:

* `include`/`exclude` options in you webpack loaders are no longer required.
* JSON loader will be added automatically if needed.

### No global Lodash in examples

Lodash will not be available in examples as `_`. You can load function you need with the new [context](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#context) option:

```javascript
module.exports = {
  context: {
    forEach: 'lodash/forEach',
    map: 'lodash/map',
  },
};
```

Or replicate previous behavior though it’s not recommended:

```javascript
module.exports = {
  context: {
    _: 'lodash',
  },
};
```

### Use JSS for styling instead of CSS Modules

Use config option [theme](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#theme) to change fonts, colors, etc. and option [styles](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#styles) to tweak style of particular Styleguidist’s components:

```javascript
module.exports = {
	theme: {
		link: 'firebrick',
		linkHover: 'salmon',
		font: '"Comic Sans MS", "Comic Sans", cursive',
	},
	styles: {
		Logo: {
			logo: {
				animation: 'blink ease-in-out 300ms infinite',
			},
			'@Keyframes blink': {
				to: { opacity: 0 },
			},
		},
	},
};
```

We now use [JSS](http://cssinjs.org/) under the hoood.

### New default config options

* `components`: `src/components/**/*.js`
* `getExampleFilename`: `Component/Readme.md` or `Component/Component.md`
* `title`: `<app name from package.json> Style Guide`

### New default dev-server port

Default port is now 6060 because create-react-app uses 3000 too.

### Use findAllExportedComponentDefinitions as a default resolver

Fixes #260.

### Drop npm2 support

## Other changes and new features

* New config option [require](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#require) to add new webpack entries like polyfills and custom styles
* New config option [ignore](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#ignore) to exclude components from the style guide.
* New config option [showSidebar](https://github.com/styleguidist/react-styleguidist/blob/next/docs/Configuration.md#showsidebar) (#310)
* Ignoring props with `@ignore` JSDoc tag (#353)
* `objectOf` propType support (#347)
* `updateWebpackConfig` option was renamed to `dangerouslyUpdateWebpackConfig` and should be used in very rare cases when `webpackConfig` isn’t enough
* Style guide config validation
* Reduced build size

## Bug fixes

* Path for `template` config option should be relative to style guide config (#211)
* Do not show isolated links on Markdown examples (#251)
* Show function PropType.func’s source in a tooltip (#343)
* Escape and highlight code in Markdown in descriptions (#284)
* Do not change level of Markdown headings (#329)
* Search should work for subsections (#245)
* Better anchors navigation with unique slugs (#318)
* User’s html-loader should not affect Styleguidist (#312)
* Show webpack build errors and warnings
* Exit with error code when build fails
* Show error when no components found on style guide start
* Do not fail when one of the files doesn’t export a component
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@varya @sapegin