Skip to content

Commit

Permalink
chore: fmt & regen root readme
Browse files Browse the repository at this point in the history
Signed-off-by: Charlike Mike Reagent <opensource@tunnckocore.com>
  • Loading branch information
tunnckoCore committed Mar 26, 2020
1 parent d8c24c4 commit eda3da1
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 43 deletions.
4 changes: 2 additions & 2 deletions .github/auto-comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ issuesOpened: >
Thank you for raising this issue! We will try and get back to you as soon as possible.
Please make sure you format it properly, followed our [code of conduct](https://github.com/tunnckoCore/.github/blob/master/CODE_OF_CONDUCT.md), and have given us as much context as possible.
Hey @tunnckoCore, check out this one too! ;)
pullRequestOpened: >
Thank you for raising your pull request.
Please make sure again that you have followed our [contributing guidelines](https://github.com/tunnckoCore/.github/blob/master/CONTRIBUTING.md) and the [code of conduct](https://github.com/tunnckoCore/.github/blob/master/CODE_OF_CONDUCT.md).
We will review it as soon as possible.
Hey @tunnckoCore, check out this one too! ;)
2 changes: 1 addition & 1 deletion .github/workflows/label-sponsors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
types: [opened]
issues:
types: [opened]

jobs:
build:
name: is-sponsor-label
Expand Down
54 changes: 29 additions & 25 deletions @packages/babel-preset-optimise/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


# babel-preset-optimise [![npm version][npmv-img]][npmv-url] [![License][license-img]][license-url] [![Libera Manifesto][libera-manifesto-img]][libera-manifesto-url]

