Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

remark-lint-table-pipe-alignment

Package Overview
Dependencies
Maintainers
2
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark-lint-table-pipe-alignment

remark-lint rule to warn when table pipes are not aligned

  • 1.0.4
  • Source
  • npm
  • Socket score

Version published
Maintainers
2
Created
Source

remark-lint-table-pipe-alignment

Build Coverage Downloads Size Sponsors Backers Chat

Warn when table pipes are not aligned.

Fix

remark-stringify tries to align tables by default. Pass paddedTable: false to not align cells.

Aligning cells perfectly is impossible as some characters (such as emoji or Chinese characters) are rendered differently in different browsers, terminals, and editors. You can pass your own stringLength function to customize how cells are aligned. In that case, this rule must be turned off.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-markdown-style-guide

Example

ok.md
In
| A     | B     |
| ----- | ----- |
| Alpha | Bravo |
Out

No messages.

not-ok.md
In
| A | B |
| -- | -- |
| Alpha | Bravo |
Out
3:9-3:10: Misaligned table fence
3:17-3:18: Misaligned table fence

Install

npm:

npm install remark-lint-table-pipe-alignment

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-table-pipe-alignment",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-table-pipe-alignment readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-table-pipe-alignment'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file))
   })

Contribute

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.

License

MIT © Titus Wormer

Keywords

FAQs

Package last updated on 24 Mar 2020

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc