.eslintignore

@@ -1 +1,2 @@
+lib
 *.min.js

.eslintrc.json

@@ -3,10 +3,6 @@
   "plugins": [
     "standard"
   ],
-  "parserOptions": {
-    "ecmaVersion": 5,
-    "sourceType": "script"
-  },
   "rules": {
     "semi": ["error", "always"],
     "indent": ["error", 2, {
@@ -19,11 +15,14 @@
     "no-cond-assign": "off",
     "no-useless-escape": "off",
     "one-var": "off",
-    "no-control-regex": "off"
+    "no-control-regex": "off",
+    "no-prototype-builtins": "off",
+    "no-extra-semi": "error",
+
+    "prefer-const": "error",
+    "no-var": "error"
   },
   "env": {
-    "node": true,
-    "browser": true,
-    "amd": true
+    "node": true
   }
 }

.github/workflows/tests.yml

@@ -0,0 +1,66 @@
+name: "Tests"
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  Test:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    strategy:
+      matrix:
+        node_version: ['lts/*', 'node']
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Install Node
+        uses: dcodeIO/setup-node-nvm@master
+        with:
+          node-version: ${{ matrix.node_version }}
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Unit Tests 👩🏽‍💻
+        run: npm run test:unit
+      - name: Run Spec Tests 👩🏽‍💻
+        run: npm run test:specs
+
+  Lint:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: npm ci
+      - name: Lint ✨
+        run: npm run test:lint
+
+  Build:
+    needs: [Test, Lint]
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: npm ci
+      - name: Build 🗜️
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          npm run build
+          if ! git diff --quiet; then
+            git config --global user.email "<>"
+            git config --global user.name "MarkedJS bot"
+            git commit -am "🗜️ build [skip ci]"
+            git push "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/markedjs/marked.git" HEAD:master
+          fi
+
+  Skip:
+    if: contains(github.event.head_commit.message, '[skip ci]')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Skip CI 🚫
+        run: echo skip ci

.nowignore

@@ -0,0 +1,3 @@
+*
+!docs
+!docs/**

README.md

@@ -10,7 +10,7 @@
 [![downloads](https://badgen.net/npm/dt/marked)](https://www.npmjs.com/package/marked)
 [![dep](https://badgen.net/david/dep/markedjs/marked?label=deps)](https://david-dm.org/markedjs/marked)
 [![dev dep](https://badgen.net/david/dev/markedjs/marked?label=devDeps)](https://david-dm.org/markedjs/marked?type=dev)
-[![travis](https://badgen.net/travis/markedjs/marked)](https://travis-ci.org/markedjs/marked)
+[![github actions](https://github.com/markedjs/marked/workflows/Tests/badge.svg)](https://github.com/markedjs/marked/actions)
 [![snyk](https://snyk.io/test/npm/marked/badge.svg)](https://snyk.io/test/npm/marked)
 
 - ⚡ built for speed
@@ -39,7 +39,7 @@ Also read about:
 
 ## Usage
 
-### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#options) the output HTML by default 🚨
+### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#options) the output HTML. Please use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the output HTML! 🚨
 
 **CLI**
 

bin/marked

@@ -5,35 +5,35 @@
  * Copyright (c) 2011-2013, Christopher Jeffrey (MIT License)
  */
 
-var fs = require('fs'),
-    path = require('path'),
-    marked = require('../');
+const fs = require('fs'),
+  path = require('path'),
+  marked = require('../');
 
 /**
  * Man Page
  */
 
 function help() {
-  var spawn = require('child_process').spawn;
+  const spawn = require('child_process').spawn;
 
-  var options = {
+  const options = {
     cwd: process.cwd(),
     env: process.env,
     setsid: false,
     stdio: 'inherit'
   };
 
-  spawn('man', [path.resolve(__dirname, '/../man/marked.1')], options)
+  spawn('man', [path.resolve(__dirname, '../man/marked.1')], options)
     .on('error', function() {
-      fs.readFile(path.resolve(__dirname, '/../man/marked.1.txt'), 'utf8', function(err, data) {
+      fs.readFile(path.resolve(__dirname, '../man/marked.1.txt'), 'utf8', function(err, data) {
         if (err) throw err;
         console.log(data);
       });
     });
 }
 
 function version() {
-  var pkg = require('../package.json');
+  const pkg = require('../package.json');
   console.log(pkg.version);
 }
 
@@ -42,17 +42,17 @@ function version() {
  */
 
 function main(argv, callback) {
-  var files = [],
-      options = {},
-      input,
-      output,
-      string,
-      arg,
-      tokens,
-      opt;
+  const files = [],
+    options = {};
+  let input,
+    output,
+    string,
+    arg,
+    tokens,
+    opt;
 
   function getarg() {
-    var arg = argv.shift();
+    let arg = argv.shift();
 
     if (arg.indexOf('--') === 0) {
       // e.g. --opt
@@ -162,8 +162,8 @@ function main(argv, callback) {
  */
 
 function getStdin(callback) {
-  var stdin = process.stdin,
-      buff = '';
+  const stdin = process.stdin;
+  let buff = '';
 
   stdin.setEncoding('utf8');
 

docs/.eslintrc.json

@@ -0,0 +1,33 @@
+{
+  "extends": "standard",
+  "plugins": [
+    "standard"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 5,
+    "sourceType": "script"
+  },
+  "rules": {
+    "semi": ["error", "always"],
+    "indent": ["error", 2, {
+      "SwitchCase": 1,
+      "VariableDeclarator": { "var": 2 },
+      "outerIIFEBody": 0
+    }],
+    "operator-linebreak": ["error", "before", { "overrides": { "=": "after" } }],
+    "space-before-function-paren": ["error", "never"],
+    "no-cond-assign": "off",
+    "no-useless-escape": "off",
+    "one-var": "off",
+    "no-control-regex": "off",
+    "no-prototype-builtins": "off",
+
+    "prefer-const": "off",
+    "no-var": "off"
+  },
+  "env": {
+    "node": true,
+    "browser": true,
+    "amd": true
+  }
+}

docs/AUTHORS.md

@@ -1,6 +1,6 @@
 # Authors
 
-Marked takes an encompassing approach to its community. As such, you can think of these as [concentric circles](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951), where each group encompases the following groups.
+Marked takes an encompassing approach to its community. As such, you can think of these as [concentric circles](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951), where each group encompasses the following groups.
 
 <table>
   <tbody>
@@ -170,7 +170,7 @@ To be removed: You can remove yourself through the [GitHub UI](https://help.gith
 A note on volunteering:
 
 1. Please do not volunteer unless you believe you can demonstrate to your peers you can do the work required.
-2. Please do not overcommit yourself; we count on those committed to the project to be responsive. Really consider, with all you have going on, wehther you able to really commit to it.
+2. Please do not overcommit yourself; we count on those committed to the project to be responsive. Really consider, with all you have going on, whether you able to really commit to it.
 3. Don't let the previous frighten you away, it can always be changed later by you or your peers.
 
 [Details on badges](#badges)
@@ -227,7 +227,7 @@ Badges? If you *want* 'em, we got 'em, and here's how you get 'em (and&hellip;dr
 		</blockquote>
 	</dd>
   <dt>Dr. Docs</dt>
-  <dd>Someone who has contributed a great deal to the creation and maintainance of the non-code areas of marked.</dd>
+  <dd>Someone who has contributed a great deal to the creation and maintenance of the non-code areas of marked.</dd>
 	<dt>Eye for the CLI</dt>
 	<dd>At this point? Pretty much anyone who can update that `man` file to the current Marked version without regression in the CLI tool itself.</dd>
 	<dt>GitHub Guru</dt>
@@ -259,9 +259,9 @@ Badges? If you *want* 'em, we got 'em, and here's how you get 'em (and&hellip;dr
 
 <dl>
 	<dt>Defibrillator</dt>
-	<dd>A contributor who stepped up to help bring Marked back to life by contriuting solutions to help Marked pass when compared against the CommonMark and GitHub Flavored Markdown specifications.</dd>
+	<dd>A contributor who stepped up to help bring Marked back to life by contributing solutions to help Marked pass when compared against the CommonMark and GitHub Flavored Markdown specifications.</dd>
 	<dt>Maker of the Marked mark</dt>
-	<dd>This badge is given to the person or oganization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Maker of the Marked mark from 2017 to present**, for example.</dd>
+	<dd>This badge is given to the person or organization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Maker of the Marked mark from 2017 to present**, for example.</dd>
 	<dt>Release Wrangler</dt>
 	<dd>This is a badge given to all Publishers.</dd>
 	<dt>Snyk's Security Saint</dt>

docs/CONTRIBUTING.md

@@ -5,9 +5,10 @@
 - [ ] Make sure you are on the `master` branch.
 - [ ] Be sure to run `npm install` or `npm update`.
 - [ ] Create a branch.
-- [ ] Make as small a change as possible.
-- [ ] Run `npm test`, fix any broken things (for linting, you can run `npm run lint` to have the linter fix them for you).
-- [ ] Submit a PR.
+- [ ] Update code in `src` folder. (`lib` folder is for auto compiled code)
+- [ ] Run `npm run test:all`, fix any broken things (for linting, you can run `npm run lint` to have the linter fix them for you).
+- [ ] Run `npm run build:reset` to remove changes to compiled files.
+- [ ] Submit a Pull Request.
 
 ## Design principles
 
@@ -30,6 +31,7 @@ The following table lists the ticket type labels we use when there is work to be
 |RR - refactor and re-engineer      |Results in an improvement to developers using Marked (improved readability) or end-users (faster performance) or both.                                                              |
 |NFS - new feature (spec related)   |A capability Marked does not currently provide but is in one of the [supported specifications](#/README.md#specifications)                                                           |
 |NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked.                                                                                           |
+|NFE - new feature (should be an extension) |A capability Marked does not currently provide and is not part of a spec.                                                                                           |
 
 ## Test early, often, and everything
 
@@ -80,15 +82,39 @@ To see time comparisons between Marked and other popular Markdown libraries:
 npm run bench
 ```
 
+To see the compiled rules from `src/rules.js`:
+
+```bash
+npm run rules
+```
+
+You can specify one or more `rule path`s to only show certain rules:
+
+```bash
+npm run rules -- block.gfm.item inline.pedantic.br
+
+{
+  block: {
+    gfm: {
+      item: /^( *)((?:[*+-]|\\d{1,9}\\.)) ?[^\\n]*(?:\\n(?!\\1(?:[*+-]|\\d{1,9}\\.) ?)[^\\n]*)*/gm
+    }
+  },
+  inline: {
+    pedantic: {
+      br: /^( {2,}|\\\\)\\n(?!\\s*$)/
+    }
+  }
+}
+```
+
 To check for (and fix) standardized syntax (lint):
 
 ```bash
 npm run lint
 ```
 
-To build your own minified version of Marked:
+To build your own es5, esm, and minified versions of Marked:
 
 ```bash
 npm run build
 ```
-