> Babel preset with optimizations in mind, modern output
Expand Down Expand Up @@ -64,21 +62,21 @@ from [GitHub Actions](https://github.com/features/actions) with
- [Usage](#usage)
- [What it includes?](#what-it-includes)
- [API](#api)
* [babelPresetOptimize](#babelpresetoptimize)
+ [Signature](#signature)
+ [Params](#params)
- [babelPresetOptimize](#babelpresetoptimize)
- [Signature](#signature)
- [Params](#params)
- [Contributing](#contributing)
* [Guides and Community](#guides-and-community)
* [Support the project](#support-the-project)
- [Guides and Community](#guides-and-community)
- [Support the project](#support-the-project)
- [Contributors](#contributors)
- [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
_(TOC generated by [verb](https://github.com/verbose/verb) using
[markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Install

This project requires [**Node.js**](https://nodejs.org) **>=10.13**
_(see
This project requires [**Node.js**](https://nodejs.org) **>=10.13** _(see
[Support & Release Policy](https://github.com/tunnckoCoreLabs/support-release-policy))_.
Install it using [**yarn**](https://yarnpkg.com) or
[**npm**](https://npmjs.com).<br> _We highly recommend to use Yarn when you
Expand Down Expand Up @@ -120,10 +118,10 @@ _Generated using [jest-runner-docs](https://ghub.now.sh/jest-runner-docs)._
Be aware that when you use `minifyBuiltins: true` you _MAY_ get a bigger output,
but that's not always guaranteed, just try for your case.

If you want to use JSX (React) pass `options.jsx: true`.
If you want to use JSX (React) + TypeScript pass both `{ jsx: true, typescript: true }`.
If you wan to use Preact + TypeScript, `{ jsx: { pragma: 'h' }, typescript: true }`,
if `options.jsx` is an object, it is directly passed to `preset-react`.
If you want to use JSX (React) pass `options.jsx: true`. If you want to use JSX
(React) + TypeScript pass both `{ jsx: true, typescript: true }`. If you wan to
use Preact + TypeScript, `{ jsx: { pragma: 'h' }, typescript: true }`, if
`options.jsx` is an object, it is directly passed to `preset-react`.

<span id="babelpresetoptimize-signature"></span>

Expand All @@ -138,11 +136,17 @@ function(api, options)
#### Params

- `options` **{object}** - optionally control what can be included
- `options.jsx` **{boolean}** - default `false`, pass `true` if you want `react`; pass an object for more customization (passed to react preset)
- `options.commonjs` **{boolean}** - default `false`, pass non-falsey value to transform ESModules to CommonJS
- `options.typescript` **{boolean}** - default `false`, includes the TypeScript preset
- `options.development` **{boolean}** - default `false`, disables few plugins; when it is `true` and `options.jsx` is enabled (true or object) we add `options.jsx.development: true` too
- `options.minifyBuiltins` **{boolean}** - default `false`, includes [babel-plugin-minify-builtins][]
- `options.jsx` **{boolean}** - default `false`, pass `true` if you want
`react`; pass an object for more customization (passed to react preset)
- `options.commonjs` **{boolean}** - default `false`, pass non-falsey value to
transform ESModules to CommonJS
- `options.typescript` **{boolean}** - default `false`, includes the TypeScript
preset
- `options.development` **{boolean}** - default `false`, disables few plugins;
when it is `true` and `options.jsx` is enabled (true or object) we add
`options.jsx.development: true` too
- `options.minifyBuiltins` **{boolean}** - default `false`, includes
[babel-plugin-minify-builtins][]

<!-- docks-end -->

Expand All @@ -169,7 +173,8 @@ we proceed. In short, we support latest two even-numbered Node.js release lines.
[Become a Partner or Sponsor?][kofi-url] :dollar: Check the **OpenSource**
Commision (tier). :tada: You can get your company logo, link & name on this
file. It's also rendered on package's page in [npmjs.com][npmv-url] and
[yarnpkg.com](https://yarnpkg.com/en/package/babel-preset-optimise) sites too! :rocket:
[yarnpkg.com](https://yarnpkg.com/en/package/babel-preset-optimise) sites too!
:rocket:

Not financial support? Okey!
[Pull requests](https://github.com/tunnckoCoreLabs/contributing#opening-a-pull-request),
Expand Down Expand Up @@ -205,10 +210,9 @@ your [support](#support-the-project) to them:

## License

Copyright (c) 2020-present,
[Charlike Mike Reagent](https://tunnckocore.com) `<opensource@tunnckocore.com>`
& [contributors](#wonderful-contributors).<br> Released under the
[MPL-2.0 License][license-url].
Copyright (c) 2020-present, [Charlike Mike Reagent](https://tunnckocore.com)
`<opensource@tunnckocore.com>` & [contributors](#wonderful-contributors).<br>
Released under the [MPL-2.0 License][license-url].

<!-- badges -->

Expand Down Expand Up @@ -299,4 +303,4 @@ Copyright (c) 2020-present,

<!-- prettier-ignore-end -->

[babel-plugin-minify-builtins]: https://github.com/babel/minify
[babel-plugin-minify-builtins]: https://github.com/babel/minify
27 changes: 15 additions & 12 deletions @packages/babel-preset-optimise/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@


_Generated using [jest-runner-docs](https://ghub.now.sh/jest-runner-docs)._

### [babelPresetOptimize](./src/index.js#L22)

Be aware that when you use `minifyBuiltins: true` you _MAY_ get a bigger output,
but that's not always guaranteed, just try for your case.

If you want to use JSX (React) pass `options.jsx: true`.
If you want to use JSX (React) + TypeScript pass both `{ jsx: true, typescript: true }`.
If you wan to use Preact + TypeScript, `{ jsx: { pragma: 'h' }, typescript: true }`,
if `options.jsx` is an object, it is directly passed to `preset-react`.
If you want to use JSX (React) pass `options.jsx: true`. If you want to use JSX
(React) + TypeScript pass both `{ jsx: true, typescript: true }`. If you wan to
use Preact + TypeScript, `{ jsx: { pragma: 'h' }, typescript: true }`, if
`options.jsx` is an object, it is directly passed to `preset-react`.

<span id="babelpresetoptimize-signature"></span>

Expand All @@ -25,9 +23,14 @@ function(api, options)
#### Params

- `options` **{object}** - optionally control what can be included
- `options.jsx` **{boolean}** - default `false`, pass `true` if you want `react`; pass an object for more customization (passed to react preset)
- `options.commonjs` **{boolean}** - default `false`, pass non-falsey value to transform ESModules to CommonJS
- `options.typescript` **{boolean}** - default `false`, includes the TypeScript preset
- `options.development` **{boolean}** - default `false`, disables few plugins; when it is `true` and `options.jsx` is enabled (true or object) we add `options.jsx.development: true` too
- `options.minifyBuiltins` **{boolean}** - default `false`, includes [babel-plugin-minify-builtins][]

- `options.jsx` **{boolean}** - default `false`, pass `true` if you want
`react`; pass an object for more customization (passed to react preset)
- `options.commonjs` **{boolean}** - default `false`, pass non-falsey value to
transform ESModules to CommonJS
- `options.typescript` **{boolean}** - default `false`, includes the TypeScript
preset
- `options.development` **{boolean}** - default `false`, disables few plugins;
when it is `true` and `options.jsx` is enabled (true or object) we add
`options.jsx.development: true` too
- `options.minifyBuiltins` **{boolean}** - default `false`, includes
[babel-plugin-minify-builtins][]
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"start": "hela",
"test": "CI=1 yarn start test",
"test:legacy": "CI=1 yarn run run:node",
"testy": "hela gen:cov && yarn run docs"
"testy": "hela gen:cov && hela gen:readme && yarn run docs"
},
"dependencies": {
"@babel/cli": "^7.8.4",
Expand Down Expand Up @@ -122,7 +122,7 @@
"color": "green"
},
"@packages/babel-preset-optimise": {
"value": 98.61,
"value": 91.55,
"color": "99CC09"
},
"@packages/gitclone-defaults": {
Expand All @@ -138,7 +138,7 @@
"color": "green"
},
"@packages/jest-runner-docs": {
"value": 5.99,
"value": 5.94,
"color": "red"
},
"@packages/jest-runner-node": {
Expand Down

0 comments on commit eda3da1

Please sign in to comment.