Skip to content

Commit b354a5b

Browse files
committed
docs(readme): put sections in their proper place
1 parent c5e0fd3 commit b354a5b

File tree

1 file changed

+84
-115
lines changed

1 file changed

+84
-115
lines changed

README.md

Lines changed: 84 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,6 @@ This package is tested on both Windows and nix (Ubuntu) environments.
6161
- [Full Example](#full-example)
6262
- [Fixtures Examples](#fixtures-examples)
6363
- [Appendix](#appendix)
64-
- [Published Package Details](#published-package-details)
65-
- [License](#license)
66-
- [Contributing and Support](#contributing-and-support)
67-
- [Contributors](#contributors)
6864
- [Testing Framework Compatibility](#testing-framework-compatibility)
6965
- [Using Babel for Configuration Loading](#using-babel-for-configuration-loading)
7066
- [`pluginName` Inference Caveat](#pluginname-inference-caveat)
@@ -73,11 +69,11 @@ This package is tested on both Windows and nix (Ubuntu) environments.
7369
- [Built-In Debugging Support](#built-in-debugging-support)
7470
- [`TEST_ONLY`/`TEST_NUM_ONLY` and `TEST_SKIP`/`TEST_NUM_SKIP` Environment Variables](#test_onlytest_num_only-and-test_skiptest_num_skip-environment-variables)
7571
- [`setup` and `teardown` Run Order](#setup-and-teardown-run-order)
76-
- [Inspiration](#inspiration)
77-
- [Issues](#issues)
78-
- [🐛 Bugs](#-bugs)
79-
- [💡 Feature Requests](#-feature-requests)
80-
- [Contributors](#contributors-)
72+
- [Published Package Details](#published-package-details)
73+
- [License](#license)
74+
- [Contributing and Support](#contributing-and-support)
75+
- [Inspiration](#inspiration)
76+
- [Contributors](#contributors)
8177

8278
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
8379
<!-- symbiote-template-region-start 4 -->
@@ -1615,90 +1611,6 @@ babel-plugin-tester fixtures in some of these other projects:
16151611

16161612
Further documentation can be found under [`docs/`][x-repo-docs].
16171613

1618-
<!-- symbiote-template-region-start 6 -->
1619-
1620-
### Published Package Details
1621-
1622-
This is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports
1623-
built by Babel for use in Node.js versions that are not end-of-life. For
1624-
TypeScript users, this package supports both `"Node10"` and `"Node16"` module
1625-
resolution strategies.
1626-
1627-
<!-- symbiote-template-region-end -->
1628-
<!-- TODO: optional additional details here -->
1629-
<!-- symbiote-template-region-start 7 -->
1630-
1631-
<details><summary>Expand details</summary>
1632-
1633-
That means both CJS2 (via `require(...)`) and ESM (via `import { ... } from ...`
1634-
or `await import(...)`) source will load this package from the same entry points
1635-
when using Node. This has several benefits, the foremost being: less code
1636-
shipped/smaller package size, avoiding [dual package
1637-
hazard][x-pkg-dual-package-hazard] entirely, distributables are not
1638-
packed/bundled/uglified, a drastically less complex build process, and CJS
1639-
consumers aren't shafted.
1640-
1641-
Each entry point (i.e. `ENTRY`) in [`package.json`'s
1642-
`exports[ENTRY]`][x-repo-package-json] object includes one or more [export
1643-
conditions][x-pkg-exports-conditions]. These entries may or may not include: an
1644-
[`exports[ENTRY].types`][x-pkg-exports-types-key] condition pointing to a type
1645-
declaration file for TypeScript and IDEs, a
1646-
[`exports[ENTRY].module`][x-pkg-exports-module-key] condition pointing to
1647-
(usually ESM) source for Webpack/Rollup, a `exports[ENTRY].node` and/or
1648-
`exports[ENTRY].default` condition pointing to (usually CJS2) source for Node.js
1649-
`require`/`import` and for browsers and other environments, and [other
1650-
conditions][x-pkg-exports-conditions] not enumerated here. Check the
1651-
[package.json][x-repo-package-json] file to see which export conditions are
1652-
supported.
1653-
1654-
Note that, regardless of the [`{ "type": "..." }`][x-pkg-type] specified in
1655-
[`package.json`][x-repo-package-json], any JavaScript files written in ESM
1656-
syntax (including distributables) will always have the `.mjs` extension. Note
1657-
also that [`package.json`][x-repo-package-json] may include the
1658-
[`sideEffects`][x-pkg-side-effects-key] key, which is almost always `false` for
1659-
optimal [tree shaking][x-pkg-tree-shaking] where appropriate.
1660-
1661-
<!-- symbiote-template-region-end -->
1662-
<!-- TODO: optional additional details here -->
1663-
<!-- symbiote-template-region-start 8 -->
1664-
1665-
</details>
1666-
1667-
### License
1668-
1669-
<!-- symbiote-template-region-end -->
1670-
1671-
See [LICENSE][x-repo-license].
1672-
1673-
<!-- TODO: optional additional details here -->
1674-
<!-- symbiote-template-region-start 9 -->
1675-
1676-
## Contributing and Support
1677-
1678-
**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]
1679-
are always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟
1680-
this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy
1681-
me a beer][x-repo-sponsor], I'd appreciate it. Thank you!
1682-
1683-
See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for
1684-
more information.
1685-
1686-
<!-- symbiote-template-region-end -->
1687-
<!-- TODO: optional additional sections here -->
1688-
<!-- symbiote-template-region-start 10 -->
1689-
1690-
### Contributors
1691-
1692-
<!-- symbiote-template-region-end -->
1693-
<!-- symbiote-template-region-start root-package-only -->
1694-
<!-- remark-ignore-start -->
1695-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
1696-
1697-
[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors-)
1698-
1699-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1700-
<!-- remark-ignore-end -->
1701-
17021614
### Testing Framework Compatibility
17031615

17041616
This package was originally tested on and built to work with [Jest][4], but it
@@ -2126,7 +2038,76 @@ the following order:
21262038
6. Any function returned by base `setup`.
21272039
7. [Base `teardown`][45].
21282040

2129-
## Inspiration
2041+
<!-- symbiote-template-region-start 6 -->
2042+
2043+
### Published Package Details
2044+
2045+
This is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports
2046+
built by Babel for use in Node.js versions that are not end-of-life. For
2047+
TypeScript users, this package supports both `"Node10"` and `"Node16"` module
2048+
resolution strategies.
2049+
2050+
<!-- symbiote-template-region-end -->
2051+
<!-- TODO: optional additional details here -->
2052+
<!-- symbiote-template-region-start 7 -->
2053+
2054+
<details><summary>Expand details</summary>
2055+
2056+
That means both CJS2 (via `require(...)`) and ESM (via `import { ... } from ...`
2057+
or `await import(...)`) source will load this package from the same entry points
2058+
when using Node. This has several benefits, the foremost being: less code
2059+
shipped/smaller package size, avoiding [dual package
2060+
hazard][x-pkg-dual-package-hazard] entirely, distributables are not
2061+
packed/bundled/uglified, a drastically less complex build process, and CJS
2062+
consumers aren't shafted.
2063+
2064+
Each entry point (i.e. `ENTRY`) in [`package.json`'s
2065+
`exports[ENTRY]`][x-repo-package-json] object includes one or more [export
2066+
conditions][x-pkg-exports-conditions]. These entries may or may not include: an
2067+
[`exports[ENTRY].types`][x-pkg-exports-types-key] condition pointing to a type
2068+
declaration file for TypeScript and IDEs, a
2069+
[`exports[ENTRY].module`][x-pkg-exports-module-key] condition pointing to
2070+
(usually ESM) source for Webpack/Rollup, a `exports[ENTRY].node` and/or
2071+
`exports[ENTRY].default` condition pointing to (usually CJS2) source for Node.js
2072+
`require`/`import` and for browsers and other environments, and [other
2073+
conditions][x-pkg-exports-conditions] not enumerated here. Check the
2074+
[package.json][x-repo-package-json] file to see which export conditions are
2075+
supported.
2076+
2077+
Note that, regardless of the [`{ "type": "..." }`][x-pkg-type] specified in
2078+
[`package.json`][x-repo-package-json], any JavaScript files written in ESM
2079+
syntax (including distributables) will always have the `.mjs` extension. Note
2080+
also that [`package.json`][x-repo-package-json] may include the
2081+
[`sideEffects`][x-pkg-side-effects-key] key, which is almost always `false` for
2082+
optimal [tree shaking][x-pkg-tree-shaking] where appropriate.
2083+
2084+
<!-- symbiote-template-region-end -->
2085+
<!-- TODO: optional additional details here -->
2086+
<!-- symbiote-template-region-start 8 -->
2087+
2088+
</details>
2089+
2090+
### License
2091+
2092+
<!-- symbiote-template-region-end -->
2093+
2094+
See [LICENSE][x-repo-license].
2095+
2096+
<!-- symbiote-template-region-start 9 -->
2097+
2098+
## Contributing and Support
2099+
2100+
**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]
2101+
are always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟
2102+
this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy
2103+
me a beer][x-repo-sponsor], I'd appreciate it. Thank you!
2104+
2105+
See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for
2106+
more information.
2107+
2108+
<!-- symbiote-template-region-end -->
2109+
2110+
### Inspiration
21302111

21312112
The API was inspired by:
21322113

@@ -2135,25 +2116,19 @@ The API was inspired by:
21352116
- Babel's own
21362117
[`@babel/helper-plugin-test-runner`][@babel/helper-plugin-test-runner].
21372118

2138-
## Issues
2139-
2140-
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
2141-
label._
2142-
2143-
### 🐛 Bugs
2144-
2145-
Please file an issue for bugs, missing documentation, or unexpected behavior.
2146-
2147-
[**See Bugs**][bugs]
2119+
<!-- symbiote-template-region-start 10 -->
21482120

2149-
### 💡 Feature Requests
2121+
### Contributors
21502122

2151-
Please file an issue to suggest new features. Vote on feature requests by adding
2152-
a 👍. This helps maintainers prioritize what to work on.
2123+
<!-- symbiote-template-region-end -->
2124+
<!-- symbiote-template-region-start root-package-only -->
2125+
<!-- remark-ignore-start -->
2126+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
21532127

2154-
[**See Feature Requests**][requests]
2128+
[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors-)
21552129

2156-
## Contributors ✨
2130+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2131+
<!-- remark-ignore-end -->
21572132

21582133
Thanks goes to these wonderful people ([emoji
21592134
key][x-repo-all-contributors-emojis]):
@@ -2224,14 +2199,8 @@ specification. Contributions of any kind welcome!
22242199

22252200
[@babel/helper-plugin-test-runner]:
22262201
https://github.com/babel/babel/tree/master/packages/babel-helper-plugin-test-runner
2227-
[bugs]:
2228-
https://github.com/babel-utils/babel-plugin-tester/issues?q=is%3Aissue+is%3Aopen+label%3A%22bug%22
2229-
[good-first-issue]:
2230-
https://github.com/babel-utils/babel-plugin-tester/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
22312202
[jamestweet]: https://twitter.com/thejameskyle/status/864359438819262465
22322203
[lodash.mergewith]: https://lodash.com/docs/4.17.4#mergeWith
2233-
[requests]:
2234-
https://github.com/babel-utils/babel-plugin-tester/issues?q=is%3Aissue+is%3Aopen+label%3A%22enhancement%22
22352204
[ruletester]:
22362205
http://eslint.org/docs/developer-guide/working-with-rules#rule-unit-tests
22372206
[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!'

0 commit comments

Comments
 (0)