From 75dfaf1acc80cae01ee4821c0d4fa7428cb6227e Mon Sep 17 00:00:00 2001 From: PlayMa256 Date: Mon, 25 Jun 2018 15:51:18 -0300 Subject: [PATCH 1/2] fix(README): Fix broken links on table of contents --- .all-contributorsrc | 9 +++++++++ README.md | 4 ++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index bfc34ea..d6ab031 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -130,6 +130,15 @@ "contributions": [ "code" ] + }, + { + "login": "PlayMa256", + "name": "Matheus Gonçalves da Silva", + "avatar_url": "https://avatars0.githubusercontent.com/u/831308?v=4", + "profile": "https://github.com/PlayMa256", + "contributions": [ + "doc" + ] } ], "repoType": "github" diff --git a/README.md b/README.md index d866741..3e37ff1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Pre-evaluate code at build-time [![downloads][downloads-badge]][npmtrends] [![MIT License][license-badge]][license] -[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors) +[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors) [![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc] [![Babel Macro][macros-badge]][babel-plugin-macros] @@ -454,7 +454,7 @@ Thanks goes to these people ([emoji key][emojis]): | [
Kent C. Dodds](https://kentcdodds.com)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=kentcdodds "Code") [πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=kentcdodds "Documentation") [πŸš‡](#infra-kentcdodds "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=kentcdodds "Tests") | [
Matt Phillips](http://mattphillips.io)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=mattphillips "Code") [πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=mattphillips "Documentation") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=mattphillips "Tests") | [
Philip Oliver](https://twitter.com/philipodev)
[πŸ›](https://github.com/kentcdodds/babel-plugin-preval/issues?q=author%3Aphilipodev "Bug reports") | [
Sorin Davidoi](https://toot.cafe/@sorin)
[πŸ›](https://github.com/kentcdodds/babel-plugin-preval/issues?q=author%3Asorin-davidoi "Bug reports") [πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=sorin-davidoi "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=sorin-davidoi "Tests") | [
Luke Herrington](https://github.com/infiniteluke)
[πŸ’‘](#example-infiniteluke "Examples") | [
Lufty Wiranda](http://instagram.com/luftywiranda13)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=luftywiranda13 "Code") | [
Oscar](http://obartra.github.io)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=obartra "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=obartra "Tests") | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| [
pro-nasa](https://github.com/pro-nasa)
[πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=pro-nasa "Documentation") | [
Sergey Bekrin](http://bekrin.me)
| [
Mauro Bringolf](https://maurobringolf.ch)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Tests") | [
Joe Lim](https://joelim.me)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=xjlim "Code") | [
Marcin Zielinski](https://github.com/marzelin)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=marzelin "Code") | [
Tommy](http://www.tommyleunen.com)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=tleunen "Code") | +| [
pro-nasa](https://github.com/pro-nasa)
[πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=pro-nasa "Documentation") | [
Sergey Bekrin](http://bekrin.me)
| [
Mauro Bringolf](https://maurobringolf.ch)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Tests") | [
Joe Lim](https://joelim.me)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=xjlim "Code") | [
Marcin Zielinski](https://github.com/marzelin)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=marzelin "Code") | [
Tommy](http://www.tommyleunen.com)
[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=tleunen "Code") | [
Matheus Gonçalves da Silva](https://github.com/PlayMa256)
[πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=PlayMa256 "Documentation") | From 232516aa48de09643f5c88b6e81ea13eb876cf8a Mon Sep 17 00:00:00 2001 From: PlayMa256 Date: Tue, 26 Jun 2018 09:16:10 -0300 Subject: [PATCH 2/2] misc: rephrase titles to fix broken links --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3e37ff1..2272a18 100644 --- a/README.md +++ b/README.md @@ -97,8 +97,8 @@ See more below. - [Limitations](#limitations) - [Code transpilation](#code-transpilation) - [FAQ](#faq) - - [How is this different from [prepack][prepack]?](#how-is-this-different-from-prepackprepack) - - [How is this different from [webpack][webpack] [loaders][webpack-loaders]?](#how-is-this-different-from-webpackwebpack-loaderswebpack-loaders) + - [How is this different from prepack?](#how-is-this-different-from-prepack) + - [How is this different from webpack loaders?](#how-is-this-different-from-webpack-loaders) - [Inspiration](#inspiration) - [Related Projects](#related-projects) - [Other Solutions](#other-solutions) @@ -405,9 +405,9 @@ transpilation. ## FAQ -### How is this different from [prepack][prepack]? +### How is this different from prepack? -`prepack` is intended to be run on your final bundle after you've run your +[`prepack`][prepack] is intended to be run on your final bundle after you've run your webpack/etc magic on it. It does a TON of stuff, but the idea is that your code should work with or without prepack. @@ -415,18 +415,20 @@ should work with or without prepack. otherwise. Doing things like reading something from the file system are not possible in the browser (or with prepack), but `preval` enables you to do this. -### How is this different from [webpack][webpack] [loaders][webpack-loaders]? +### How is this different from webpack loaders? This plugin was inspired by webpack's [val-loader][val-loader]. The benefit of using this over that loader (or any other loader) is that it integrates with your existing babel pipeline. This is especially useful for the server where -you're probably not bundling your code with `webpack`, but you may be using +you're probably not bundling your code with [`webpack`][webpack], but you may be using babel. (If you're not using either, configuring babel for this would be easier than configuring webpack for `val-loader`). In addition, you can implement pretty much any webpack loader using `babel-plugin-preval`. +If you want to learn more, check `webpack` documentations about [`loaders`][webpack-loaders]. + ## Inspiration I needed something like this for the