From 529758cd01bf52d3deb284d98342753cbe108f26 Mon Sep 17 00:00:00 2001 From: Carrie Price Date: Tue, 25 Oct 2016 21:53:44 -0400 Subject: [PATCH] WIP Docs for 0.3.0 (#256) * adds updated recipes for webpack * starting changelog * more changelog changes * even more changes * add PR for webpack to changelog * removes simple starter-kyt from recommendations * Adding dates --- CHANGELOG.md | 31 +++++++++++++++++++++++++++++-- docs/Recipes.md | 13 +++++++++---- docs/commands.md | 19 +++++++++++-------- 3 files changed, 49 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ca8d6d7ac..25e872f2b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,35 @@ ## Master -## 0.2.2 (Sept 23, 2016) +## 0.3.0 (October 25, 2016) + +### BREAKING CHANGES +- Upgrades Jest to version 16 [#259](https://github.com/NYTimes/kyt/pull/259) + See [Jest docs](http://facebook.github.io/jest/blog/2016/10/03/jest-16.html) for information on latest updates. + +- Upgrades Webpack to v2.1.0-beta.25 [#264](https://github.com/NYTimes/kyt/pull/264) + Check the [recipes](/Recipes.md) to see the latest syntax for common extensions. Additional info in Webpack's [migration guide](https://webpack.js.org/how-to/upgrade-from-webpack-1/) + +### FEATURES + +- Adds serverless option to kyt [#174](https://github.com/NYTimes/kyt/pull/174) + See the new [static starter-kyt](https://github.com/nytimes/kyt-starter-static) + +- Flags can now be passed through to internal tools [#230](https://github.com/NYTimes/kyt/pull/230) + +- Adds multiple server entry handling [#247](https://github.com/NYTimes/kyt/pull/247) + +- Default starter-kyt on setup is now the [universal starter-kyt](https://github.com/NYTimes/kyt-starter-universal) [#265](https://github.com/NYTimes/kyt/pull/265) + +- Assets now use chunkhash [#239](https://github.com/NYTimes/kyt/pull/239) + +- Make logs more readable [#190](https://github.com/NYTimes/kyt/pull/190) + +- Displays Gzip size of assets [#244](https://github.com/NYTimes/kyt/pull/244) + +- Adds end to end tests [#241](https://github.com/NYTimes/kyt/pull/241) + +## 0.2.2 (Sept 30, 2016) - Fixes linter `Configuration for rule "eol-last" is invalid` ESLint bug by upgrading all of the linter dependencies. @@ -37,4 +65,3 @@ kyt adds these linter files to your project on setup. These files now reference ## 0.1.0 (Sept 12, 2016) * Initial public release - diff --git a/docs/Recipes.md b/docs/Recipes.md index 3b417ad25..857264e14 100644 --- a/docs/Recipes.md +++ b/docs/Recipes.md @@ -42,8 +42,13 @@ in `kyt.config.js` ```javascript modifyWebpackConfig: (baseConfig, options) => { - baseConfig.postcss.push( - require('precss')() + baseConfig.plugins.push( + new webpack.LoaderOptionsPlugin({ + options: { + postcss: [require('postcss-cssnext')], + context: '/', + }, + }) ); return baseConfig; @@ -55,8 +60,8 @@ in kyt.config.js ```javascript modifyWebpackConfig: (baseConfig, options) => { - const babelLoader = baseConfig.module.loaders.find(loader => loader.loader === 'babel-loader'); - babelLoader.query.plugins.push(path.resolve('./path/to/my/plugin')); + const babelLoader = baseConfig.module.rules.find(loader => loader.loader === 'babel-loader'); + babelLoader.options.plugins.push(path.resolve('./path/to/my/plugin')); return baseConfig; } diff --git a/docs/commands.md b/docs/commands.md index d4c6d1c3c..09550bd6d 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -36,12 +36,12 @@ If kyt finds any files with duplicate names, it will back up your file before re `setup` also allows you to plug a starter-kyt into your app. -Running `kyt setup` will give you the option to install the default starter-kyt. +Running `kyt setup` will give you the option to install the [default starter-kyt.](https://github.com/NYTimes/kyt-starter-universal) You can also pass the `-r` flag with any starter-kyt git clone URL: ``` - kyt setup -r git@github.com:nytimes/kyt-starter-universal.git + kyt setup -r git@github.com:nytimes/kyt-starter.git ``` `setup` will then: @@ -53,16 +53,19 @@ You can also pass the `-r` flag with any starter-kyt git clone URL: ### Recommended starter-kyts -#### [Default starter-kyt](https://github.com/nytm/wf-kyt-starter) +#### [Universal React starter-kyt](https://github.com/NYTimes/kyt-starter-universal) +This default starter-kyt is a good base for building advanced, universal React apps. -The default starter-kyt is for building simple React apps. -Install by running: `node_modules/.bin/kyt setup` +``` +node_modules/.bin/kyt setup +``` -#### [Universal React starter-kyt](https://github.com/nytm/wf-kyt-starter-universal) -This starter-kyt is a good base for building advanced, universal React apps. +#### [Static starter-kyt](https://github.com/NYTimes/kyt-starter-static) +This starter-kyt is for creating client side React apps. +Install by running: ``` -node_modules/.bin/kyt setup -r git@github.com:nytimes/kyt-starter-universal.git +node_modules/.bin/kyt setup -r git@github.com:nytimes/kyt-starter-static.git ``` #### [Universal Angular2 starter-kyt](https://github.com/delambo/kyt-starter-universal-angular2)