remark-tight-comments
v3.0.0
remark plugin to selectively remove newlines around comments
20/weekUpdated 5 months agoMITUnpacked: 15.9 KB
Published by Xunnamius
npm install remark-tight-comments
remark plugin to selectively remove newlines around comments
[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link]
[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link]
[![Codecov][x-badge-codecov-image]][x-badge-codecov-link]
[![Source license][x-badge-license-image]][x-badge-license-link]
[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link]
[![NPM version][x-badge-npm-image]][x-badge-npm-link]
[![Monthly Downloads][x-badge-downloads-image]][x-badge-downloads-link]
remark-tight-comments
This is a [unified][1] ([remark][2]) plugin that allows you to selectively
remove unnecessary newlines around Markdown comments.
This plugin is useful for preserving the structure of auto-generated content,
e.g. [all-contributors][3], [doctoc][4], etc. You might also be interested in
[remark-ignore][5], which lets you instruct remark not to transform parts of
your Markdown documents. For a live example of these two plugins in action,
check the source of [this very README.md file][6]. ✨
---
- Install
- Usage
- Via API
- Via remark-cli
- Via unified configuration
- API
- Examples
- Related
- Appendix
- Published Package Details
- License
- Contributing and Support
- Contributors
Install
> Due to the nature of the unified ecosystem, this package is ESM only and
> cannot be require'd.
To install:
``shell`
npm install --save-dev remark-tight-comments
Usage
For maximum flexibility, there are several ways this plugin can be invoked.
$3
`typescript
import { read } from 'to-vfile';
import { remark } from 'remark';
import remarkTightComments from 'remark-tight-comments';
const file = await remark()
.use(remarkTightComments)
.process(await read('example.md'));
console.log(String(file));
`
$3
`shell`
remark -o --use tight-comments README.md
$3
In package.json:
`javascript`
/ … /
"remarkConfig": {
"plugins": [
"remark-tight-comments"
/ … /
]
},
/ … /
In .remarkrc.js:
`javascript`
module.exports = {
plugins: [
// …
'tight-comments'
]
};
In .remarkrc.mjs:
`javascript
import remarkTightComments from 'remark-tight-comments';
export default {
plugins: [
// …
remarkTightComments
]
};
`
API
Detailed interface information can be found under [docs/][x-repo-docs].
Examples
See [mdast-util-tight-comments][7] for example outputs.
Related
- [remark-ignore][5] — use comments to exclude one or more nodes from
[transformation][8].
- [mdast-util-tight-comments][9] — selectively remove newlines around comment
nodes during serialization.
Appendix
Further documentation can be found under [docs/][x-repo-docs].
$3
This is an [ESM-only package][x-pkg-esm-wine] built by Babel for use in Node.js
versions that are not end-of-life. For TypeScript users, this package supports
both "Node10" and "Node16" module resolution strategies.
Expand details
That means ESM source will load this package via import { ... } from ... orawait import(...) and CJS source will load this package via dynamicimport(). This has several benefits, the foremost being: less code
shipped/smaller package size, avoiding [dual package
hazard][x-pkg-dual-package-hazard] entirely, distributables are not
packed/bundled/uglified, and a drastically less complex build process.
The glaring downside, which may or may not be relevant, is that CJS consumers
cannot require() this package and can only use import() in an asynchronous
context. This means, in effect, CJS consumers may not be able to use this
package at all.
Each entry point (i.e. ENTRY) in [package.json'sexports[ENTRY]][x-repo-package-json] object includes one or more [exportexports[ENTRY].types
conditions][x-pkg-exports-conditions]. These entries may or may not include: an
[][x-pkg-exports-types-key] condition pointing to a typeexports[ENTRY].module
declaration file for TypeScript and IDEs, a
[][x-pkg-exports-module-key] condition pointing toexports[ENTRY].node
(usually ESM) source for Webpack/Rollup, a and/orexports[ENTRY].default condition pointing to (usually CJS2) source for Node.jsrequire/import and for browsers and other environments, and [other
conditions][x-pkg-exports-conditions] not enumerated here. Check the
[package.json][x-repo-package-json] file to see which export conditions are
supported.
Note that, regardless of the [{ "type": "..." }][x-pkg-type] specified inpackage.json
[][x-repo-package-json], any JavaScript files written in ESM.mjs
syntax (including distributables) will always have the extension. Notepackage.json
also that [][x-repo-package-json] may include thesideEffects
[][x-pkg-side-effects-key] key, which is almost always false` for
optimal [tree shaking][x-pkg-tree-shaking] where appropriate.
$3
See [LICENSE][x-repo-license].
Contributing and Support
**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]
are always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟
this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy
me a beer][x-repo-sponsor], I'd appreciate it. Thank you!
See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for
more information.
$3
See the [table of contributors][x-repo-contributors].
[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!'
[x-badge-blm-link]: https://xunn.at/donate-blm
[x-badge-codecov-image]:
https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW&flag=package.main_remark-tight-comments
'Is this package well-tested?'
[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils
[x-badge-downloads-image]:
https://img.shields.io/npm/dm/remark-tight-comments?style=flat-square
'Number of times this package has been downloaded per month'
[x-badge-downloads-link]: https://npmtrends.com/remark-tight-comments
[x-badge-lastcommit-image]:
https://img.shields.io/github/last-commit/Xunnamius/unified-utils?style=flat-square
'Latest commit timestamp'
[x-badge-license-image]:
https://img.shields.io/npm/l/remark-tight-comments?style=flat-square
"This package's source license"
[x-badge-license-link]:
https://github.com/Xunnamius/unified-utils/blob/main/LICENSE
[x-badge-npm-image]:
https://xunn.at/npm-pkg-version/remark-tight-comments
'Install this package using npm or yarn!'
[x-badge-npm-link]: https://npm.im/remark-tight-comments
[x-badge-repo-link]: https://github.com/Xunnamius/unified-utils
[x-badge-semanticrelease-image]:
https://xunn.at/badge-semantic-release
'This repo practices continuous integration and deployment!'
[x-badge-semanticrelease-link]:
https://github.com/semantic-release/semantic-release
[x-pkg-dual-package-hazard]:
https://nodejs.org/api/packages.html#dual-package-hazard
[x-pkg-esm-wine]:
https://dev.to/jakobjingleheimer/configuring-commonjs-es-modules-for-nodejs-12ed#esm-source-and-distribution
[x-pkg-exports-conditions]:
https://webpack.js.org/guides/package-exports#reference-syntax
[x-pkg-exports-module-key]:
https://webpack.js.org/guides/package-exports#providing-commonjs-and-esm-version-stateless
[x-pkg-exports-types-key]:
https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta#packagejson-exports-imports-and-self-referencing
[x-pkg-side-effects-key]:
https://webpack.js.org/guides/tree-shaking#mark-the-file-as-side-effect-free
[x-pkg-tree-shaking]: https://webpack.js.org/guides/tree-shaking
[x-pkg-type]:
https://github.com/nodejs/node/blob/8d8e06a345043bec787e904edc9a2f5c5e9c275f/doc/api/packages.md#type
[x-repo-choose-new-issue]:
https://github.com/Xunnamius/unified-utils/issues/new/choose
[x-repo-contributing]: /CONTRIBUTING.md
[x-repo-contributors]: /README.md#contributors
[x-repo-docs]: docs
[x-repo-license]: ./LICENSE
[x-repo-package-json]: package.json
[x-repo-pr-compare]: https://github.com/Xunnamius/unified-utils/compare
[x-repo-sponsor]: https://github.com/sponsors/Xunnamius
[x-repo-support]: /.github/SUPPORT.md
[1]: https://github.com/unifiedjs/unified
[2]: https://github.com/remarkjs/remark
[3]: https://github.com/all-contributors/all-contributors
[4]: https://github.com/thlorenz/doctoc
[5]: /packages/remark-ignore
[6]:
https://raw.githubusercontent.com/Xunnamius/unified-utils/main/packages/remark-tight-comments/README.md
[7]: /packages/mdast-util-tight-comments/README.md#usage
[8]: https://github.com/unifiedjs/unified#overview
[9]: /packages/mdast-util-tight-comments