emlint
TypeScript icon, indicating that this package has built-in type declarations

6.0.12 • Public • Published

emlint

Pluggable email template code linter

page on codsen.com page on npm page on github Downloads per month changelog MIT Licence

Install

This package is pure ESM. If you're not ready yet, install an older version of this program, 4.7.0 (npm i emlint@4.7.0).

npm i emlint

Quick Take

import { strict as assert } from "assert";

import { Linter } from "emlint";

const linter = new Linter();

// Correct "not" type Outlook conditional would be:
// <!--[if !mso]><!-->
//   <span class="foo">z</span>
// <!--<![endif]-->

// We have a "not" type opening but "only" type
// closing:
const messages = linter.verify(
  `<!--[if !mso]><!-->
  <span class="foo">z</span>
<![endif]-->`,
  {
    rules: {
      all: 2,
    },
  }
);

assert.deepEqual(messages, [
  {
    line: 3,
    column: 1,
    severity: 2,
    ruleId: "comment-mismatching-pair",
    message: `Add "<!--".`,
    idxFrom: 49,
    idxTo: 61,
    fix: {
      ranges: [[49, 49, "<!--"]],
    },
    keepSeparateWhenFixing: true,
  },
]);

Documentation

Please visit codsen.com for a full description of the API.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub.

Licence

MIT License.

Copyright © 2010-2023 Roy Revelt and other contributors.

ok codsen star

Package Sidebar

Install

npm i emlint

Weekly Downloads

474

Version

6.0.12

License

MIT

Unpacked Size

246 kB

Total Files

9

Last publish

Collaborators

  • royston