Unmaintained – :construction_worker: The aim of this project is to help you to build your things. From Bootstrap themes over static websites to single page applications.
See all changes since the last release.
Another major release. Here are the breaking changes in a glance:
>= 8.6
)See detailed migration information below.
feat: Auto format code using prettier as pre-commit hook
This commit introduces a new dev dependency which requires Node.JS >= 8.6
We are using prettier to format JavaScript, JSON and SCSS files automatically before you commit your files to Git via a pre-commit hook.
The prettier settings are defined in .prettierrc
in the project root. In case prettier is to opinated for you or you don’t want Prettier to change your files without the chance to review the changes you just have to delete the pre-commit hook with in the package.json
:
"husky": {
"hooks": {
"post-merge": "npm install",
"pre-commit": "lint-staged"
}
}
But we totally recommend you to give this workflow a chance, because it’s just one more thing you don’t have to care about.
feat: Update husky to v1.x.x
You need to update the husky config which can be autmated by running ./node_modules/.bin/husky-upgrade
. See https://github.com/typicode/husky#upgrading-from-014 for details.
feat: Update ESLint, plugins and shared configs to their latest versions
This might break your build since new versions have introduced new rules which might introduce linting errors in your code base.
Tip: Run npm run eslint:fix
to see which errors are autofixable. And remember to turn off rules in eslintConfig
in case you find them too opinionated.
See all changes since the last release.
See all changes since the last release.
Let’s recap the most important changes since the last 2.x.x
release:
npm run build:serve
(ce2cc70)scripts: Change the npm script name fpr serving the dist directory from npm run build:check
to npm run build:serve
The webpack runtime has moved into a separate file. Therefore you need to add a reference to that file into your HTML / Handlebars file(s) before the vendor bundle:
<!-- webpack runtime JS -->
@@runtime.js
<!-- Vendor JS -->
@@vendor.js
<!-- Own JS -->
@@app.js
See https://developers.google.com/web/fundamentals/performance/webpack/use-long-term-caching#webpack_runtime_code for details about the why.
See all changes since the last prerelease.
Below you’ll find the list of all breaking changes since the last 2.x.x
release and what you have to adapt.
build: Gulp and all the tasks are gone. But most of the npm scripts still do what they did before. Here are the main scripts needed for developing and building your project.
Command | Description |
---|---|
npm start |
Builds for development, starts a webserver, watches files for changes, rebuilds incremental and reloads your browser. |
npm test |
Lints your JavaScript files and runs unit test via the Jest CLI. |
npm run test:watch |
Runs unit test with Jests watch option. |
npm run build |
Builds for production to dist directory. |
npm run build:serve |
Starts a static fileserver serving the dist directory. |
npm run build:analyze |
Starts »Webpack Bundle Analyzer« to visualize size of Webpack output files |
See scripts
section in package.json
for all available scripts.
build: The bundled polyfills moved to the vendor bundle, the webpack runtime has moved into a separate file. Plus the references to the bundles have changed. You have to update the references in your HTML / Handlebars file(s):
<!-- Bundled vendor CSS files -->
@@vendor.css
<!-- Our compiled and merged Sass files -->
@@app.css
[…]
<!-- webpack runtime JS -->
@@runtime.js
<!-- Bundled vendor CSS files -->
@@vendor.css
<!-- Our compiled and merged Sass files -->
@@app.css
polyfills: Polyfills are now dynamically imported and lazy loaded to decrease the size of the vendor bundle for modern browsers. See README for details.
eslint: We ’ve added eslint-plugin-unicorn and eslint-plugin-import which might introduce new linting errors. You might want to turn off rules in /.eslintrc.json
in case you find them too opinionated.
baumeister.json: The properties bundleCSS
and includeStaticFiles
in baumeister.json have moved to vendor.bundleCSS
and vendor.includeStaticFiles
. You have to adapt these changes in case you have added dependencies via these properties.
bootstrap: We’ve updated to Bootstrap 4. See Bootstrap v4 migration guide to read about the most notable as well as breaking changes.
See all changes since the last release.
This is the last beta before the final 3.0.0 release 🎉
We are now going to address a few enhancements which might get into the final 3.0.0 release. See #235 for details.
See all changes since the last release.
This is the first beta of the 3.0.0 release 🎉
We have a few enhancements which might get into the final 3.0.0 release. See #235 for details.
build: Gulp and all the tasks are gone. But most of the npm scripts still do what they did before. Here are the main scripts needed for developing and building your project.
Command | Description |
---|---|
npm start |
Builds for development, starts a webserver, watches files for changes, rebuilds incremental and reloads your browser. |
npm test |
Lints your JavaScript files and runs unit test via the Jest CLI. |
npm run test:watch |
Runs unit test with Jests watch option. |
npm run build |
Builds for production to dist directory. |
npm run build:check |
Starts a static fileserver serving the dist directory. |
npm run build:analyze |
Starts »Webpack Bundle Analyzer« to visualize size of Webpack output files |
See scripts
section in package.json
for all available scripts.
build: The bundled polyfills moved to the vendor bundle and the references to the bundles in default.hbs
has changed to:
<!-- Bundled vendor CSS files -->
@@vendor.css
<!-- Our compiled and merged Sass files -->
@@app.css
[…]
<!-- Vendor JS -->
@@vendor.js
<!-- Own JS -->
@@app.js
eslint: This adds eslint-plugin-unicorn and the eslint-plugin-import which might introduce new linting errors. You might want to turn off rules in /.eslintrc.json
in case you find them too opinionated.
baumeister.json: The properties bundleCSS
and includeStaticFiles
in baumeister.json are moved to vendor.bundleCSS
and vendor.includeStaticFiles
. You have to adapt these changes in case you have added dependencies via these properties.
bootstrap: See Bootstrap v4 migration guide to read about the most notable as well as breaking changes.
See all changes since the last release.
See all changes since the last release.