Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
remark-lint-table-pipe-alignment
Advanced tools
Readme
remark-lint
rule to warn when GFM table cells are aligned inconsistently.
This package checks table cell dividers are aligned.
Tables are a GFM feature enabled with remark-gfm
.
You can use this package to check that tables are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-table-pipe-alignment
In Deno with esm.sh
:
import remarkLintTablePipeAlignment from 'https://esm.sh/remark-lint-table-pipe-alignment@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintTablePipeAlignment from 'https://esm.sh/remark-lint-table-pipe-alignment@4?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintTablePipeAlignment from 'remark-lint-table-pipe-alignment'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintTablePipeAlignment)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-table-pipe-alignment .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-table-pipe-alignment",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintTablePipeAlignment
.
unified().use(remarkLintTablePipeAlignment)
Warn when GFM table cells are aligned inconsistently.
There are no options.
Transform (Transformer
from unified
).
While aligning table dividers improves their legibility, it is somewhat hard to maintain manually, especially for tables with many rows.
remark-stringify
with
remark-gfm
aligns table cell dividers by default.
Pass tablePipeAlign: false
to use a more compact style.
Aligning perfectly in all cases is not possible because whether characters
look aligned or not depends on where the markup is shown.
Some characters (such as emoji or Chinese characters) show smaller or bigger
in different places.
You can pass a stringLength
function to remark-gfm
,
to align better for your use case,
in which case this rule must be turned off.
ok.md
👉 Note: this example uses GFM (
remark-gfm
).
This rule is only about the alignment of pipes across rows:
| Planet | Mean anomaly (°) |
| ------- | ---------------: |
| Mercury | 174 796 |
|Planet|Mean anomaly (°)|
|------|---------------:|
|Venus | 50 115 |
No messages.
not-ok.md
👉 Note: this example uses GFM (
remark-gfm
).
| Planet | Mean anomaly (°) |
| - | -: |
| Mercury | 174 796 |
1:10: Unexpected unaligned cell, expected aligned pipes, add `1` space
2:5: Unexpected unaligned cell, expected aligned pipes, add `6` spaces (or add `-` to pad alignment row cells)
2:7: Unexpected unaligned cell, expected aligned pipes, add `14` spaces (or add `-` to pad alignment row cells)
3:13: Unexpected unaligned cell, expected aligned pipes, add `9` spaces
empty.md
👉 Note: this example uses GFM (
remark-gfm
).
| | Satellites | |
| ------- | ---------- | --- |
| Mercury | | |
| aaa | bbb | ccc | ddd |
| --- | :-- | :-: | --: |
| | | | |
No messages.
aligned-pipes-but-weird-content.md
👉 Note: this example uses GFM (
remark-gfm
).
| Planet | Moon | Mercury | Venus | Sun | Mars | Jupiter | Saturn |
| ------ | ---- | :------ | :---- | --: | ---: | :-----: | :----: |
| Symbol | ☾ | ☿ | ♀ | ☉ | ♂ | ♃ | ♄ |
No messages.
missing-cells.md
👉 Note: this example uses GFM (
remark-gfm
).
| Planet | Symbol | Satellites |
| ------- | ------ | ---------- |
| Mercury |
| Venus | ♀ |
| Earth | ♁ | 1 |
| Mars | ♂ | 2 | 19 412 |
No messages.
alignment.md
👉 Note: this example uses GFM (
remark-gfm
).
| Planet | Symbol | Satellites | Mean anomaly (°) |
| - | :- | :-: | -: |
| Mercury | ☿ | None | 174 796 |
1:10: Unexpected unaligned cell, expected aligned pipes, add `1` space
2:5: Unexpected unaligned cell, expected aligned pipes, add `6` spaces (or add `-` to pad alignment row cells)
2:10: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)
2:12: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)
2:16: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)
2:18: Unexpected unaligned cell, expected aligned pipes, add `14` spaces (or add `-` to pad alignment row cells)
3:15: Unexpected unaligned cell, expected aligned pipes, add `5` spaces
3:17: Unexpected unaligned cell, expected aligned pipes, add `3` spaces
3:22: Unexpected unaligned cell, expected aligned pipes, add `3` spaces
3:24: Unexpected unaligned cell, expected aligned pipes, add `9` spaces
missing-fences.md
👉 Note: this example uses GFM (
remark-gfm
).
Planet | Satellites
-: | -
Mercury | ☿
1:1: Unexpected unaligned cell, expected aligned pipes, add `1` space
2:1: Unexpected unaligned cell, expected aligned pipes, add `5` spaces (or add `-` to pad alignment row cells)
trailing-spaces.md
👉 Note: this example uses GFM (
remark-gfm
).
| Planet |␠␠
| -: |␠
2:3: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)
nothing.md
👉 Note: this example uses GFM (
remark-gfm
).
||||
|-|-|-|
1:2: Unexpected unaligned cell, expected aligned pipes, add `1` space
1:3: Unexpected unaligned cell, expected aligned pipes, add `1` space
1:4: Unexpected unaligned cell, expected aligned pipes, add `1` space
more-weirdness.md
👉 Note: this example uses GFM (
remark-gfm
).
Mercury
|-
Venus
-|
5:2: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)
containers.md
👉 Note: this example uses GFM (
remark-gfm
).
> | Mercury|
> | - |
* | Venus|
| - |
> * > | Earth|
> > | - |
2:5: Unexpected unaligned cell, expected aligned pipes, add `5` spaces (or add `-` to pad alignment row cells)
5:5: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)
8:5: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)
windows.md
👉 Note: this example uses GFM (
remark-gfm
).
| Mercury|␍␊| --- |␍␊| None |
2:7: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)
3:8: Unexpected unaligned cell, expected aligned pipes, add `2` spaces
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-table-pipe-alignment@4
,
compatible with Node.js 16.
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
remark-lint rule to warn when table pipes are not aligned
The npm package remark-lint-table-pipe-alignment receives a total of 55,127 weekly downloads. As such, remark-lint-table-pipe-alignment popularity was classified as popular.
We found that remark-lint-table-pipe-alignment demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.